IMeasureValueFilterCommonProps

Home > @gooddata/sdk-ui-filters > IMeasureValueFilterCommonProps

IMeasureValueFilterCommonProps interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature:

export interface IMeasureValueFilterCommonProps 

Properties

Property	Modifiers	Type	Description
catalogDimensionality?		IDimensionalityItem[]	(BETA) (Optional) Catalog items available for dimensionality
dimensionality?		IDimensionalityItem[]	(BETA) (Optional)
displayTreatNullAsZeroOption?		boolean	(BETA) (Optional)
enableMultipleConditions?		boolean	(BETA) (Optional) 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.
enableOperatorSelection?		boolean	(BETA) (Optional)
enableRankingWithMvf?		boolean	(BETA) (Optional) Enables using ranking filters together with measure value filters (MVF).
filter?		IMeasureValueFilter	(BETA) (Optional)
format?		string	(BETA) (Optional) 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.
insightDimensionality?		IDimensionalityItem[]	(BETA) (Optional)
isDimensionalityEnabled?		boolean	(BETA) (Optional)
isLoadingCatalogDimensionality?		boolean	(BETA) (Optional) Whether catalog dimensionality is currently being loaded. If true, the attribute picker can show a small loading indicator.
locale?		string	(BETA) (Optional)
measureIdentifier		string	(BETA)
measureTitle?		string	(BETA) (Optional) Human-readable measure title used in UI texts (e.g., preview). If not provided, the preview falls back to showing only operator/value parts.
onApply		(filter: IMeasureValueFilter | null) => void	(BETA)
onDimensionalityChange?		(dimensionality: ObjRefInScope[]) => void	(BETA) (Optional) Callback triggered when dimensionality changes. Used to revalidate catalog items after selection changes.
separators?		ISeparators	(BETA) (Optional)
treatNullAsZeroDefaultValue?		boolean	(BETA) (Optional)
usePercentage?		boolean	(BETA) (Optional)
useShortFormat?		boolean	(BETA) (Optional) 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.
warningMessage?		WarningMessage	(BETA) (Optional)