API Reference
Class
DashboardBuilder
Fluent builder for a Dashboard: header, a vertical body built like RowsBuilder, footer. Dashboard dashboard = new DashboardBuilder("Build") .Subtitle("ConsoleMonster 2.0.0") .Add(new Phases(), out Phases phases) .Columns(c => c.Panel("Steps", new StatusList(), out StatusList steps, 1.4).Panel("Module", new KeyValueList(), out KeyValueList info)) .Panel("Output", new LogRegion(), out LogRegion log, fill: true) .BuildDashboard();
Inheritance
- RowsBuilderBase<DashboardBuilder>
- DashboardBuilder
Usage
Explore 7 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 7
- Method DashboardBuilder.Add
- Method DashboardBuilder.Columns
- Method DashboardBuilder.Footer
- Method DashboardBuilder.Gap
- Method DashboardBuilder.Panel
- Method DashboardBuilder.Region
- Method DashboardBuilder.Subtitle
Constructors
public DashboardBuilder(String title) #Creates a builder.
Parameters
- title System.String
- The dashboard title (markup).
Methods
public Dashboard BuildDashboard(String name = "dashboard") #Returns:
DashboardBuilds the dashboard.
Parameters
- name System.String = "dashboard"
- The live name of the dashboard (default dashboard).
Returns
The dashboard.
public DashboardBuilder Subtitle(String subtitle) #Returns:
DashboardBuilderSets the subtitle.
Parameters
- subtitle System.String
- The subtitle (markup).
Returns
This builder.
Inherited Methods
Add 2 overloads
public DashboardBuilder Add(IWidget widget, LayoutSize? size = null) #Returns:
DashboardBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- widget IWidget
- size LayoutSize? = null
public DashboardBuilder Add<T>(T widget, out T added, LayoutSize? size = null) #Returns:
DashboardBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Type Parameters
- T
Parameters
- widget T
- added T
- size LayoutSize? = null
public DashboardBuilder Columns(Action<ColumnsBuilder> configure, LayoutSize? size = null) #Returns:
DashboardBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- configure Action<ColumnsBuilder>
- size LayoutSize? = null
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public DashboardBuilder Gap(Int32 gap) #Returns:
DashboardBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- gap Int32
Panel 2 overloads
public DashboardBuilder Panel<T>(String title, T widget, out T added, Boolean fill = false, String? caption = null) #Returns:
DashboardBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Type Parameters
- T
Parameters
- title String
- widget T
- added T
- fill Boolean = false
- caption String? = null
public DashboardBuilder Panel(String title, IWidget content, Boolean fill = false, String? caption = null) #Returns:
DashboardBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- title String
- content IWidget
- fill Boolean = false
- caption String? = null
public DashboardBuilder Region(String title, String name, IWidget? content = null, Boolean fill = false, String? caption = null) #Returns:
DashboardBuilderInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- title String
- name String
- content IWidget? = null
- fill Boolean = false
- caption String? = null