IAttributeFilterElementsSelectProps

IAttributeFilterElementsSelectProps.attributeTitlepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Title of the attribute

attributeTitle?: string;

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterElementsSelectProps.enableShowingFilteredElementspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

This enables “show filtered elements” option which manages showing filtered elements.

enableShowingFilteredElements?: boolean;

IAttributeFilterElementsSelectProps.errorpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Error

error?: GoodDataSdkError;

IAttributeFilterElementsSelectProps.irrelevantSelectionpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Irrelevant/filtered out selection elements which are still effective.

irrelevantSelection?: IAttributeElement[];

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterElementsSelectProps.isApplyDisabledpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

isApplyDisabled?: boolean;

IAttributeFilterElementsSelectProps.isFilteredByDependentDateFilterspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Indicate that elements are filtered by dependent date filters

isFilteredByDependentDateFilters?: boolean;

IAttributeFilterElementsSelectProps.isFilteredByLimitingValidationItemspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Indicate that elements are filtered by limiting validation items

isFilteredByLimitingValidationItems?: boolean;

Remarks

Use only when platform supports limiting validation items.

IAttributeFilterElementsSelectProps.isFilteredByParentFilterspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Indicate that elements are filtered by parent filters

isFilteredByParentFilters: boolean;

IAttributeFilterElementsSelectProps.isInvertedpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Indicate if current filter is inverted or not see: IPositiveAttributeFilter or INegativeAttributeFilter

isInverted: boolean;

IAttributeFilterElementsSelectProps.isLoadingpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Indicator that AttributeFilter component is in loading state

isLoading: boolean;

IAttributeFilterElementsSelectProps.isLoadingNextPagepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Indicator that next page of elements is loading or not

isLoadingNextPage: boolean;

IAttributeFilterElementsSelectProps.itemspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

List of Attribute filter elements that are loaded and respect current search criteria.

items: IAttributeElement[];

IAttributeFilterElementsSelectProps.nextPageSizepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Size of next page of elements

nextPageSize: number;

IAttributeFilterElementsSelectProps.onApplyButtonClickpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

onApplyButtonClick?: () => void;

IAttributeFilterElementsSelectProps.onClearIrrelevantSelectionpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Clear irrelevant/filtered out selection callback.

onClearIrrelevantSelection?: () => void;

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterElementsSelectProps.onLoadNextPagepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Callback to obtain next page of AttributeFilter elements

onLoadNextPage: () => void;

IAttributeFilterElementsSelectProps.onSearchpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Search callback

onSearch: (searchString: string) => void;

IAttributeFilterElementsSelectProps.onSelectpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Change selection callback

onSelect: (selectedItems: IAttributeElement[], isInverted: boolean) => void;

IAttributeFilterElementsSelectProps.onShowFilteredElementspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Show filtered elements callback.

onShowFilteredElements?: () => void;

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterElementsSelectProps.parentFilterTitlespropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

List of parent filter titles that filter current elements

parentFilterTitles: string[];

IAttributeFilterElementsSelectProps.searchStringpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Current search string

searchString: string;

IAttributeFilterElementsSelectProps.selectedItemspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

List of current selected items.

selectedItems: IAttributeElement[];

IAttributeFilterElementsSelectProps.totalItemsCountpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Number of all elements that respect current search criteria.

totalItemsCount: number | undefined;

IAttributeFilterElementsSelectProps.totalItemsCountWithCurrentSettingspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Number of all elements that respect current search criteria.

totalItemsCountWithCurrentSettings: number | undefined;

IAttributeFilterElementsSelectProps.withoutApplypropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Whether the filter is rendered without apply button.

withoutApply?: boolean;

Remarks

Usually true (in case of dashboard) when filtersApplyMode.mode === “ALL_AT_ONCE”