IFilterMenuProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Props for FilterMenu component.
export interface IFilterMenuProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) Available filter selection types | |||
(ALPHA) Current filter selection type | |||
boolean | (ALPHA) (Optional) If true, tooltips in the menu are hidden. | ||
(ALPHA) (Optional) Labels for “Values as” section. When more than one, the section is shown. | |||
(labelRef: ObjRef) => void | (ALPHA) (Optional) Callback when label is selected. | ||
(selectionType: AttributeFilterSelectionType) => void | (ALPHA) Callback when selection type is changed | ||
(ALPHA) (Optional) Currently selected label ref. |
Property details
IFilterMenuProps.availableSelectionTypespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Available filter selection types
availableSelectionTypes?: AttributeFilterSelectionType[];
IFilterMenuProps.currentSelectionTypepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current filter selection type
currentSelectionType: AttributeFilterSelectionType;
IFilterMenuProps.hideTooltipspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
If true, tooltips in the menu are hidden.
hideTooltips?: boolean;
IFilterMenuProps.labelspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Labels for “Values as” section. When more than one, the section is shown.
labels?: IAttributeDisplayFormMetadataObject[];
IFilterMenuProps.onLabelChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when label is selected.
onLabelChange?: (labelRef: ObjRef) => void;
IFilterMenuProps.onSelectionTypeChangepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Callback when selection type is changed
onSelectionTypeChange: (selectionType: AttributeFilterSelectionType) => void;
IFilterMenuProps.selectedLabelRefpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Currently selected label ref.
selectedLabelRef?: ObjRef;