IMeasureValueFilterCommonProps

IMeasureValueFilterCommonProps.alignPointspropertyBeta

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

Optional alignment points for the dropdown overlay.

alignPoints?: IAlignPoint[];

Remarks

Mirrors the attribute filter alignment hook so hosts can position the MVF dropdown differently in nested surfaces, for example inside a dashboard filter group.

IMeasureValueFilterCommonProps.catalogDimensionalitypropertyBeta

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

Catalog items available for dimensionality

catalogDimensionality?: IDimensionalityItem[];

IMeasureValueFilterCommonProps.dimensionalitypropertyBeta

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

dimensionality?: IDimensionalityItem[];

IMeasureValueFilterCommonProps.displayTreatNullAsZeroOptionpropertyBeta

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

displayTreatNullAsZeroOption?: boolean;

IMeasureValueFilterCommonProps.enableMultipleConditionspropertyBeta

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

Enables UI support for defining multiple measure value filter conditions. When set to false (default), only a single condition is shown/edited and, if the provided filter contains multiple conditions, only the first one is used.

enableMultipleConditions?: boolean;

IMeasureValueFilterCommonProps.enableOperatorSelectionpropertyBeta

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

enableOperatorSelection?: boolean;

IMeasureValueFilterCommonProps.enableRankingWithMvfpropertyBeta

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

Enables using ranking filters together with measure value filters (MVF).

enableRankingWithMvf?: boolean;

IMeasureValueFilterCommonProps.filterpropertyBeta

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

filter?: IMeasureValueFilter;

IMeasureValueFilterCommonProps.formatpropertyBeta

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

Number format pattern for the measure (e.g., “#,##0.00”, “$#,##0”, etc.). When provided, values in the preview section will be formatted using this pattern. If not provided, falls back to simple number formatting with separators.

format?: string;

IMeasureValueFilterCommonProps.fullscreenOnMobilepropertyBeta

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

When true, the dropdown takes the entire screen on mobile devices.

fullscreenOnMobile?: boolean;

Remarks

Hosts that render the MVF inside responsive surfaces (e.g. dashboards) opt in to switch the overlay to a full-screen presentation on mobile viewports.

Defaults to false.

IMeasureValueFilterCommonProps.insightDimensionalitypropertyBeta

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

insightDimensionality?: IDimensionalityItem[];

IMeasureValueFilterCommonProps.isDimensionalityEnabledpropertyBeta

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

isDimensionalityEnabled?: boolean;

IMeasureValueFilterCommonProps.isFilterSummaryEnabledpropertyBeta

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

Controls visibility of the textual filter summary shown above the dropdown footer.

Defaults to true.

isFilterSummaryEnabled?: boolean;

IMeasureValueFilterCommonProps.isHeaderEnabledpropertyBeta

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

When true, renders a header at the top of the dropdown body with the metric title and a question-mark icon revealing metric details on hover/focus.

Defaults to false.

isHeaderEnabled?: boolean;

IMeasureValueFilterCommonProps.isLoadingCatalogDimensionalitypropertyBeta

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

Whether catalog dimensionality is currently being loaded. If true, the attribute picker can show a small loading indicator.

isLoadingCatalogDimensionality?: boolean;

IMeasureValueFilterCommonProps.isViewModepropertyBeta

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

When true, hides explanatory help tooltips (question marks) inside the dropdown. Intended for read-only / view-mode contexts where the educational UI is not needed.

isViewMode?: boolean;

IMeasureValueFilterCommonProps.loadCatalogDimensionalitypropertyBeta

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

Callback for loading catalog dimensionality items lazily.

When provided, the dimensionality picker can call this on demand (e.g. when opened) to load compatible attributes/dates for the current dimensionality.

loadCatalogDimensionality?: (dimensionality: ObjRefInScope[]) => Promise<IDimensionalityItem[]>;

IMeasureValueFilterCommonProps.loadMetricDetailspropertyBeta

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

Loader for the metric details shown in the dropdown header tooltip.

loadMetricDetails?: () => Promise<IMeasureMetadataObject | undefined>;

Remarks

Invoked the first time the user opens the tooltip — never on initial render. Pass this only when you want the dropdown header to expose a question-mark icon with lazily loaded metric metadata (description, format, identifier).

IMeasureValueFilterCommonProps.localepropertyBeta

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

locale?: string;

IMeasureValueFilterCommonProps.measureIdentifierpropertyBeta

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

measureIdentifier: string;

IMeasureValueFilterCommonProps.measureTitlepropertyBeta

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

Human-readable measure title used in UI texts (e.g., preview). If not provided, the preview falls back to showing only operator/value parts.

measureTitle?: string;

IMeasureValueFilterCommonProps.onApplypropertyBeta

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

onApply: (filter: IMeasureValueFilter | null) => void;

IMeasureValueFilterCommonProps.onChangepropertyBeta

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

Optional change callback used in IMeasureValueFilterCommonProps.withoutApply mode.

When withoutApply is true, every meaningful state change (operator switch, value commit, dimensionality update, treat-null-values toggle) is propagated through this callback instead of waiting for the user to click the Apply button.

onChange?: (filter: IMeasureValueFilter | null) => void;

IMeasureValueFilterCommonProps.onDimensionalityChangepropertyBeta

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

Callback triggered when dimensionality changes. Used to revalidate catalog items after selection changes.

onDimensionalityChange?: (dimensionality: ObjRefInScope[]) => void;

IMeasureValueFilterCommonProps.separatorspropertyBeta

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

separators?: ISeparators;

IMeasureValueFilterCommonProps.showSimplifiedSummarypropertyBeta

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

When true, renders a simplified filter summary: the “Preview:” header and the metric title are omitted, so only the conditions (and dimensionality, if any) are shown.

Defaults to false.

showSimplifiedSummary?: boolean;

IMeasureValueFilterCommonProps.treatNullAsZeroDefaultValuepropertyBeta

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

treatNullAsZeroDefaultValue?: boolean;

IMeasureValueFilterCommonProps.usePercentagepropertyBeta

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

usePercentage?: boolean;

IMeasureValueFilterCommonProps.useShortFormatpropertyBeta

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

When true, uses K/M/B shortening for compact display in the preview (e.g., “1K” instead of “1,000”). When false or undefined, uses full metric format. This provides consistency between the filter button and preview display.

useShortFormat?: boolean;

IMeasureValueFilterCommonProps.warningMessagepropertyBeta

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

warningMessage?: WarningMessage;

IMeasureValueFilterCommonProps.withoutApplypropertyBeta

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

When true, the dropdown hides its default Apply/Cancel footer and propagates intermediate filter state through IMeasureValueFilterCommonProps.onChange instead of accumulating changes until the user clicks Apply.

Intended for hosts (such as the Dashboard “Apply together” mode) that collect working filter changes and apply them via a global Apply action.

withoutApply?: boolean;