AddAttributeFilterPayload
Home > @gooddata/sdk-ui-dashboard > AddAttributeFilterPayload
AddAttributeFilterPayload interface
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Payload of the AddAttributeFilter command.
Signature:
export interface AddAttributeFilterPayload
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| displayForm | readonly | ObjRef | (BETA) |
| index | readonly | number | (BETA) |
| initialIsNegativeSelection? | readonly | boolean | (BETA) (Optional) Specify if the initial selection of attribute elements is a negative one: if true, the elements selected should NOT be included in teh results. |
| initialSelection? | readonly | IAttributeElements | (BETA) (Optional) Specify the initial selection of attribute elements. If not provided all elements will be selected by default. |
| localIdentifier? | readonly | string | (BETA) (Optional) Specify the local identifier of attribute filter |
| mode? | readonly | DashboardAttributeFilterConfigMode | (BETA) (Optional) Specify the visibility mode of attribute filter |
| parentFilters? | readonly | ReadonlyArray<IDashboardAttributeFilterParent> | (BETA) (Optional) Specify parent filters whose selected values will be used to narrow down the selection in this newly added filter. |
| primaryDisplayForm? | readonly | ObjRef | (BETA) (Optional) Specify the primary display form of attribute filter. If provided it is used for filter definition and displayForm param is used only for UI representation |
| selectionMode? | readonly | DashboardAttributeFilterSelectionMode | (BETA) (Optional) Selection mode which defines how many elements can be in attributeElements. Default value is 'multi' if property is missing. |
| title? | readonly | string | (BETA) (Optional) Specify custom title of attribute filter |