ChangeAttributeFilterSelectionPayload

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

ChangeAttributeFilterSelectionPayload interface

Payload type for ChangeAttributeFilterSelection command.

Signature:

export interface ChangeAttributeFilterSelectionPayload 

Properties

Property	Modifiers	Type	Description
elements	readonly	IAttributeElements	Selected attribute elements.
filterLocalId	readonly	string	Dashboard attribute filter's local identifier.
isResultOfMigration?	readonly	boolean	(Optional) Internal value, specifies that filter change was caused by displayAsLabel ad-hoc migration, the param will be removed once the usage of displayAsLabel is migrated on database metadata level.
isSelectionInvalid?	readonly	boolean	(Optional) Indicates if the current filter selection is invalid. When true, the filter's localId should be added to filtersWithInvalidSelection array in state. When false, the filter's localId should be removed from filtersWithInvalidSelection array.
isWorkingSelectionChange?	readonly	boolean	(Optional) Determines if this command should change working (staged for application) filters or applied filters (used to compute data). Default is false - command changes applied filters.
selectionType	readonly	AttributeFilterSelectionType	Selection type. Either 'IN' for positive selection or 'NOT_IN' for negative selection (All except selected items).