IDashboardMeasureValueFilterProps
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
export interface IDashboardMeasureValueFilterProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (ALPHA) (Optional) Whether the dropdown should automatically open on mount. Used to focus newly added filters. | ||
(ALPHA) Definition of the dashboard measure value filter to render. Always reflects the applied filter — if/when “Apply together” mode for MVF is added, the working state is meant to be resolved internally via dashboard selectors rather than threaded through props. | |||
number | (ALPHA) Index of the filter among the other dashboard filters. | ||
ComponentType<IMeasureValueFilterProps> | (ALPHA) (Optional) Optional custom measure value filter component to change or extend the default rendered one. | ||
(filter: IDashboardMeasureValueFilter, conditions: MeasureValueFilterCondition[] | undefined, isWorkingSelectionChange?: boolean) => void | (ALPHA) Callback fired when the user changes the filter’s conditions. | ||
() => void | (ALPHA) (Optional) Callback fired when the filter dropdown is closed. | ||
boolean | (ALPHA) (Optional) Controls whether the internal dashboard dropdown button should be passed to the SDK component. When false, the SDK component can inject its own button, for example when rendered in a filter group. | ||
boolean | (ALPHA) (Optional) Whether the filter is rendered in read-only mode. | ||
string | (ALPHA) (Optional) Optional tab identifier to read filter config from. When provided, the visibility icon and any other tab-scoped state will be sourced from this specific tab. When undefined, the active tab’s state is used. |
Property details
IDashboardMeasureValueFilterProps.autoOpenpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Whether the dropdown should automatically open on mount. Used to focus newly added filters.
autoOpen?: boolean;
IDashboardMeasureValueFilterProps.filterpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Definition of the dashboard measure value filter to render. Always reflects the applied filter — if/when “Apply together” mode for MVF is added, the working state is meant to be resolved internally via dashboard selectors rather than threaded through props.
filter: IDashboardMeasureValueFilter;
IDashboardMeasureValueFilterProps.filterIndexpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Index of the filter among the other dashboard filters.
filterIndex: number;
IDashboardMeasureValueFilterProps.MeasureValueFilterComponentpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Optional custom measure value filter component to change or extend the default rendered one.
MeasureValueFilterComponent?: ComponentType<IMeasureValueFilterProps>;
IDashboardMeasureValueFilterProps.onMeasureValueFilterChangedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Callback fired when the user changes the filter’s conditions.
onMeasureValueFilterChanged: (filter: IDashboardMeasureValueFilter, conditions: MeasureValueFilterCondition[] | undefined, isWorkingSelectionChange?: boolean) => void;
IDashboardMeasureValueFilterProps.onMeasureValueFilterClosepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Callback fired when the filter dropdown is closed.
onMeasureValueFilterClose?: () => void;
IDashboardMeasureValueFilterProps.passDropdownButtonpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Controls whether the internal dashboard dropdown button should be passed to the SDK component. When false, the SDK component can inject its own button, for example when rendered in a filter group.
passDropdownButton?: boolean;
IDashboardMeasureValueFilterProps.readonlypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Whether the filter is rendered in read-only mode.
readonly?: boolean;
IDashboardMeasureValueFilterProps.tabIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Optional tab identifier to read filter config from. When provided, the visibility icon and any other tab-scoped state will be sourced from this specific tab. When undefined, the active tab’s state is used.
tabId?: string;