Skip to main content
All docs
V25.1
  • ASPxClientDashboardParameter Class

    A client-side dashboard parameter.

    Declaration

    declare class ASPxClientDashboardParameter

    Remarks

    The ASPxClientDashboardParameter class exposes the ASPxClientDashboardParameter.Name and ASPxClientDashboardParameter.Value properties. These allow you to obtain the dashboard parameter name and specify its value on the client side.

    Warning

    The use of the 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.

    Properties

    Name Property

    Obsolete. Gets the dashboard parameter name on the client side.

    Declaration

    Name: string

    Property Value

    Type Description
    string

    A string value that is the dashboard parameter name on the client side.

    Remarks

    Use the ASPxClientDashboardParameter.Value property to specify the dashboard parameter value on the client side.

    Value Property

    Obsolete. Gets the dashboard parameter value on the client side.

    Declaration

    Value: any

    Property Value

    Type Description
    any

    A string value that specifies the dashboard parameter value on the client side.

    Remarks

    Use the ASPxClientDashboardParameter.Name property to obtain the dashboard parameter name on the client side.

    Methods

    GetDefaultValue Method

    Returns a default parameter value.

    Declaration

    GetDefaultValue(): any

    Returns

    Type Description
    any

    A default parameter value.

    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.

    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(): any

    Returns

    Type Description
    any

    A current parameter value(s).

    Remarks

    Use the ASPxClientDashboardParameter.SetValue method to specify the current parameter value.

    Note

    Note that the GetValue method returns an array of values if multi-selection is enabled.

    GetValues Method

    Returns possible parameter values.

    Declaration

    GetValues(): ASPxClientDashboardParameterValue[]

    Returns

    Type Description
    ASPxClientDashboardParameterValue[]

    An array of ASPxClientDashboardParameterValue objects that provide access to parameter values and display texts.

    Remarks

    Use the ASPxClientDashboardParameter.SetValue method to specify the current parameter value.

    SetValue(value) Method

    Specifies the current parameter value(s).

    Declaration

    SetValue(
        value: any
    ): void

    Parameters

    Name Type Description
    value any

    The current parameter value(s).

    Remarks

    Use the ASPxClientDashboardParameter.GetValues method to obtain possible parameter values. The ASPxClientDashboardParameter.GetValue method returns the current parameter value.

    Note

    Note that the SetValue method can accept an array of values if multi-selection is enabled.