DashboardParameter Interface

A dashboard parameter.

Declaration

export interface DashboardParameter

Methods

getDefaultValue Method

Returns a default parameter value.

Declaration

getDefaultValue(): PrimitiveType | Array<PrimitiveType>

Returns

Type
PrimitiveType
Array<PrimitiveType>

getDescription Method

Returns the parameter’s description displayed to an end user.

Declaration

getDescription(): string

Returns

Type	Description
string	A string that is the parameter’s description displayed to an end user.

getLookUpValues Method

Gets values for static and dynamic lists.

Declaration

getLookUpValues(): Array<DashboardParameterLookUpValue>

Returns

Type	Description
Array<DashboardParameterLookUpValue>	An array of DashboardParameterLookUpValue objects that is a collection of default parameter values.

getName Method

Returns a parameter name.

Declaration

getName(): string

Returns

Type	Description
string	A string that is the parameter name.

getType Method

Returns a parameter type.

Declaration

getType(): string

Returns

Type	Description
string	A string that identifies the type of dashboard parameter value.

getValue Method

Returns a current parameter value(s).

Declaration

getValue(): PrimitiveType | Array<PrimitiveType>

Returns

Type
PrimitiveType
Array<PrimitiveType>

setValue(value) Method

Specifies the current parameter value(s).

Declaration

setValue(
    value: PrimitiveType | Array<PrimitiveType>
): any

Parameters

Name	Type	Description
value	PrimitiveType | Array<PrimitiveType>	A PrimitiveType object that is a default parameter value.

Returns

Type	Description
any	The current parameter value(s).