Merged PR 3562: Visual level filters

Visual level filters update

Author: Amit Shuster

dist/powerbi-client.d.ts

@@ -419,6 +419,7 @@ declare module "ifilterable" {
 }
 declare module "visualDescriptor" {
     import * as models from 'powerbi-models';
+    import { IFilterable } from "ifilterable";
     import { IPageNode } from "page";
     /**
      * A Visual node within a report hierarchy
@@ -440,7 +441,7 @@ declare module "visualDescriptor" {
      * @class VisualDescriptor
      * @implements {IVisualNode}
      */
-    export class VisualDescriptor implements IVisualNode {
+    export class VisualDescriptor implements IVisualNode, IFilterable {
         /**
          * The visual name
          *
@@ -472,6 +473,39 @@ declare module "visualDescriptor" {
          */
         page: IPageNode;
         constructor(page: IPageNode, name: string, title: string, type: string, layout: models.IVisualLayout);
+        /**
+         * Gets all visual level filters of the current visual.
+         *
+         * ```javascript
+         * visual.getFilters()
+         *  .then(filters => { ... });
+         * ```
+         *
+         * @returns {(Promise<models.IFilter[]>)}
+         */
+        getFilters(): Promise<models.IFilter[]>;
+        /**
+         * Removes all filters from the current visual.
+         *
+         * ```javascript
+         * visual.removeFilters();
+         * ```
+         *
+         * @returns {Promise<void>}
+         */
+        removeFilters(): Promise<void>;
+        /**
+         * Sets the filters on the current visual to 'filters'.
+         *
+         * ```javascript
+         * visual.setFilters(filters);
+         *   .catch(errors => { ... });
+         * ```
+         *
+         * @param {(models.IFilter[])} filters
+         * @returns {Promise<void>}
+         */
+        setFilters(filters: models.IFilter[]): Promise<void>;
     }
 }
 declare module "page" {
@@ -536,7 +570,7 @@ declare module "page" {
          *
          * ```javascript
          * page.getFilters()
-         *  .then(pages => { ... });
+         *  .then(filters => { ... });
          * ```
          *
          * @returns {(Promise<models.IFilter[]>)}

dist/powerbi.js

@@ -70,7 +70,7 @@ export class Page implements IPageNode, IFilterable {
    * 
    * ```javascript
    * page.getFilters()
-   *  .then(pages => { ... });
+   *  .then(filters => { ... });
    * ```
    * 
    * @returns {(Promise<models.IFilter[]>)}

dist/powerbi.min.js

@@ -145,6 +145,17 @@ export class Service implements IService {
       this.handleEvent(event);
     });
 
+    this.router.post(`/reports/:uniqueId/pages/:pageName/visuals/:visualName/events/:eventName`, (req, res) => {
+      const event: IEvent<any> = {
+        type: 'report',
+        id: req.params.uniqueId,
+        name: req.params.eventName,
+        value: req.body
+      };
+
+      this.handleEvent(event);
+    });
+
     this.router.post(`/dashboards/:uniqueId/events/:eventName`, (req, res) => {
       const event: IEvent<any> = {
         type: 'dashboard',

src/page.ts

@@ -23,7 +23,7 @@ export interface IVisualNode {
  * @class VisualDescriptor
  * @implements {IVisualNode}
  */
-export class VisualDescriptor implements IVisualNode {
+export class VisualDescriptor implements IVisualNode, IFilterable {
   /**
    * The visual name
    * 
@@ -66,4 +66,53 @@ export class VisualDescriptor implements IVisualNode {
     this.layout = layout;
     this.page = page;
   }
+
+  /**
+   * Gets all visual level filters of the current visual.
+   * 
+   * ```javascript
+   * visual.getFilters()
+   *  .then(filters => { ... });
+   * ```
+   * 
+   * @returns {(Promise<models.IFilter[]>)}
+   */
+  getFilters(): Promise<models.IFilter[]> {
+    return this.page.report.service.hpm.get<models.IFilter[]>(`/report/pages/${this.page.name}/visuals/${this.name}/filters`, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow)
+      .then(response => response.body,
+        response => {
+          throw response.body;
+        });
+  }
+
+  /**
+   * Removes all filters from the current visual.
+   * 
+   * ```javascript
+   * visual.removeFilters();
+   * ```
+   * 
+   * @returns {Promise<void>}
+   */
+  removeFilters(): Promise<void> {
+    return this.setFilters([]);
+  }
+
+  /**
+   * Sets the filters on the current visual to 'filters'.
+   * 
+   * ```javascript
+   * visual.setFilters(filters);
+   *   .catch(errors => { ... });
+   * ```
+   * 
+   * @param {(models.IFilter[])} filters
+   * @returns {Promise<void>}
+   */
+  setFilters(filters: models.IFilter[]): Promise<void> {
+    return this.page.report.service.hpm.put<models.IError[]>(`/report/pages/${this.page.name}/visuals/${this.name}/filters`, filters, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow)
+      .catch(response => {
+        throw response.body;
+      });
+  }
 }