The requested page is not available for the requested platform. You are viewing the content for Default platform.

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
Array<Array<PrimitiveType>>

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

Array<ItemDataAxisPointTuple>

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);