Skip to main content
All docs
V24.2

ASPxClientDashboardParameters Class

A collection of ASPxClientDashboardParameter objects.

#Declaration

TypeScript
declare class ASPxClientDashboardParameters

#Remarks

The ASPxClientDashboardParameter object contains parameter settings and metadata.

Use the ASPxClientDashboard.GetParameters method to change parameter values.

Warning

A use of ASPxClientDashboard API reduces flexibility when you configure the control. The DashboardControl underlies the ASPxClientDashboard object. The control provides access to all client settings and allows you to implement complex scenarios. We recommend that you use the DashboardControl API to configure the Web Dashboard on the client. More information: Client-Side Functionality.

#Methods

#GetParameterByIndex(index) Method

Returns a dashboard parameter by its index in the ASPxClientDashboardParameters collection.

#Declaration

TypeScript
GetParameterByIndex(
    index: number
): ASPxClientDashboardParameter

#Parameters

Name Type Description
index number

An integer value that specifies the parameter index.

#Returns

Type Description
ASPxClientDashboardParameter

A ASPxClientDashboardParameter object that is the client-side dashboard parameter.

See Also

#GetParameterByName(name) Method

Returns a dashboard parameter by its name.

#Declaration

TypeScript
GetParameterByName(
    name: string
): ASPxClientDashboardParameter

#Parameters

Name Type Description
name string

A String object that specifies the parameter name.

#Returns

Type Description
ASPxClientDashboardParameter

A ASPxClientDashboardParameter object that is the client-side dashboard parameter.

See Also

#GetParameterList Method

Returns an array of dashboard parameters from the ASPxClientDashboardParameters collection.

#Declaration

TypeScript
GetParameterList(): ASPxClientDashboardParameter[]

#Returns

Type Description
ASPxClientDashboardParameter[]

An array of ASPxClientDashboardParameter objects representing client-side dashboard parameters.