workingFilterContextDefinition

Home > @gooddata/sdk-ui-dashboard > FilterContextState > workingFilterContextDefinition

FilterContextState.workingFilterContextDefinition property

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Contains staged filters state which are not applied by the user yet. They are used to show selected values in filters and when user requests, they are applied to the filterContextDefinition (above).

Signature:

workingFilterContextDefinition?: IWorkingFilterContextDefinition;

Remarks

This working filter context contains only changed filters and their fields. before using this working, this state is merged with filterContextDefinition.

This way we do not need to synchronize other fields, which makes it easier to maintain.

This state is used when DashboardFiltersApplyMode is ALL_AT_ONCE. But can be used programatically when embedding the dashboard too.