IFilterable interface

パッケージ:

powerbi-client

フィルターをサポートする埋め込みコンポーネントを装飾する 例: レポートとページ

メソッド

getFilters()	オブジェクトに現在適用されているフィルターを取得します。
removeFilters()	現在のオブジェクトからすべてのフィルターを削除します。
setFilters(IFilter[])	現在のオブジェクトのすべてのフィルターを、指定したフィルター値に置き換えます。
updateFilters(FiltersOperations, IFilter[])	操作に従って、現在のインスタンスのフィルターを更新します。追加、すべて置換、ターゲットで置き換えるか、削除します。

メソッドの詳細

getFilters()

オブジェクトに現在適用されているフィルターを取得します。

function getFilters(): Promise<IFilter[]>

戻り値

Promise<IFilter[]>

removeFilters()

現在のオブジェクトからすべてのフィルターを削除します。

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

戻り値

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

現在のオブジェクトのすべてのフィルターを、指定したフィルター値に置き換えます。

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

パラメーター

filters

IFilter[]

戻り値

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

操作に従って、現在のインスタンスのフィルターを更新します。追加、すべて置換、ターゲットで置き換えるか、削除します。

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

パラメーター

operation

FiltersOperations

filters

IFilter[]

戻り値

Promise<IHttpPostMessageResponse<void>>