フィルターの状態を検出する
注意
この機能は API バージョン 5.4 から使用できます
DataViewMetadata オブジェクトの isDataFilterApplied ブール パラメーターを使うと、レンダリングされた視覚エフェクトやレポートにフィルターが適用されているかどうかがわかります。 開発者はそれに応じて表示を調整できます (たとえば、フィルターの有無に応じてテキストを追加または削除するなど)。 この機能は、フィルターの適用対象がレポート全体、ページ、特定の視覚エフェクトのいずれかに関係なく適用されます。
isDataFilterApplied パラメーターを使うには:
public update(options: VisualUpdateOptions) {
const dataView = options?.dataViews[0];
if (dataView && dataView?.metadata?.isDataFilterApplied) {
...
}
}