[Vega] Add Filter custom label for kibanaAddFilter (elastic#124498)

* [Vega] Add Filter custom label for kibanaAddFilter * extend documentation Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Joe Reuter <[email protected]>
kibanamachine · Feb 7, 2022 · 164eaf2 · 164eaf2
1 parent 51856f9
commit 164eaf2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/user/dashboard/vega-reference.asciidoc b/docs/user/dashboard/vega-reference.asciidoc
@@ -429,8 +429,9 @@ To keep signal values set `restoreSignalValuesOnRefresh: true` in the Vega confi
 /**
   * @param {object} query Elastic Query DSL snippet, as used in the query DSL editor
   * @param {string} [index] as defined in Kibana, or default if missing
+  * @param {string} Custom label of the filter shown in the filter bar
   */
-kibanaAddFilter(query, index)
+kibanaAddFilter(query, index, alias)
 
 /**
   * @param {object} query Elastic Query DSL snippet, as used in the query DSL editor

diff --git a/src/plugins/vis_types/vega/public/vega_view/vega_base_view.js b/src/plugins/vis_types/vega/public/vega_view/vega_base_view.js
@@ -340,10 +340,11 @@ export class VegaBaseView {
   /**
    * @param {object} query Elastic Query DSL snippet, as used in the query DSL editor
    * @param {string} [index] as defined in Kibana, or default if missing
+   * @param {string} Elastic Query DSL's Custom label for kibanaAddFilter, as used in '+ Add Filter'
    */
-  async addFilterHandler(query, index) {
+  async addFilterHandler(query, index, alias) {
     const indexId = await this.findIndex(index);
-    const filter = esFilters.buildQueryFilter(query, indexId);
+    const filter = esFilters.buildQueryFilter(query, indexId, alias);
 
     this._fireEvent({ name: 'applyFilter', data: { filters: [filter] } });
   }