Skip to content

Commit 9913efb

Browse files
author
Amit Shuster
committed
Merged PR 15565: Report Visual get/set filters
Report visual get/set filters
1 parent 8f2c781 commit 9913efb

File tree

5 files changed

+5577
-5439
lines changed

5 files changed

+5577
-5439
lines changed

dist/powerbi-client.d.ts

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1119,8 +1119,6 @@ declare module "visual" {
11191119
*/
11201120
export class Visual extends Report {
11211121
static type: string;
1122-
static GetFiltersNotSupportedError: string;
1123-
static SetFiltersNotSupportedError: string;
11241122
static GetPagesNotSupportedError: string;
11251123
static SetPageNotSupportedError: string;
11261124
/**
@@ -1146,28 +1144,29 @@ declare module "visual" {
11461144
*/
11471145
setPage(pageName: string): Promise<void>;
11481146
/**
1149-
* Gets filters that are applied at the visual level.
1147+
* Gets filters that are applied to the filter level.
1148+
* Default filter level is visual level.
11501149
*
11511150
* ```javascript
1152-
* // Get filters applied at visual level
1153-
* visual.getFilters()
1151+
* visual.getFilters(filtersLevel)
11541152
* .then(filters => {
11551153
* ...
11561154
* });
11571155
* ```
11581156
*
11591157
* @returns {Promise<models.IFilter[]>}
11601158
*/
1161-
getFilters(): Promise<models.IFilter[]>;
1159+
getFilters(filtersLevel?: models.FiltersLevel): Promise<models.IFilter[]>;
11621160
/**
1163-
* Sets filters at the visual level.
1161+
* Sets filters at the filter level.
1162+
* Default filter level is visual level.
11641163
*
11651164
* ```javascript
11661165
* const filters: [
11671166
* ...
11681167
* ];
11691168
*
1170-
* visual.setFilters(filters)
1169+
* visual.setFilters(filters, filtersLevel)
11711170
* .catch(errors => {
11721171
* ...
11731172
* });
@@ -1176,7 +1175,19 @@ declare module "visual" {
11761175
* @param {(models.IFilter[])} filters
11771176
* @returns {Promise<void>}
11781177
*/
1179-
setFilters(filters: models.IFilter[]): Promise<void>;
1178+
setFilters(filters: models.IFilter[], filtersLevel?: models.FiltersLevel): Promise<void>;
1179+
/**
1180+
* Removes all filters from the current filter level.
1181+
* Default filter level is visual level.
1182+
*
1183+
* ```javascript
1184+
* visual.removeFilters(filtersLevel);
1185+
* ```
1186+
*
1187+
* @returns {Promise<void>}
1188+
*/
1189+
removeFilters(filtersLevel?: models.FiltersLevel): Promise<void>;
1190+
private getFiltersLevelUrl(filtersLevel);
11801191
}
11811192
}
11821193
declare module "service" {

0 commit comments

Comments
 (0)