IDashboardAttributeFilterConfig
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Extended attribute filter config
export interface IDashboardAttributeFilterConfig
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Display form to use to show elements of attribute filter in UI. Used only for attribute filters with elements selection. For text filters (arbitrary, match) it is not used. | |||
string | (ALPHA) Local identifier of the attribute filter to configure | ||
(ALPHA) (Optional) Control visibility mode of the attribute filter | |||
(ALPHA) (Optional) Controls which filter presentation modes are available to the user in Dashboard View mode. - “list” — only elements/list selection - “text” — only text-based filtering (arbitrary/match) - “listOrText” — both modes available, user can switch When not set, the default is derived from the current filter type: elements filters default to “list”, text filters default to “text”. |
Property details
IDashboardAttributeFilterConfig.displayAsLabelpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Display form to use to show elements of attribute filter in UI. Used only for attribute filters with elements selection. For text filters (arbitrary, match) it is not used.
displayAsLabel?: ObjRef;
IDashboardAttributeFilterConfig.localIdentifierpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Local identifier of the attribute filter to configure
localIdentifier: string;
IDashboardAttributeFilterConfig.modepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Control visibility mode of the attribute filter
mode?: DashboardAttributeFilterConfigMode;
IDashboardAttributeFilterConfig.selectionTypepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Controls which filter presentation modes are available to the user in Dashboard View mode. - “list” — only elements/list selection - “text” — only text-based filtering (arbitrary/match) - “listOrText” — both modes available, user can switch
When not set, the default is derived from the current filter type: elements filters default to “list”, text filters default to “text”.
selectionType?: DashboardAttributeFilterSelectionType;