RunDashboard
ConsoleMonster.Widgets
A height-bounded view of a declared run: totals, active work, queued work, groups and pinned problems.
Inheritance
- object
- RunDashboard
Usage
Explore 33 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 17
- Property LiveRun.Dashboard
- Extension method RunDashboard.WithLog
- Extension method RunDashboard.WithLogPaused
- Extension method RunDashboard.WithProblemsOnly
- Extension method RunDashboard.WithShowGroups
- Extension method RunDashboard.WithShowHelp
- Extension method RunDashboard.WithShowKeys
- Extension method RunDashboard.WithShowTrend
- Extension method RunDashboard.WithTitle
- Method RunDashboardFluent.WithLog
- Method RunDashboardFluent.WithLogPaused
- Method RunDashboardFluent.WithProblemsOnly
- Method RunDashboardFluent.WithShowGroups
- Method RunDashboardFluent.WithShowHelp
- Method RunDashboardFluent.WithShowKeys
- Method RunDashboardFluent.WithShowTrend
- Method RunDashboardFluent.WithTitle
Accepted by parameters 16
- Extension method RunDashboard.WithLog
- Extension method RunDashboard.WithLogPaused
- Extension method RunDashboard.WithProblemsOnly
- Extension method RunDashboard.WithShowGroups
- Extension method RunDashboard.WithShowHelp
- Extension method RunDashboard.WithShowKeys
- Extension method RunDashboard.WithShowTrend
- Extension method RunDashboard.WithTitle
- Method RunDashboardFluent.WithLog
- Method RunDashboardFluent.WithLogPaused
- Method RunDashboardFluent.WithProblemsOnly
- Method RunDashboardFluent.WithShowGroups
- Method RunDashboardFluent.WithShowHelp
- Method RunDashboardFluent.WithShowKeys
- Method RunDashboardFluent.WithShowTrend
- Method RunDashboardFluent.WithTitle
Constructors
Methods
public Size Measure(Constraints constraints, RenderContext context) #Returns the size the widget wants within the constraints.
Parameters
- constraints ConsoleMonster.Layout.Constraints
- The space offered.
- context ConsoleMonster.Canvas.RenderContext
- Profile, theme and glyphs.
public void Render(Region region, RenderContext context) #Renders into a region. The region may be smaller or larger than the measured size.
Parameters
- region ConsoleMonster.Canvas.Region
- The target region.
- context ConsoleMonster.Canvas.RenderContext
- Profile, theme and glyphs.
Inherited Methods
Properties
public bool ShowGroups { get; set; } #Whether group rows may use spare dashboard space.
public bool LogPaused { get; set; } #Whether completion lines are temporarily held.
public bool ProblemsOnly { get; set; } #Whether only problems are appended to the log.
public bool ShowTrend { get; set; } #The optional throughput trend beside the rate.
public LogRegion Log { get; } #Captured output and completion events. Entries stream to scrollback while its retained history stays bounded.
public IReadOnlyList<IWidget> Children { get; } #The child widgets in layout order.
Extension Methods
public static RunDashboard WithLog(RunDashboard runDashboard, Action<LogRegion> configure) #Configures RunDashboard.Log in place: Captured output and completion events. Entries stream to scrollback while its retained history stays bounded.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- configure System.Action<ConsoleMonster.Widgets.LogRegion>
- Configures the value.
public static RunDashboard WithLogPaused(RunDashboard runDashboard, bool value = true) #Sets RunDashboard.LogPaused: Whether completion lines are temporarily held.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- value bool = true
- The value (default true).
public static RunDashboard WithProblemsOnly(RunDashboard runDashboard, bool value = true) #Sets RunDashboard.ProblemsOnly: Whether only problems are appended to the log.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- value bool = true
- The value (default true).
public static RunDashboard WithShowGroups(RunDashboard runDashboard, bool value = true) #Sets RunDashboard.ShowGroups: Whether group rows may use spare dashboard space.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- value bool = true
- The value (default true).
public static RunDashboard WithShowHelp(RunDashboard runDashboard, bool value = true) #Sets RunDashboard.ShowHelp: Whether the key help is expanded.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- value bool = true
- The value (default true).
public static RunDashboard WithShowKeys(RunDashboard runDashboard, bool value = true) #Sets RunDashboard.ShowKeys: Whether the key hints are visible.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- value bool = true
- The value (default true).
public static RunDashboard WithShowTrend(RunDashboard runDashboard, bool value = true) #Sets RunDashboard.ShowTrend: The optional throughput trend beside the rate.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- value bool = true
- The value (default true).
public static RunDashboard WithTitle(RunDashboard runDashboard, string value) #Sets RunDashboard.Title: The run name, shown as literal text.
Parameters
- runDashboard ConsoleMonster.Widgets.RunDashboard
- The instance.
- value string
- The value.