IAttributeFilterStatusBarProps

IAttributeFilterStatusBarProps.attributeTitlepropertyBeta

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

Title of the attribute used for dependent filter configuration.

attributeTitle?: string;

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterStatusBarProps.enableShowingFilteredElementspropertyBeta

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

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

enableShowingFilteredElements?: boolean;

IAttributeFilterStatusBarProps.getItemTitlepropertyBeta

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

Item title getter used to get translated item empty value

getItemTitle: (item: IAttributeElement) => string;

IAttributeFilterStatusBarProps.irrelevantSelectionpropertyBeta

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

Irrelevant/filtered out selection elements which are still effective.

irrelevantSelection?: IAttributeElement[];

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterStatusBarProps.isFilteredByDependentDateFilterspropertyBeta

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

Indicates if the elements are filtered by dependent date filters or not.

isFilteredByDependentDateFilters?: boolean;

IAttributeFilterStatusBarProps.isFilteredByLimitingValidationItemspropertyBeta

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

Indicate if the elements are filtered by limit validation items or not.

isFilteredByLimitingValidationItems?: boolean;

Remarks

Use only when platform supports limiting validation items.

IAttributeFilterStatusBarProps.isFilteredByParentFilterspropertyBeta

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

Indicate that elements are filtered by parents filters or not.

isFilteredByParentFilters: boolean;

IAttributeFilterStatusBarProps.isInvertedpropertyBeta

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

Indicate that current filter is inverted INegativeAttributeFilter or not IPositiveAttributeFilter

isInverted: boolean;

IAttributeFilterStatusBarProps.onClearIrrelevantSelectionpropertyBeta

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

Clear irrelevant/filtered out selection callback.

onClearIrrelevantSelection?: () => void;

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterStatusBarProps.onShowFilteredElementspropertyBeta

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

Show filtered elements callback.

onShowFilteredElements?: () => void;

Remarks

Used only when showing filtered elements is enabled.

IAttributeFilterStatusBarProps.parentFilterTitlespropertyBeta

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

List of parent filter titles that filter current elements.

parentFilterTitles: string[];

IAttributeFilterStatusBarProps.selectedItemspropertyBeta

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

List of selected items

selectedItems: IAttributeElement[];

IAttributeFilterStatusBarProps.selectedItemsLimitpropertyBeta

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

Maximum selected items

selectedItemsLimit: number;

IAttributeFilterStatusBarProps.totalElementsCountWithCurrentSettingspropertyBeta

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

Number of elements that respect current criteria.

totalElementsCountWithCurrentSettings: number | undefined;

IAttributeFilterStatusBarProps.withoutApplypropertyBeta

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

Whether the filter is rendered without apply button.

withoutApply?: boolean;

Remarks

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