IAttributeFilterCoreProps

Home > @gooddata/sdk-ui-filters > IAttributeFilterCoreProps

IAttributeFilterCoreProps interface

Signature:

export interface IAttributeFilterCoreProps

Properties

PropertyModifiersTypeDescription
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.
customIcon?IFilterButtonCustomIcon(ALPHA) (Optional) Represents a custom icon along with a tooltip.
dependentDateFilters?IDashboardDateFilter[](BETA) (Optional) Specifies a dependent date filter that will be used to reduce options for for current attribute filter.
disabled?boolean(ALPHA) (Optional) Specifies the visibility mode of the filter.
displayAsLabel?ObjRef(ALPHA) (Optional) Provide a attribute filter label used for representing elements in component.
enableDuplicatedLabelValuesInAttributeFilter?boolean(Optional) Enables duplicated values in secondary labels.
enableImmediateAttributeFilterDisplayAsLabelMigration?boolean(Optional) Enables the migration of displayAsLabel to be immediately reported to the parent app.
filter?IAttributeFilter(Optional) Specify an attribute filter that will be customized using this filter.
fullscreenOnMobile?boolean(Optional) Customize, whether the filter should take the entire screen on mobile devices.
hiddenElements?string[](Optional) If specified, these will be excluded from the elements available for selection and will also be removed from the resulting filter. This effectively behaves as if those elements were not part of the underlying display form.
locale?ILocale(Optional) Locale to use for localization of appearing texts.
onApply?OnApplyCallbackType(Optional) Specify function which will be called when user clicks 'Apply' button on this filter. Note: this callback is typically not called when using Dashboard apply filters mode ALL_AT_ONCE because there is no apply button dispalyed in attribute filter component. See withoutApply prop.
onError?(error: GoodDataSdkError) => void(Optional) Callback that will be triggered when error is thrown.
onSelect?OnSelectCallbackType(Optional) Specify function which will be called when user changes filter working selection. This is the selection that is staged for application. Not applied yet.
parentFilterOverAttribute?ParentFilterOverAttributeType(Optional) Specify the over attribute - an attribute the filter and its parent filter are connected through.
parentFilters?AttributeFiltersOrPlaceholders(Optional) Specifies a parent attribute filter that will be used to reduce options for current attribute filter.
selectFirst?boolean(Optional) Specify if first available element should be automatically selected for empty selection.
selectionMode?DashboardAttributeFilterSelectionMode(Optional) Customize, how many elements can be selected by filter.
staticElements?IAttributeElement[](Optional) If specified, these elements will replace the elements that would be loaded from the server. Note that if using this, limiting measures and/or filters will not work: it is your responsibility to filter the static elements yourself.
title?string(Optional) Specify title for the attribute filter.
validateElementsBy?ObjRef[](Optional) Specify the items that are used for elements availability validation (metrics or attributes, labels, or facts that the backend will use to build validation metrics from). Only the elements that are compatible with the provided elements will be shown in the filter.
withoutApply?boolean(Optional) This enables filter mode without apply button. If true, it is responsibility of a client, to appy filters when needed. Typically uses onSelect callback to catch filter state. Note, onApply callback is not called when this is true.
workspace?string(Optional) Specify workspace to work with.
← IAttributeFilterContextIAttributeFilterCustomComponentProps →