Back to Devexpress

TdxDashboard.State Property

vcl-dxdashboard-dot-tdxdashboard-9c5f8286.md

latest2.4 KB
Original Source

TdxDashboard.State Property

Provides access to the dashboard state (in the JSON format).

Declaration

delphi
property State: TStringList read;

Property Value

TypeDescription
TStringList

Stores a dashboard state (as strings in the JSON format).

|

Remarks

The State property allows you to load and apply previously saved user interaction states (filter criteria, drill-down values, dashboard parameter values, etc.) to the current dashboard.

State and Parameters

The State property value stores parameter values. Every parameter value or setting change updates the State property value. Enclose multiple parameter changes between Parameters.BeginUpdate and Parameters.EndUpdate procedure calls to avoid excessive state updates and improve performance.

Available Options

Call State.LoadFromFile/State.LoadFromStream and State.SaveToFile/State.SaveToStream procedures to import and export dashboard states in the JSON format.

In addition, you can use State.Strings and State.Text properties to access and modify dashboard states directly (if required).

Refer to the TStringList class description for detailed information on all available options.

See Also

TdxDashboard.Layout Property

TdxDashboard.Parameters Property

TdxDashboard Class

TdxDashboard Members

dxDashboard Unit