TdxDashboardParameter Class

A dashboard parameter.

Declaration

TdxDashboardParameter = class(
    TdxBackendCustomParameter
)

Remarks

A dashboard parameter is a dynamic value that can replace constants in expressions, calculated fields, etc.

Main API Members

The list below outlines key members of the TdxDashboardParameter class. These members allow you to configure dashboard parameters.

AllowNull

Specifies if an empty field is interpreted as a Null or empty string value.

DataType

Specifies the parameter data type.

Description

Specifies a user-friendly description for the parameter.

Enabled | Visible

Specify if the parameter’s editor is visible and enabled in the UI.

Name

Specifies a unique name (identifier) for the parameter.

ToJSON | FromJSON

Export/import parameter data to/from a JSON array.

Values

Provides access to the collection of parameter values.

Direct TdxDashboardParameter Class References

The following public API members reference a TdxDashboardParameter object:

TdxDashboardParameters.Add

Creates a new parameter and adds it to the collection.

TdxDashboardParameters.FindParam

Returns the stored parameter with the specified name.

TdxDashboardParameters.Items

Provides indexed access to all parameters stored in the collection.

TdxDashboardParameters.ParamByName

Returns the stored parameter with the specified name

Inheritance

TObject

TPersistent

TCollectionItem

TdxBackendCustomParameter

TdxDashboardParameter