IFilterable interface

Package:

powerbi-client

Decorates embed components that support filters Examples include reports and pages

Methods

getFilters()	Gets the filters currently applied to the object.
removeFilters()	Removes all filters from the current object.
setFilters(IFilter[])	Replaces all filters on the current object with the specified filter values.
updateFilters(FiltersOperations, IFilter[])	Update the filters for the current instance according to the operation: Add, replace all, replace by target or remove.

Method Details

getFilters()

Gets the filters currently applied to the object.

function getFilters(): Promise<IFilter[]>

Returns

Promise<IFilter[]>

removeFilters()

Removes all filters from the current object.

function removeFilters(): Promise<IHttpPostMessageResponse<void>>

Returns

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Replaces all filters on the current object with the specified filter values.

function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Parameters

filters

IFilter[]

Returns

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Update the filters for the current instance according to the operation: Add, replace all, replace by target or remove.

function updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Parameters

operation

FiltersOperations

filters

IFilter[]

Returns

Promise<IHttpPostMessageResponse<void>>