DashboardParameterCollection Interface
A collection of the DashboardParameter objects.
#Declaration
TypeScript
export interface DashboardParameterCollection
#Methods
#getParameterByIndex(index) Method
Returns a dashboard parameter by its index in the DashboardParameterCollection
.
#Declaration
TypeScript
getParameterByIndex(
index: number
): DashboardParameter
#Parameters
Name | Type | Description |
---|---|---|
index | number | An integer value that specifies the parameter index. |
#Returns
Type | Description |
---|---|
Dashboard |
A Dashboard |
#getParameterByName(name) Method
Returns a dashboard parameter by its name.
#Declaration
TypeScript
getParameterByName(
name: string
): DashboardParameter
#Parameters
Name | Type | Description |
---|---|---|
name | string | A string that specifies the parameter name. |
#Returns
Type | Description |
---|---|
Dashboard |
A Dashboard |
#getParameterList Method
Returns an array of dashboard parameters from the DashboardParameterCollection
.
#Declaration
TypeScript
getParameterList(): Array<DashboardParameter>
#Returns
Type | Description |
---|---|
Dashboard |
An array of Dashboard |