attributeFilterToDashboardAttributeFilter()
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Converts IAttributeFilter to DashboardAttributeFilterItem.
export declare function attributeFilterToDashboardAttributeFilter(filter: IAttributeFilter, localIdentifier: string | undefined, title: string | undefined, attributeElements?: IAttributeElement[], isInverted?: boolean, selectionMode?: DashboardAttributeFilterSelectionMode): DashboardAttributeFilterItem;
Parameters
Parameter | Type | Description |
|---|---|---|
filter | filter to convert | |
localIdentifier | string | undefined | localIdentifier of the filter |
title | string | undefined | custom title of the filter |
attributeElements | (Optional) currently selected elements. Only used for element-based filters. | |
isInverted | boolean | (Optional) whether filter has negative selection (NOT_IN operator). Default is taken from the filter param. |
selectionMode | (Optional) selection mode of the filter (single / multi). Default is undefined. |
Returns
converted filter
Remarks
For arbitrary and match filters, returns the corresponding dedicated dashboard filter type with full lossless conversion. For element-based filters, returns IDashboardAttributeFilter.