DashboardFilterContextChanged

Home > @gooddata/sdk-ui-dashboard > DashboardFilterContextChanged

DashboardFilterContextChanged type

This event is emitted after _any_ change to dashboard filters (be it date or attribute filter). The event describes the new state of the entire filter context.

Signature:

export type DashboardFilterContextChanged = IDashboardEvent & {
    readonly type: "GDC.DASH/EVT.FILTER_CONTEXT.CHANGED";
    readonly payload: DashboardFilterContextChangedPayload;
};

References: IDashboardEvent, DashboardFilterContextChangedPayload

Remarks

This event is emitted as convenience - more granular events describe all the possible changes to the dashboard filters and can be used to even source the state of filter context.

See also filterContextToDashboardFiltersByWidget() and filterContextToDashboardFiltersByDateDataSet() convertors – those allow you to convert the filterContext in the event payload to array of IFilter instances you can use with visualizations, filter UI components and so on.

← DashboardEventTypeDashboardFilterContextChangedPayload →