API Reference
RunView
The live view of a RunTracker: a summary line (done of total, percentage, time left, counts), one cell per item in an active window, the running items with their elapsed time, and the first failures with their messages. Each frame draws a fresh snapshot, so the run can be updated from any thread.
Inheritance
- Object
- RunView
Usage
Explore 24 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 12
- Extension method RunView.WithMaxCellRows
- Extension method RunView.WithMaxFailures
- Extension method RunView.WithMaxFailuresWhenDone
- Extension method RunView.WithMaxListWidth
- Extension method RunView.WithMaxRunning
- Extension method RunView.WithTitle
- Method RunViewFluent.WithMaxCellRows
- Method RunViewFluent.WithMaxFailures
- Method RunViewFluent.WithMaxFailuresWhenDone
- Method RunViewFluent.WithMaxListWidth
- Method RunViewFluent.WithMaxRunning
- Method RunViewFluent.WithTitle
Accepted by parameters 12
- Extension method RunView.WithMaxCellRows
- Extension method RunView.WithMaxFailures
- Extension method RunView.WithMaxFailuresWhenDone
- Extension method RunView.WithMaxListWidth
- Extension method RunView.WithMaxRunning
- Extension method RunView.WithTitle
- Method RunViewFluent.WithMaxCellRows
- Method RunViewFluent.WithMaxFailures
- Method RunViewFluent.WithMaxFailuresWhenDone
- Method RunViewFluent.WithMaxListWidth
- Method RunViewFluent.WithMaxRunning
- Method RunViewFluent.WithTitle
Constructors
public RunView(RunTracker tracker) #Creates the view.
Parameters
- tracker ConsoleMonster.Live.RunTracker
- The run.
Methods
public IWidget Build(RunSnapshot snapshot, RenderContext context) #IWidgetThe widgets for one snapshot.
Parameters
- snapshot ConsoleMonster.Live.RunSnapshot
- The snapshot.
- context ConsoleMonster.Canvas.RenderContext
- The render context.
Returns
The view.
public Size Measure(Constraints constraints, RenderContext context) #SizeReturns the size the widget wants within the constraints.
Parameters
- constraints ConsoleMonster.Layout.Constraints
- The space offered.
- context ConsoleMonster.Canvas.RenderContext
- Profile, theme and glyphs.
Returns
The desired size, never larger than the constraints.
public Void Render(Region region, RenderContext context) #VoidRenders 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
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public Int32 MaxRunning { get; set; } #The most running items listed (default 8); more are counted.
public Int32 MaxFailures { get; set; } #The most failures listed while the run goes on (default 3); more are counted.
public Int32 MaxFailuresWhenDone { get; set; } #The most failures listed once the run has finished (default 10, never fewer than RunView.MaxFailures): the final frame stays in the scrollback.
public Int32 MaxListWidth { get; set; } #The widest the running items' list gets (default 72), so their times stay next to their names on wide terminals.
Extension Methods
public static RunView WithMaxCellRows(RunView runView, Int32 value) #RunViewSets RunView.MaxCellRows: The most rows of item cells (default 4).
Parameters
- runView ConsoleMonster.Widgets.RunView
- The instance.
- value System.Int32
- The value.
Returns
The same instance.
public static RunView WithMaxFailures(RunView runView, Int32 value) #RunViewSets RunView.MaxFailures: The most failures listed while the run goes on (default 3); more are counted.
Parameters
- runView ConsoleMonster.Widgets.RunView
- The instance.
- value System.Int32
- The value.
Returns
The same instance.
public static RunView WithMaxFailuresWhenDone(RunView runView, Int32 value) #RunViewSets RunView.MaxFailuresWhenDone: The most failures listed once the run has finished (default 10, never fewer than RunView.MaxFailures): the final frame stays in the scrollback.
Parameters
- runView ConsoleMonster.Widgets.RunView
- The instance.
- value System.Int32
- The value.
Returns
The same instance.
public static RunView WithMaxListWidth(RunView runView, Int32 value) #RunViewSets RunView.MaxListWidth: The widest the running items' list gets (default 72), so their times stay next to their names on wide terminals.
Parameters
- runView ConsoleMonster.Widgets.RunView
- The instance.
- value System.Int32
- The value.
Returns
The same instance.
public static RunView WithMaxRunning(RunView runView, Int32 value) #RunViewSets RunView.MaxRunning: The most running items listed (default 8); more are counted.
Parameters
- runView ConsoleMonster.Widgets.RunView
- The instance.
- value System.Int32
- The value.
Returns
The same instance.
public static RunView WithTitle(RunView runView, String? value) #RunViewSets RunView.Title: A title above the summary line (markup), or null.
Parameters
- runView ConsoleMonster.Widgets.RunView
- The instance.
- value System.String?
- The value.
Returns
The same instance.