DashboardFilterContextChanged

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

DashboardFilterContextChanged interface

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 interface DashboardFilterContextChanged extends IDashboardEvent

Extends: IDashboardEvent

Remarks

This event is emitted as convenience - more granular events describe all the possible changes to the dashboard filters and can be used to event 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.

Properties

PropertyModifiersTypeDescription
payloadreadonlyDashboardFilterContextChangedPayload
typereadonly"GDC.DASH/EVT.FILTER_CONTEXT.CHANGED"
← DashboardExportToPdfResolvedPayloadDashboardFilterContextChangedPayload →