IAttributeFilterProps
Home > @gooddata/sdk-ui-filters > IAttributeFilterProps
IAttributeFilterProps interface
Signature:
export interface IAttributeFilterProps
Properties
Property | Type | Description |
---|---|---|
backend? | IAnalyticalBackend | (Optional) Specify an instance of analytical backend instance to work with. |
connectToPlaceholder? | IPlaceholder<IAttributeFilter> | (Optional) Specify IPlaceholder to use to get and set the value of the attribute filter. |
filter? | IAttributeFilter | (Optional) Specify an attribute filter that will be customized using this filter. |
FilterError? | React.ComponentType<{ error?: any; }> | (Optional) Customize attribute filter with a component to be rendered if attribute elements loading fails |
FilterLoading? | React.ComponentType | (Optional) Customize attribute filter with a component to be rendered if attribute elements are loading |
fullscreenOnMobile? | boolean | (Optional) Customize, whether the filter should take the entire screen on mobile devices. |
identifier? | string | (Optional) Specify identifier of attribute, for which you want to construct the filter. |
locale? | string | (Optional) Customize locale to use for the different strings that appear on the filter component. |
onApply? | (filter: IAttributeFilter) => void | (Optional) Specify function which will be called when user clicks 'Apply' button. |
onError? | OnError | (Optional) Customize attribute filter with a callback function to trigger when an error occurs while loading attribute elements. |
parentFilterOverAttribute? | ObjRef | ((parentFilter: IAttributeFilter, index: number) => ObjRef) | (Optional) Specify the over attribute - an attribute the filter and its parent filter are connected through. |
parentFilters? | AttributeFiltersOrPlaceholders | (Optional) Specify a parent attribute filter that will be used to reduce options for available components options. |
title? | string | (Optional) Specify title for the attribute filter. |
titleWithSelection? | boolean | (Optional) Customize whether selected items should be summarized in the subtitle of the filter. |
workspace? | string | (Optional) Specify workspace to work with. |