IFilterBarProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
export interface IFilterBarProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ComponentType<IFilterBarProps> | (ALPHA) Contains reference to default implementation of the filter bar. If you are implementing a custom filter bar that decorates default filter bar, then use this component to render the default filter bar. | ||
(ALPHA) (Optional) Filter groups config. | |||
(ALPHA) Filters that are set for the dashboard. | |||
(filter: DashboardAttributeFilterItem, displayAsLabel?: ObjRef) => void | (ALPHA) When value of an attribute filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback. | ||
(filter: IDashboardDateFilter | undefined, dateFilterOptionLocalId?: string) => void | (ALPHA) When value of a date filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback. | ||
(filter: IDashboardMeasureValueFilter, conditions: MeasureValueFilterCondition[] | undefined, isWorkingSelectionChange?: boolean) => void | (ALPHA) (Optional) When the condition of a dashboard measure value filter changes, the filter bar MUST propagate the event using this callback. | ||
(ALPHA) (Optional) Working filters that are used to dispaly filter selected values. If undefined, filters are used instead. |
Property details
IFilterBarProps.DefaultFilterBarpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Contains reference to default implementation of the filter bar. If you are implementing a custom filter bar that decorates default filter bar, then use this component to render the default filter bar.
DefaultFilterBar: ComponentType<IFilterBarProps>;
IFilterBarProps.filterGroupsConfigpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Filter groups config.
filterGroupsConfig?: IDashboardFilterGroupsConfig;
IFilterBarProps.filterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Filters that are set for the dashboard.
filters: FilterContextItem[];
IFilterBarProps.onAttributeFilterChangedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
When value of an attribute filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback.
onAttributeFilterChanged: (filter: DashboardAttributeFilterItem, displayAsLabel?: ObjRef) => void;
IFilterBarProps.onDateFilterChangedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
When value of a date filter that is part of the FilterBar changes, the filter bar MUST propagate the event using this callback.
onDateFilterChanged: (filter: IDashboardDateFilter | undefined, dateFilterOptionLocalId?: string) => void;
IFilterBarProps.onMeasureValueFilterChangedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
When the condition of a dashboard measure value filter changes, the filter bar MUST propagate the event using this callback.
onMeasureValueFilterChanged?: (filter: IDashboardMeasureValueFilter, conditions: MeasureValueFilterCondition[] | undefined, isWorkingSelectionChange?: boolean) => void;
IFilterBarProps.workingFilterspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Working filters that are used to dispaly filter selected values. If undefined, filters are used instead.
workingFilters?: FilterContextItem[];