useWidgetFilters

useWidgetFilters returns the effective filters of a widget: the dashboard filters the widget doesn’t ignore, combined with the filters of the visualization. Apply them with insightSetFilters from @gooddata/sdk-model to get a visualization that is ready for execution, for example in a plugin widget that runs its own execution.

Basic usage

import { type IInsightDefinition, insightSetFilters } from "@gooddata/sdk-model";
import { type FilterableDashboardWidget, useWidgetFilters } from "@gooddata/sdk-ui-dashboard";

export function MyWidgetComponent({
    widget,
    insight,
}: {
    widget: FilterableDashboardWidget;
    insight: IInsightDefinition;
}) {
    const { result: filters, status } = useWidgetFilters(widget, insight);

    if (status === "pending" || status === "running") {
        return <div>Loading filters...</div>;
    }

    if (status === "error" || status === "rejected") {
        return <div>Could not load the filters of this widget.</div>;
    }

    const insightWithFilters = insightSetFilters(insight, filters);
    // Execute insightWithFilters, for example with useExecutionDataView.
    return <div>{insightWithFilters.insight.filters.length} filters applied</div>;
}

Parameters

Return value

QueryProcessingState<IFilter[]>: an object with status ("pending" | "running" | "success" | "error" | "rejected"), result, and error. result holds the resolved filters when status is "success".

Notes

• Narrow on status before you use result: until "success", it’s empty or undefined.
• Cross-filtering is honored: when the widget is the source of a cross-filter, the attribute filters it introduced are left out of its own effective filters.
• Changing only the selected values of a dashboard filter re-runs less work than adding or removing a filter, or changing the widget’s ignore settings.
• In edit mode, attribute filters with nothing selected in a negative selection and “All time” date filters are left out. In view mode they are kept, to prevent flicker when a filter stops being ignored.
• A widget with no dateDataSet ignores the common date filter. Date filters with their own dimension are matched by data set.