Back to Devexpress

DashboardParameterCollection Interface

dashboard-js-devexpress-dot-dashboard-ca33f5cf.md

latest1.8 KB
Original Source

DashboardParameterCollection Interface

A collection of the DashboardParameter objects.

Declaration

ts
export interface DashboardParameterCollection

Methods

getParameterByIndex(index) Method

Returns a dashboard parameter by its index in the DashboardParameterCollection.

Declaration

ts
getParameterByIndex(
    index: number
): DashboardParameter

Parameters

NameTypeDescription
indexnumber

An integer value that specifies the parameter index.

|

Returns

TypeDescription
DashboardParameter

A DashboardParameter object that is a dashboard parameter.

|

getParameterByName(name) Method

Returns a dashboard parameter by its name.

Declaration

ts
getParameterByName(
    name: string
): DashboardParameter

Parameters

NameTypeDescription
namestring

A string that specifies the parameter name.

|

Returns

TypeDescription
DashboardParameter

A DashboardParameter object that is a dashboard parameter.

|

getParameterList Method

Returns an array of dashboard parameters from the DashboardParameterCollection.

Declaration

ts
getParameterList(): Array<DashboardParameter>

Returns

TypeDescription
DashboardParameter[]

An array of DashboardParameter objects that contains parameter settings and metadata.

|