DashboardParameterCollection Interface

A collection of the DashboardParameter objects.

Declaration

export interface DashboardParameterCollection

Methods

getParameterByIndex(index) Method

Returns a dashboard parameter by its index in the DashboardParameterCollection.

Declaration

getParameterByIndex(
    index: number
): DashboardParameter

Parameters

Name	Type	Description
index	number	An integer value that specifies the parameter index.

Returns

Type	Description
DashboardParameter	A DashboardParameter object that is a dashboard parameter.

getParameterByName(name) Method

Returns a dashboard parameter by its name.

Declaration

getParameterByName(
    name: string
): DashboardParameter

Parameters

Name	Type	Description
name	string	A string that specifies the parameter name.

Returns

Type	Description
DashboardParameter	A DashboardParameter object that is a dashboard parameter.

getParameterList Method

Returns an array of dashboard parameters from the DashboardParameterCollection.

Declaration

getParameterList(): Array<DashboardParameter>

Returns

Type	Description
DashboardParameter[]	An array of DashboardParameter objects that contains parameter settings and metadata.