addMeasureValueFilter()

Home > @gooddata/sdk-ui-dashboard > addMeasureValueFilter

addMeasureValueFilter() function

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

Creates the AddMeasureValueFilter command.

Signature:

export declare function addMeasureValueFilter(measure: ObjRef, index: number, correlationId?: string, localIdentifier?: string, title?: string, mode?: DashboardAttributeFilterConfigMode): IAddMeasureValueFilter;

Parameters

Parameter	Type	Description
measure	ObjRef	catalog measure whose value should be filtered
index	number	position among draggable filters where the new filter should be placed
correlationId	string	(Optional) correlation id propagated through emitted events
localIdentifier	string	(Optional) optional local identifier for the new filter
title	string	(Optional) optional custom title for the new filter
mode	DashboardAttributeFilterConfigMode	(Optional) optional visibility mode for the new filter

Returns:

IAddMeasureValueFilter