IDashboardAttributeFilterProps

IDashboardAttributeFilterProps.AttributeFilterComponentpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Optional custom attribute filter component to change or extend the default rendered one. The default is AttributeFilterButton Other component which fits this interface provided by GD is AttributeFilter

Note: Props provided to this component contains many filter customizations. E.g. parent/child filtering, cross filtering, various subcomponents etc. see IAttributeFilterButtonProps for more details.

use at your own risk

AttributeFilterComponent?: ComponentType<IAttributeFilterButtonProps>;

IDashboardAttributeFilterProps.AttributeFilterLoadingComponentproperty

Optional custom attribute filter loading component to change or extend the default rendered one.

AttributeFilterLoadingComponent?: ComponentType;

IDashboardAttributeFilterProps.autoOpenproperty

Specify whether should render filter with open dropdown

autoOpen?: boolean;

IDashboardAttributeFilterProps.displayAsLabelproperty

Attribute label to use for UI representation of filter elements

displayAsLabel?: ObjRef;

IDashboardAttributeFilterProps.filterproperty

Definition of filter to render.

filter: DashboardAttributeFilterItem;

Remarks

This can be any attribute filter type: element-based, arbitrary, or match filter.

IDashboardAttributeFilterProps.isDraggableproperty

Specify whether dragging handle and grab cursor should be displayed on hover

isDraggable?: boolean;

IDashboardAttributeFilterProps.onCloseproperty

Callback to be called, when user closes filter dropdown

onClose?: () => void;

IDashboardAttributeFilterProps.onFilterChangedproperty

When the user interacts with the filter and changes its value, it MUST use this callback to propagate the new filter value.

onFilterChanged: (filter: DashboardAttributeFilterItem, displayAsLabel?: ObjRef, isWorkingSelectionChange?: boolean, isResultOfMigration?: boolean, isSelectionInvalid?: boolean) => void;

IDashboardAttributeFilterProps.overlayPositionTypeproperty

Specifies the overlay position type for the attribute filter dropdown.

overlayPositionType?: OverlayPositionType;

IDashboardAttributeFilterProps.passDropdownButtonpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Controls whether the internal implementation of dashboard filter dropdown button should be used. When true (default), the AttributeFilterButton will receive a DropdownButtonComponent. When false, the AttributeFilterButton will not receive a DropdownButtonComponent and therefore can be overridden by the custom component.

This is useful when extending DashboardAttributeFilterComponent and want to use a different default dropdown button component internally but still want to make possible to customize the dropdown button component by user. Note: It is used in DashboardFilterGroupComponent.

passDropdownButton?: boolean;

IDashboardAttributeFilterProps.readonlypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Specify whether the filter should be readonly.

readonly?: boolean;

IDashboardAttributeFilterProps.tabIdproperty

Optional tab identifier to read filter context from. When provided, the filter will validate against filters from this specific tab. When undefined, uses the active tab (default behavior).

tabId?: string;

Remarks

This is primarily used in automation/scheduling contexts where filters from multiple tabs need to be displayed simultaneously.

IDashboardAttributeFilterProps.workingFilterproperty

Working filter which selection will be used to render.

workingFilter?: DashboardAttributeFilterItem;