diff --git a/config.js b/config.js
index 0365c41..2ea077b 100644
--- a/config.js
+++ b/config.js
@@ -438,10 +438,28 @@
},
/**
- * Enable global filters for ALL telemetry requests that support the filter
+ * Enable global filters for ALL telemetry requests that support the filter.
+ * Telemetry filters modify the 'filter' field in queries to MCWS.
*
+ * key property is required and other options are optional
+ * globalFilters: array, optional - list of global filters to configure.
+ * * key: string, required. Filter column, e.g. vcid
+ * * name: string, required. Identifier of the filter in the selection window.
+ * * icon: 'icon-flag', string, icon. Not implemented - potentially icon for minimized filter list.
+ * * filter: object, required. Filter object to implement
+ * * * comparator: string, required. currently supports 'equals'
+ * * * singleSelectionThreshold: boolean, required. currently supports true only.
+ * * * defaultLabel: string, optional. Defaults to 'None'. Label to show if filter inactive.
+ * * * possibleValues: array, required. List of values and labels for filter.
+ * * * * label: string, required. Label to show in filter selection dropdown.
+ * * * * value: string, required. value to set parameter to in filtered query.
* How to use:
- * The global filters will be available from the Global Filters indicator
+ * The global filters will be available from the Global Filters indicator.
+ * Enable a filter by selecting the desired filter from the dropdown and hitting update.
+ * Outgoing requests that use the 'filter' parameter to MCWS will be modified with your filter.
+ * example below, selecting 'A side' will ensure that the filter parameter in mcws includes:
+ * vcid='1,2,3'. Note that poorly formatted filters may not pass MCWS API validation.
+ *
*/
/*
globalFilters: [
@@ -452,6 +470,7 @@
filter: {
comparator: 'equals',
singleSelectionThreshold: true,
+ defaultLabel: "A & B",
possibleValues: [
{
label: 'A Side',
@@ -470,6 +489,7 @@
filter: {
comparator: 'equals',
singleSelectionThreshold: true,
+ defaultLabel: "REC & RLT",
possibleValues: [
{
label: 'Realtime',
diff --git a/src/globalFilters/FilterField.vue b/src/globalFilters/FilterField.vue
index 5fdda89..9565996 100644
--- a/src/globalFilters/FilterField.vue
+++ b/src/globalFilters/FilterField.vue
@@ -10,8 +10,8 @@
name="setSelectionThreshold"
@change="updateFilterValueFromDropdown($event, filter.comparator, $event.target.value)"
>
-