IAttributeFilterElementsSelectProps

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

IAttributeFilterElementsSelectProps interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

It represents a list of Attribute filter elements. It allows users to search elements and display a number of elements that respect current search criteria. It manipulates with current selection. It allows paging. It displays the current selection status.

Signature:

export interface IAttributeFilterElementsSelectProps 

Properties

Property	Modifiers	Type	Description
attributeTitle?		string	(BETA) (Optional) Title of the attribute
enableShowingFilteredElements?		boolean	(BETA) (Optional) This enables "show filtered elements" option which manages showing filtered elements.
error?		GoodDataSdkError	(BETA) (Optional) Error
irrelevantSelection?		IAttributeElement[]	(BETA) (Optional) Irrelevant/filtered out selection elements which are still effective.
isFilteredByDependentDateFilters?		boolean	(BETA) (Optional) Indicate that elements are filtered by dependent date filters
isFilteredByParentFilters		boolean	(BETA) Indicate that elements are filtered by parent filters
isInverted		boolean	(BETA) Indicate if current filter is inverted or not see: IPositiveAttributeFilter or INegativeAttributeFilter
isLoading		boolean	(BETA) Indicator that AttributeFilter component is in loading state
isLoadingNextPage		boolean	(BETA) Indicator that next page of elements is loading or not
items		IAttributeElement[]	(BETA) List of Attribute filter elements that are loaded and respect current search criteria.
nextPageSize		number	(BETA) Size of next page of elements
onClearIrrelevantSelection?		() => void	(BETA) (Optional) Clear irrelevant/filtered out selection callback.
onLoadNextPage		() => void	(BETA) Callback to obtain next page of AttributeFilter elements
onSearch		(searchString: string) => void	(BETA) Search callback
onSelect		(selectedItems: IAttributeElement[], isInverted: boolean) => void	(BETA) Change selection callback
onShowFilteredElements?		() => void	(BETA) (Optional) Show filtered elements callback.
parentFilterTitles		string[]	(BETA) List of parent filter titles that filter current elements
searchString		string	(BETA) Current search string
selectedItems		IAttributeElement[]	(BETA) List of current selected items.
totalItemsCount		number	(BETA) Number of all elements that respect current search criteria.
totalItemsCountWithCurrentSettings		number	(BETA) Number of all elements that respect current search criteria.