IDashboardAttributeFilterProps

Home > @gooddata/sdk-ui-dashboard > IDashboardAttributeFilterProps

IDashboardAttributeFilterProps interface

Signature:

export interface IDashboardAttributeFilterProps 

Properties

Property	Modifiers	Type	Description
AttributeFilterComponent?		ComponentType<IAttributeFilterButtonProps>	(ALPHA) (Optional) 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
AttributeFilterLoadingComponent?		ComponentType	(Optional) Optional custom attribute filter loading component to change or extend the default rendered one.
autoOpen?		boolean	(Optional) Specify whether should render filter with open dropdown
displayAsLabel?		ObjRef	(Optional) Attribute label to use for UI representation of filter elements
filter		IDashboardAttributeFilter	Definition of filter to render.
isDraggable?		boolean	(Optional) Specify whether dragging handle and grab cursor should be displayed on hover
onClose?		() => void	(Optional) Callback to be called, when user closes filter dropdown
onFilterChanged		(filter: IDashboardAttributeFilter, displayAsLabel?: ObjRef, isWorkingSelectionChange?: boolean, isResultOfMigration?: boolean, isSelectionInvalid?: boolean) => void	When the user interacts with the filter and changes its value, it MUST use this callback to propagate the new filter value.
overlayPositionType?		OverlayPositionType	(Optional) Specifies the overlay position type for the attribute filter dropdown.
readonly?		boolean	(ALPHA) (Optional) Specify whether the filter should be readonly.
workingFilter?		IDashboardAttributeFilter	(Optional) Working filter which selection will be used to render.