API Reference
MonitoringDashboardSettings
Configures dashboard-level options that are useful for reusable generated monitoring reports.
Inheritance
- Object
- MonitoringDashboardSettings
Remarks
Existing flat methods are kept for compatibility. Prefer grouped builders for longer chains: State(...), Layout(...), Navigation(...), and Theme(...).
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method MonitoringDashboardLayoutSettings.End
- Method MonitoringDashboardNavigationSettings.End
- Method MonitoringDashboardSettings.CollapseLabel
- Method MonitoringDashboardSettings.DefaultTools
- Method MonitoringDashboardSettings.HashMode
- Method MonitoringDashboardSettings.KpiLayout
- Method MonitoringDashboardSettings.Layout
- Method MonitoringDashboardSettings.Navigation
- Method MonitoringDashboardSettings.PanelLayout
- Method MonitoringDashboardSettings.PersistState
- Method MonitoringDashboardSettings.Spacing
- Method MonitoringDashboardSettings.State
- Method MonitoringDashboardSettings.StateId
- Method MonitoringDashboardSettings.Theme
- Method MonitoringDashboardSettings.ThemeSelector
- Method MonitoringDashboardSettings.ThemeSelector
- Method MonitoringDashboardStateSettings.End
- Method MonitoringDashboardThemeSettings.End
Accepted by parameters
- Method MonitoringDashboard.Settings
Methods
public MonitoringDashboardSettings CollapseLabel(String label) #MonitoringDashboardSettingsEditorBrowsable(2)Sets the accessible label and tooltip for the sidebar collapse button.
Parameters
- label System.String
- Collapse button label. Blank values fall back to Collapse.
public MonitoringDashboardSettings DefaultTools(Boolean show = true) #MonitoringDashboardSettingsEditorBrowsable(2)Shows or hides generated default tools on pages.
Parameters
- show System.Boolean = true
- True to render default page tools; false to suppress them.
public MonitoringDashboardSettings HashMode(MonitoringDashboardHashMode mode) #MonitoringDashboardSettingsEditorBrowsable(2)Selects how page navigation writes and reads URL hashes.
Parameters
- mode HtmlForgeX.MonitoringDashboardHashMode
- Hash-link mode for the dashboard.
public MonitoringDashboardSettings KpiLayout(MonitoringDashboardKpiLayout layout) #MonitoringDashboardSettingsEditorBrowsable(2)Sets the KPI strip packing mode.
Parameters
- layout HtmlForgeX.MonitoringDashboardKpiLayout
- KPI layout preset.
public MonitoringDashboardSettings Layout(Action<MonitoringDashboardLayoutSettings> configure) #MonitoringDashboardSettingsGroups spacing, KPI packing, and panel placement options.
Parameters
- configure System.Action{HtmlForgeX.MonitoringDashboardLayoutSettings}
- Callback that configures layout-related settings.
public MonitoringDashboardSettings PanelLayout(MonitoringDashboardPanelLayout layout) #MonitoringDashboardSettingsEditorBrowsable(2)Sets dashboard panel placement behavior.
Parameters
- layout HtmlForgeX.MonitoringDashboardPanelLayout
- Panel layout flags.
public MonitoringDashboardSettings PersistState(Boolean persist = true) #MonitoringDashboardSettingsEditorBrowsable(2)Enables or disables local active-page and sidebar state persistence.
Parameters
- persist System.Boolean = true
- True to persist state in local storage.
public MonitoringDashboardSettings Spacing(MonitoringDashboardSpacing spacing) #MonitoringDashboardSettingsEditorBrowsable(2)Sets the dashboard spacing density.
Parameters
- spacing HtmlForgeX.MonitoringDashboardSpacing
- Spacing preset.
public MonitoringDashboardSettings State(Action<MonitoringDashboardStateSettings> configure) #MonitoringDashboardSettingsGroups persisted state, storage, and hash-link options.
Parameters
- configure System.Action{HtmlForgeX.MonitoringDashboardStateSettings}
- Callback that configures state-related settings.
public MonitoringDashboardSettings StateId(String id) #MonitoringDashboardSettingsEditorBrowsable(2)Sets the normalized dashboard state id used for hash namespacing and local storage keys.
Parameters
- id System.String
- Stable report or shell identifier.
public MonitoringDashboardSettings Theme(Action<MonitoringDashboardThemeSettings> configure) #MonitoringDashboardSettingsGroups shared theme selector options.
Parameters
- configure System.Action{HtmlForgeX.MonitoringDashboardThemeSettings}
- Callback that configures theme-related settings.
public MonitoringDashboardSettings ThemeSelector(Action<TablerThemeSelectorSettings> configure = null) #MonitoringDashboardSettingsEditorBrowsable(2)Adds and configures the shared HtmlForgeX theme selector in the dashboard top bar.
Parameters
- configure System.Action{HtmlForgeX.TablerThemeSelectorSettings} = null
- Optional theme selector settings callback.
public MonitoringDashboardSettings ThemeSelector(Boolean show) #MonitoringDashboardSettingsEditorBrowsable(2)Shows or hides the shared HtmlForgeX theme selector.
Parameters
- show System.Boolean
- True to render the selector; false to remove it.