MasterFilterValues Type

Contains values that are used to select elements in the master filter item.

Declaration

export type MasterFilterValues = Array<Array<PrimitiveType>> | Array<ItemDataAxisPointTuple>

Members

Type Description
js-Array`1<>>

An array of the PrimitiveType object arrays that specify selected master filter values.

js-Array`1

Remarks

Use the ViewerApiExtension.setMasterFilter method to set the master filter for a dashboard item.

The following code shows how to add filter values to the Grid dashboard item:

var filterValues = [['UK', 'Anne Dodsworth'], ['USA', 'Andrew Fuller']];
dashboardControl.GetDashboardControl().findExtension('viewer-api').setMasterFilter("gridSalesByState", filterValues);