HtmlForgeX

API Reference

Class

MonitoringDashboard

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Monitoring/MonitoringDashboard.cs:18
Base MonitoringElement
Modifiers sealed

Builds a reusable monitoring report shell with a top bar, sidebar navigation, pages, footer actions, dashboard state persistence, and shared monitoring assets.

Inheritance

Remarks

Use MonitoringDashboardSettings>) for layout, state, navigation, and theme options so the root fluent surface stays focused on common report composition.

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

Accepted by parameters

Constructors

public MonitoringDashboard() #
Containers/Monitoring/MonitoringDashboard.cs:18

Creates a monitoring dashboard with default topbar and footer actions.

Methods

public MonitoringDashboard AddFooterAction(String label, TablerIconType icon, String href = "#") #
Containers/Monitoring/MonitoringDashboard.cs:146
Returns: MonitoringDashboard

Adds a footer action rendered in the sticky dashboard footer.

Parameters

label System.String requiredposition: 0
Visible action label.
icon HtmlForgeX.TablerIconType requiredposition: 1
Tabler icon shown before the label.
href System.String = "#" optionalposition: 2
Link target. Local # links show the dashboard's lightweight action feedback.
AddPage 2 overloads
public MonitoringDashboard AddPage(String key, String title, String subtitle, TablerIconType icon, Action<MonitoringPage> configure, Boolean active, String badge) #
Containers/Monitoring/MonitoringDashboard.cs:95
Returns: MonitoringDashboard

Adds a dashboard page and matching sidebar navigation item.

Parameters

key System.String requiredposition: 0
Stable page key used for navigation, persisted state, and hash links.
title System.String requiredposition: 1
Visible page title and sidebar label.
subtitle System.String requiredposition: 2
Visible page subtitle.
icon HtmlForgeX.TablerIconType requiredposition: 3
Tabler icon used for the page heading and sidebar item.
configure System.Action{HtmlForgeX.MonitoringPage} requiredposition: 4
Callback that populates the page with KPIs, panels, tables, and other monitoring content.
active System.Boolean requiredposition: 5
When true, this page becomes the initial active page.
badge System.String requiredposition: 6
Optional sidebar badge text, such as an alert count.
public MonitoringDashboard AddPage(String key, String title, String subtitle, TablerIconType icon, Action<MonitoringPage> configure, Boolean active = false, String badge = null, String group = null) #
Containers/Monitoring/MonitoringDashboard.cs:110
Returns: MonitoringDashboard

Adds a dashboard page and matching sidebar navigation item.

Parameters

key System.String requiredposition: 0
Stable page key used for navigation, persisted state, and hash links.
title System.String requiredposition: 1
Visible page title and sidebar label.
subtitle System.String requiredposition: 2
Visible page subtitle.
icon HtmlForgeX.TablerIconType requiredposition: 3
Tabler icon used for the page heading and sidebar item.
configure System.Action{HtmlForgeX.MonitoringPage} requiredposition: 4
Callback that populates the page with KPIs, panels, tables, and other monitoring content.
active System.Boolean = false optionalposition: 5
When true, this page becomes the initial active page.
badge System.String = null optionalposition: 6
Optional sidebar badge text, such as an alert count.
group System.String = null optionalposition: 7
Optional sidebar group label used to organize dense monitoring workspaces.
public MonitoringDashboard AddTopAction(String label, TablerIconType icon, String href = null, String badge = null) #
Containers/Monitoring/MonitoringDashboard.cs:135
Returns: MonitoringDashboard

Adds an icon-only action to the dashboard top bar.

Parameters

label System.String requiredposition: 0
Accessible label and tooltip for the action.
icon HtmlForgeX.TablerIconType requiredposition: 1
Tabler icon shown in the action button.
href System.String = null optionalposition: 2
Optional link target. When omitted, a button is rendered.
badge System.String = null optionalposition: 3
Optional badge text shown on the action.
Brand 2 overloads
public MonitoringDashboard Brand(String text) #
Containers/Monitoring/MonitoringDashboard.cs:52
Returns: MonitoringDashboard

Sets the dashboard brand text shown in the top bar.

Parameters

text System.String requiredposition: 0
Brand text shown beside the logo.
public MonitoringDashboard Brand(String text, String logoSvg) #
Containers/Monitoring/MonitoringDashboard.cs:69
Returns: MonitoringDashboard
EditorBrowsable(2)

Sets the dashboard brand text and raw SVG logo shown in the top bar.

Parameters

text System.String requiredposition: 0
Brand text shown beside the logo.
logoSvg System.String requiredposition: 1
Raw SVG markup for the logo.
public MonitoringDashboard FooterInfo(String text) #
Containers/Monitoring/MonitoringDashboard.cs:80
Returns: MonitoringDashboard

Sets the fixed footer information text shown beside footer actions.

Parameters

text System.String requiredposition: 0
Summary or generation metadata for the dashboard footer.
public MonitoringDashboard Settings(Action<MonitoringDashboardSettings> configure) #
Containers/Monitoring/MonitoringDashboard.cs:156
Returns: MonitoringDashboard

Configures less-common dashboard behavior such as state persistence, hash mode, layout density, sidebar labels, and the shared theme selector.

Parameters

configure System.Action{HtmlForgeX.MonitoringDashboardSettings} requiredposition: 0
Settings callback. Use grouped builders such as State(...), Layout(...), and Theme(...) for longer chains.
public override String ToString() #
Containers/Monitoring/MonitoringDashboard.cs:206
Returns: String