HtmlForgeX

API Reference

Class

MonitoringDashboardStateSettings

Namespace HtmlForgeX
Assembly HtmlForgeX
Modifiers sealed

Groups dashboard state, storage, and hash-link settings.

Inheritance

  • Object
  • MonitoringDashboardStateSettings

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

public MonitoringDashboardSettings End() #
Returns: MonitoringDashboardSettings

Returns the parent dashboard settings builder.

public MonitoringDashboardStateSettings HashMode(MonitoringDashboardHashMode mode) #
Returns: MonitoringDashboardStateSettings

Selects how page navigation writes and reads URL hashes.

Parameters

mode HtmlForgeX.MonitoringDashboardHashMode requiredposition: 0
Hash-link mode for the dashboard.
public MonitoringDashboardStateSettings PersistState(Boolean persist = true) #
Returns: MonitoringDashboardStateSettings

Enables or disables local active-page and sidebar state persistence.

Parameters

persist System.Boolean = true optionalposition: 0
True to persist state in local storage.
public MonitoringDashboardStateSettings StateId(String id) #
Returns: MonitoringDashboardStateSettings

Sets the normalized dashboard state id used for hash namespacing and local storage keys.

Parameters

id System.String requiredposition: 0
Stable report or shell identifier.