API Reference
LanesFluent
The fluent methods of Lanes, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.
Inheritance
- Object
- LanesFluent
Methods
public static Lanes AddColumn(Lanes lanes, ProgressColumn item) #LanesAdds an item to Lanes.Columns: The columns of each row (see ProgressColumns, for example ProgressColumns.Standard plus ProgressColumns.Rate or a custom column), or null (default) for the classic layout: marker, label, bar, percentage, pass/fail/warning counts and detail. With columns set, the stream heartbeat line also summarises the running lanes through them.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- item ConsoleMonster.Widgets.ProgressColumn
- The item.
Returns
The same instance.
public static Lanes AddColumns(Lanes lanes, params ProgressColumn[] items) #LanesAdds items to Lanes.Columns: The columns of each row (see ProgressColumns, for example ProgressColumns.Standard plus ProgressColumns.Rate or a custom column), or null (default) for the classic layout: marker, label, bar, percentage, pass/fail/warning counts and detail. With columns set, the stream heartbeat line also summarises the running lanes through them.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- items ConsoleMonster.Widgets.ProgressColumn[]
- The items, in order.
Returns
The same instance.
public static Lanes AddColumns(Lanes lanes, IEnumerable<ProgressColumn> items) #LanesAdds items to Lanes.Columns: The columns of each row (see ProgressColumns, for example ProgressColumns.Standard plus ProgressColumns.Rate or a custom column), or null (default) for the classic layout: marker, label, bar, percentage, pass/fail/warning counts and detail. With columns set, the stream heartbeat line also summarises the running lanes through them.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ProgressColumn>
- The items, in order.
Returns
The same instance.
public static Lanes WithBoldActive(Lanes lanes, Boolean value = true) #LanesSets Lanes.BoldActive: Whether a running lane's label is bold, so the active work stands out (default false).
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static Lanes WithCollapseWhen(Lanes lanes, StatusKind? value) #LanesSets Lanes.CollapseWhen: A state whose lanes fold into one summary row instead of a row each, for example StatusKind.Skip: "– 2 skipped: Alpha (46) · Beta (5)". Null (default) keeps every lane on its own row.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value ConsoleMonster.Styling.StatusKind?
- The value.
Returns
The same instance.
public static Lanes WithCollapseWhenFinished(Lanes lanes, Boolean value = true) #LanesSets Lanes.CollapseWhenFinished: Whether the display collapses to one summary line (12 done in 1m 05s) once every lane has finished.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static Lanes WithColumns(Lanes lanes, IList<ProgressColumn>? value) #LanesSets Lanes.Columns: The columns of each row (see ProgressColumns, for example ProgressColumns.Standard plus ProgressColumns.Rate or a custom column), or null (default) for the classic layout: marker, label, bar, percentage, pass/fail/warning counts and detail. With columns set, the stream heartbeat line also summarises the running lanes through them.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Collections.Generic.IList<ConsoleMonster.Widgets.ProgressColumn>?
- The value.
Returns
The same instance.
public static Lanes WithCountColumn(Lanes lanes, ColumnFormat value) #LanesSets Lanes.CountColumn: Layout of the pass, fail and warning count columns. Each count is its own column across all rows: the symbol stays put and the number is right-aligned. Digits are reserved from the largest lane total (when totals are known) and from the largest count displayed so far, so columns never move during a run.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value ConsoleMonster.Layout.ColumnFormat
- The value.
Returns
The same instance.
public static Lanes WithCountColumn(Lanes lanes, Action<ColumnFormat> configure) #LanesConfigures Lanes.CountColumn in place: Layout of the pass, fail and warning count columns. Each count is its own column across all rows: the symbol stays put and the number is right-aligned. Digits are reserved from the largest lane total (when totals are known) and from the largest count displayed so far, so columns never move during a run.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- configure System.Action<ConsoleMonster.Layout.ColumnFormat>
- Configures the value.
Returns
The same instance.
public static Lanes WithCountSkipped(Lanes lanes, Boolean value = true) #LanesSets Lanes.CountSkipped: Whether the third count column shows skipped steps (– / -) instead of warnings (▴ / !), for runs where skips matter more, such as test runs.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static Lanes WithDimPending(Lanes lanes, Boolean value = true) #LanesSets Lanes.DimPending: Whether a waiting (pending) lane's label is dimmed (default true).
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static Lanes WithHideCompleted(Lanes lanes, Boolean value = true) #LanesSets Lanes.HideCompleted: Whether finished lanes leave the display (counted in the summary line), so only running and queued work shows.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static Lanes WithMaxLabelWidth(Lanes lanes, Int32 value) #LanesSets Lanes.MaxLabelWidth: The widest label column (default 28).
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Int32
- The value.
Returns
The same instance.
public static Lanes WithPercentColumn(Lanes lanes, ColumnFormat value) #LanesSets Lanes.PercentColumn: Layout of the percentage column (default right-aligned, four cells for "100%").
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value ConsoleMonster.Layout.ColumnFormat
- The value.
Returns
The same instance.
public static Lanes WithPercentColumn(Lanes lanes, Action<ColumnFormat> configure) #LanesConfigures Lanes.PercentColumn in place: Layout of the percentage column (default right-aligned, four cells for "100%").
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- configure System.Action<ConsoleMonster.Layout.ColumnFormat>
- Configures the value.
Returns
The same instance.
public static Lanes WithRateWindow(Lanes lanes, TimeSpan value) #LanesSets Lanes.RateWindow: The moving window that smooths rates and remaining-time estimates (default 10 seconds).
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.TimeSpan
- The value.
Returns
The same instance.
public static Lanes WithShape(Lanes lanes, BarShape value) #LanesSets Lanes.Shape: The bar shape: BarShape.Line (default, thin strokes that keep rows apart) or BarShape.Block.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value ConsoleMonster.Widgets.BarShape
- The value.
Returns
The same instance.
public static Lanes WithShowDetail(Lanes lanes, Boolean value = true) #LanesSets Lanes.ShowDetail: Whether the detail column is shown (default true).
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static Lanes WithShowRunningCount(Lanes lanes, Boolean value = true) #LanesSets Lanes.ShowRunningCount: Whether a last row counts the running lanes ("● 3 running") while any run (default false).
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
public static Lanes WithTransient(Lanes lanes, Boolean value = true) #LanesSets Lanes.Transient: Whether the display disappears once every lane has finished (it measures zero rows), so an inline session ends with nothing left of it. Combine with LiveSessionOptions.PrintFinalState off for a fully transient session.
Parameters
- lanes ConsoleMonster.Widgets.Lanes
- The instance.
- value System.Boolean = true
- The value (default true).
Returns
The same instance.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?