Skip to content
ConsoleMonster
Class

WidgetsFluent

ConsoleMonster.Widgets

Namespace
ConsoleMonster.Widgets
Assembly
ConsoleMonster
Modifiers
static

The fluent methods of ActivityList, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • object
  • WidgetsFluent

Methods

public static LayoutRegions ActiveRegion(LayoutRegions layoutRegions, string? value) #

Sets LayoutRegions.ActiveRegion: The region shown in narrow mode when no region owns focus.

Parameters

layoutRegions ConsoleMonster.Widgets.LayoutRegions required
The instance.
value string? required
The value.

Returns

LayoutRegions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.LayoutRegions { ActiveRegion = value };    Ui.LayoutRegions().ActiveRegion(value);
AddAdditionalLegendEntries 2 overloads
public static Matrix AddAdditionalLegendEntries(Matrix matrix, params string[] items) #

Adds items to Matrix.AdditionalLegendEntries: Additional markup legend entries for evidence not assignable to a cell.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
items string[] required
The items, in order.

Returns

Matrix The same instance.
public static Matrix AddAdditionalLegendEntries(Matrix matrix, IEnumerable<string> items) #

Adds items to Matrix.AdditionalLegendEntries: Additional markup legend entries for evidence not assignable to a cell.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

Matrix The same instance.
public static Matrix AddAdditionalLegendEntry(Matrix matrix, string item) #

Adds an item to Matrix.AdditionalLegendEntries: Additional markup legend entries for evidence not assignable to a cell.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
item string required
The item.

Returns

Matrix The same instance.
public static ConsoleViewFrame AddBlock(ConsoleViewFrame consoleViewFrame, IWidget item) #

Adds an item to ConsoleViewFrame.Blocks: Body blocks separated by one blank line.

Parameters

consoleViewFrame ConsoleMonster.Widgets.ConsoleViewFrame required
The instance.
item ConsoleMonster.Layout.IWidget required
The item.

Returns

ConsoleViewFrame The same instance.
AddBlocks 2 overloads
public static ConsoleViewFrame AddBlocks(ConsoleViewFrame consoleViewFrame, params IWidget[] items) #

Adds items to ConsoleViewFrame.Blocks: Body blocks separated by one blank line.

Parameters

consoleViewFrame ConsoleMonster.Widgets.ConsoleViewFrame required
The instance.
items ConsoleMonster.Layout.IWidget[] required
The items, in order.

Returns

ConsoleViewFrame The same instance.
public static ConsoleViewFrame AddBlocks(ConsoleViewFrame consoleViewFrame, IEnumerable<IWidget> items) #

Adds items to ConsoleViewFrame.Blocks: Body blocks separated by one blank line.

Parameters

consoleViewFrame ConsoleMonster.Widgets.ConsoleViewFrame required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Layout.IWidget> required
The items, in order.

Returns

ConsoleViewFrame The same instance.
public static PathHop AddChip(PathHop pathHop, string item) #

Adds an item to PathHop.Chips: Plain text categories rendered by the existing chip presenter.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
item string required
The item.

Returns

PathHop The same instance.
AddChips 2 overloads
public static PathHop AddChips(PathHop pathHop, params string[] items) #

Adds items to PathHop.Chips: Plain text categories rendered by the existing chip presenter.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
items string[] required
The items, in order.

Returns

PathHop The same instance.
public static PathHop AddChips(PathHop pathHop, IEnumerable<string> items) #

Adds items to PathHop.Chips: Plain text categories rendered by the existing chip presenter.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

PathHop The same instance.
AddColumn 4 overloads
public static Lanes AddColumn(Lanes lanes, ProgressColumn item) #

Adds 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 required
The instance.
item ConsoleMonster.Widgets.ProgressColumn required
The item.

Returns

Lanes The same instance.
public static ProgressBar AddColumn(ProgressBar progressBar, ProgressColumn item) #

Adds an item to ProgressBar.Columns: The columns of the bar's row (see ProgressColumns: description, bar, percent, count, elapsed, remaining time, rate, custom...), or null (default) for the classic label, bar, percentage and count. With columns set, the stream heartbeat line summarises the bar through them.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
item ConsoleMonster.Widgets.ProgressColumn required
The item.

Returns

ProgressBar The same instance.
public static ViewHint AddColumn(ViewHint viewHint, string item) #

Adds an item to ViewHint.Columns: Literal names of hidden columns.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
item string required
The item.

Returns

ViewHint The same instance.
public static ProgressOptions AddColumn(ProgressOptions progressOptions, ProgressColumn item) #

Adds an item to ProgressOptions.Columns: The ordered progress columns.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
item ConsoleMonster.Widgets.ProgressColumn required
The item.

Returns

ProgressOptions The same instance.
AddColumns 8 overloads
public static Lanes AddColumns(Lanes lanes, params ProgressColumn[] items) #

Adds 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 required
The instance.
items ConsoleMonster.Widgets.ProgressColumn[] required
The items, in order.

Returns

Lanes The same instance.
public static Lanes AddColumns(Lanes lanes, IEnumerable<ProgressColumn> items) #

Adds 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 required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ProgressColumn> required
The items, in order.

Returns

Lanes The same instance.
public static ProgressBar AddColumns(ProgressBar progressBar, params ProgressColumn[] items) #

Adds items to ProgressBar.Columns: The columns of the bar's row (see ProgressColumns: description, bar, percent, count, elapsed, remaining time, rate, custom...), or null (default) for the classic label, bar, percentage and count. With columns set, the stream heartbeat line summarises the bar through them.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
items ConsoleMonster.Widgets.ProgressColumn[] required
The items, in order.

Returns

ProgressBar The same instance.
public static ProgressBar AddColumns(ProgressBar progressBar, IEnumerable<ProgressColumn> items) #

Adds items to ProgressBar.Columns: The columns of the bar's row (see ProgressColumns: description, bar, percent, count, elapsed, remaining time, rate, custom...), or null (default) for the classic label, bar, percentage and count. With columns set, the stream heartbeat line summarises the bar through them.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ProgressColumn> required
The items, in order.

Returns

ProgressBar The same instance.
public static ViewHint AddColumns(ViewHint viewHint, params string[] items) #

Adds items to ViewHint.Columns: Literal names of hidden columns.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
items string[] required
The items, in order.

Returns

ViewHint The same instance.
public static ViewHint AddColumns(ViewHint viewHint, IEnumerable<string> items) #

Adds items to ViewHint.Columns: Literal names of hidden columns.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

ViewHint The same instance.
public static ProgressOptions AddColumns(ProgressOptions progressOptions, params ProgressColumn[] items) #

Adds items to ProgressOptions.Columns: The ordered progress columns.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
items ConsoleMonster.Widgets.ProgressColumn[] required
The items, in order.

Returns

ProgressOptions The same instance.
public static ProgressOptions AddColumns(ProgressOptions progressOptions, IEnumerable<ProgressColumn> items) #

Adds items to ProgressOptions.Columns: The ordered progress columns.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ProgressColumn> required
The items, in order.

Returns

ProgressOptions The same instance.
public static TSelf AddColumn<TSelf>(TSelf table, string header, Action<TableColumn> configure) #

Adds a column with a header and an optional configuration.

Type Parameters

TSelf
The table type.

Parameters

table TSelf required
The table.
header string required
The header (markup).
configure System.Action<ConsoleMonster.Widgets.TableColumn> required
Configures the column (priority, presenter, overflow...), or null.

Returns

TSelf The same table.
public static HeaderBar AddCrumb(HeaderBar headerBar, string item) #

Adds an item to HeaderBar.Crumbs: Breadcrumb steps after the title, plain text ("Tasks", "Review & run").

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
item string required
The item.

Returns

HeaderBar The same instance.
AddCrumbs 2 overloads
public static HeaderBar AddCrumbs(HeaderBar headerBar, params string[] items) #

Adds items to HeaderBar.Crumbs: Breadcrumb steps after the title, plain text ("Tasks", "Review & run").

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
items string[] required
The items, in order.

Returns

HeaderBar The same instance.
public static HeaderBar AddCrumbs(HeaderBar headerBar, IEnumerable<string> items) #

Adds items to HeaderBar.Crumbs: Breadcrumb steps after the title, plain text ("Tasks", "Review & run").

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

HeaderBar The same instance.
AddEntries 2 overloads
public static Legend AddEntries(Legend legend, params string[] items) #

Adds items to Legend.Entries: Markup entries in display order.

Parameters

legend ConsoleMonster.Widgets.Legend required
The instance.
items string[] required
The items, in order.

Returns

Legend The same instance.
public static Legend AddEntries(Legend legend, IEnumerable<string> items) #

Adds items to Legend.Entries: Markup entries in display order.

Parameters

legend ConsoleMonster.Widgets.Legend required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

Legend The same instance.
public static Legend AddEntry(Legend legend, string item) #

Adds an item to Legend.Entries: Markup entries in display order.

Parameters

legend ConsoleMonster.Widgets.Legend required
The instance.
item string required
The item.

Returns

Legend The same instance.
public static ViewHeader AddFact(ViewHeader viewHeader, string item) #

Adds an item to ViewHeader.Facts: Fact markup, joined only at separators.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
item string required
The item.

Returns

ViewHeader The same instance.
AddFacts 2 overloads
public static ViewHeader AddFacts(ViewHeader viewHeader, params string[] items) #

Adds items to ViewHeader.Facts: Fact markup, joined only at separators.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
items string[] required
The items, in order.

Returns

ViewHeader The same instance.
public static ViewHeader AddFacts(ViewHeader viewHeader, IEnumerable<string> items) #

Adds items to ViewHeader.Facts: Fact markup, joined only at separators.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

ViewHeader The same instance.
public static Dashboard AddFooterHint(Dashboard dashboard, KeyHint item) #

Adds an item to Dashboard.FooterHints: The key hints in the footer when Dashboard.Footer is not set (default: ctrl+c stop).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
item ConsoleMonster.Widgets.KeyHint required
The item.

Returns

Dashboard The same instance.
AddFooterHints 2 overloads
public static Dashboard AddFooterHints(Dashboard dashboard, params KeyHint[] items) #

Adds items to Dashboard.FooterHints: The key hints in the footer when Dashboard.Footer is not set (default: ctrl+c stop).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
items ConsoleMonster.Widgets.KeyHint[] required
The items, in order.

Returns

Dashboard The same instance.
public static Dashboard AddFooterHints(Dashboard dashboard, IEnumerable<KeyHint> items) #

Adds items to Dashboard.FooterHints: The key hints in the footer when Dashboard.Footer is not set (default: ctrl+c stop).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.KeyHint> required
The items, in order.

Returns

Dashboard The same instance.
public static FooterBar AddHint(FooterBar footerBar, KeyHint item) #

Adds an item to FooterBar.Hints: The hints, in order.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
item ConsoleMonster.Widgets.KeyHint required
The item.

Returns

FooterBar The same instance.
AddHints 2 overloads
public static FooterBar AddHints(FooterBar footerBar, params KeyHint[] items) #

Adds items to FooterBar.Hints: The hints, in order.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
items ConsoleMonster.Widgets.KeyHint[] required
The items, in order.

Returns

FooterBar The same instance.
public static FooterBar AddHints(FooterBar footerBar, IEnumerable<KeyHint> items) #

Adds items to FooterBar.Hints: The hints, in order.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.KeyHint> required
The items, in order.

Returns

FooterBar The same instance.
public static ChartOptions AddItem(ChartOptions chartOptions, ChartItem item) #

Adds an item to ChartOptions.Items: Labelled bars or stacked segments.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
item ConsoleMonster.Widgets.ChartItem required
The item.

Returns

ChartOptions The same instance.
AddItems 2 overloads
public static ChartOptions AddItems(ChartOptions chartOptions, params ChartItem[] items) #

Adds items to ChartOptions.Items: Labelled bars or stacked segments.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
items ConsoleMonster.Widgets.ChartItem[] required
The items, in order.

Returns

ChartOptions The same instance.
public static ChartOptions AddItems(ChartOptions chartOptions, IEnumerable<ChartItem> items) #

Adds items to ChartOptions.Items: Labelled bars or stacked segments.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ChartItem> required
The items, in order.

Returns

ChartOptions The same instance.
AddPart 2 overloads
public static FactFlow AddPart(FactFlow factFlow, string item) #

Adds an item to FactFlow.Parts: Markup facts in display order.

Parameters

factFlow ConsoleMonster.Widgets.FactFlow required
The instance.
item string required
The item.

Returns

FactFlow The same instance.
public static ScoreGauge AddPart(ScoreGauge scoreGauge, KeyValuePair<string, string> item) #

Adds an item to ScoreGauge.Parts: Literal label/value components, in their supplied order.

Parameters

scoreGauge ConsoleMonster.Widgets.ScoreGauge required
The instance.
item System.Collections.Generic.KeyValuePair<string, string> required
The item.

Returns

ScoreGauge The same instance.
AddParts 4 overloads
public static FactFlow AddParts(FactFlow factFlow, params string[] items) #

Adds items to FactFlow.Parts: Markup facts in display order.

Parameters

factFlow ConsoleMonster.Widgets.FactFlow required
The instance.
items string[] required
The items, in order.

Returns

FactFlow The same instance.
public static FactFlow AddParts(FactFlow factFlow, IEnumerable<string> items) #

Adds items to FactFlow.Parts: Markup facts in display order.

Parameters

factFlow ConsoleMonster.Widgets.FactFlow required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

FactFlow The same instance.
public static ScoreGauge AddParts(ScoreGauge scoreGauge, params KeyValuePair<string, string>[] items) #

Adds items to ScoreGauge.Parts: Literal label/value components, in their supplied order.

Parameters

scoreGauge ConsoleMonster.Widgets.ScoreGauge required
The instance.
items System.Collections.Generic.KeyValuePair<string, string>[] required
The items, in order.

Returns

ScoreGauge The same instance.
public static ScoreGauge AddParts(ScoreGauge scoreGauge, IEnumerable<KeyValuePair<string, string>> items) #

Adds items to ScoreGauge.Parts: Literal label/value components, in their supplied order.

Parameters

scoreGauge ConsoleMonster.Widgets.ScoreGauge required
The instance.
items System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>> required
The items, in order.

Returns

ScoreGauge The same instance.
public static TableColumn AddRoleRule(TableColumn tableColumn, RoleRule item) #

Adds an item to TableColumn.RoleRules: Conditional tone rules for raw values; the first matching rule wins.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
item ConsoleMonster.Presenters.RoleRule required
The item.

Returns

TableColumn The same instance.
AddRoleRules 2 overloads
public static TableColumn AddRoleRules(TableColumn tableColumn, params RoleRule[] items) #

Adds items to TableColumn.RoleRules: Conditional tone rules for raw values; the first matching rule wins.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
items ConsoleMonster.Presenters.RoleRule[] required
The items, in order.

Returns

TableColumn The same instance.
public static TableColumn AddRoleRules(TableColumn tableColumn, IEnumerable<RoleRule> items) #

Adds items to TableColumn.RoleRules: Conditional tone rules for raw values; the first matching rule wins.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Presenters.RoleRule> required
The items, in order.

Returns

TableColumn The same instance.
public static CellMap AddRowLabel(CellMap cellMap, string item) #

Adds an item to CellMap.RowLabels: Labels drawn muted before the rows, one per row in order (empty = none, the default); the cells start after the widest label. Together with CellMap.Columns they make a labelled grid with one legend below it.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
item string required
The item.

Returns

CellMap The same instance.
AddRowLabels 2 overloads
public static CellMap AddRowLabels(CellMap cellMap, params string[] items) #

Adds items to CellMap.RowLabels: Labels drawn muted before the rows, one per row in order (empty = none, the default); the cells start after the widest label. Together with CellMap.Columns they make a labelled grid with one legend below it.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
items string[] required
The items, in order.

Returns

CellMap The same instance.
public static CellMap AddRowLabels(CellMap cellMap, IEnumerable<string> items) #

Adds items to CellMap.RowLabels: Labels drawn muted before the rows, one per row in order (empty = none, the default); the cells start after the widest label. Together with CellMap.Columns they make a labelled grid with one legend below it.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
items System.Collections.Generic.IEnumerable<string> required
The items, in order.

Returns

CellMap The same instance.
AddRowTitles``1 2 overloads
public static TSelf AddRowTitles<TSelf>(TSelf table, params string?[] items) #

Adds items to Table.RowTitles: Titles for the rows in record and card views, by data row index (a null or empty entry uses the key column), so a caller can title a record "pwsh (90836)" while the key column stays the name. Null for none.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
items string?[] required
The items, in order.

Returns

TSelf The same instance.
public static TSelf AddRowTitles<TSelf>(TSelf table, IEnumerable<string?> items) #

Adds items to Table.RowTitles: Titles for the rows in record and card views, by data row index (a null or empty entry uses the key column), so a caller can title a record "pwsh (90836)" while the key column stays the name. Null for none.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
items System.Collections.Generic.IEnumerable<string?> required
The items, in order.

Returns

TSelf The same instance.
public static TSelf AddRowTitle<TSelf>(TSelf table, string? item) #

Adds an item to Table.RowTitles: Titles for the rows in record and card views, by data row index (a null or empty entry uses the key column), so a caller can title a record "pwsh (90836)" while the key column stays the name. Null for none.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
item string? required
The item.

Returns

TSelf The same instance.
public static FooterBar AddSegment(FooterBar footerBar, FooterSegment item) #

Adds an item to FooterBar.Segments: Segments on the right (after FooterBar.Right), separated by a dot: a run id, a report link, a status.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
item ConsoleMonster.Widgets.FooterSegment required
The item.

Returns

FooterBar The same instance.
AddSegments 2 overloads
public static FooterBar AddSegments(FooterBar footerBar, params FooterSegment[] items) #

Adds items to FooterBar.Segments: Segments on the right (after FooterBar.Right), separated by a dot: a run id, a report link, a status.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
items ConsoleMonster.Widgets.FooterSegment[] required
The items, in order.

Returns

FooterBar The same instance.
public static FooterBar AddSegments(FooterBar footerBar, IEnumerable<FooterSegment> items) #

Adds items to FooterBar.Segments: Segments on the right (after FooterBar.Right), separated by a dot: a run id, a report link, a status.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.FooterSegment> required
The items, in order.

Returns

FooterBar The same instance.
AddSeries 3 overloads
public static ChartOptions AddSeries(ChartOptions chartOptions, ChartSeries item) #

Adds an item to ChartOptions.Series: Typed line/scatter series, retaining per-series colors.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
item ConsoleMonster.Widgets.ChartSeries required
The item.

Returns

ChartOptions The same instance.
public static ChartOptions AddSeries(ChartOptions chartOptions, params ChartSeries[] items) #

Adds items to ChartOptions.Series: Typed line/scatter series, retaining per-series colors.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
items ConsoleMonster.Widgets.ChartSeries[] required
The items, in order.

Returns

ChartOptions The same instance.
public static ChartOptions AddSeries(ChartOptions chartOptions, IEnumerable<ChartSeries> items) #

Adds items to ChartOptions.Series: Typed line/scatter series, retaining per-series colors.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.ChartSeries> required
The items, in order.

Returns

ChartOptions The same instance.
public static Tree AddValueColumn(Tree tree, TableColumn item) #

Adds an item to Tree.ValueColumns: Aligned value columns, keyed by TableColumn.Id in TreeNode.Values. Default alignment is right. Wide layouts reserve at least 40% for labels and shrink value columns before dropping them. Below 120 cells fitting detail precedes value notes. Lower priorities drop first; labels always receive space first. With columns the tree uses single-line labels, regardless of Tree.WrapLabels.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
item ConsoleMonster.Widgets.TableColumn required
The item.

Returns

Tree The same instance.
AddValueColumns 2 overloads
public static Tree AddValueColumns(Tree tree, params TableColumn[] items) #

Adds items to Tree.ValueColumns: Aligned value columns, keyed by TableColumn.Id in TreeNode.Values. Default alignment is right. Wide layouts reserve at least 40% for labels and shrink value columns before dropping them. Below 120 cells fitting detail precedes value notes. Lower priorities drop first; labels always receive space first. With columns the tree uses single-line labels, regardless of Tree.WrapLabels.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
items ConsoleMonster.Widgets.TableColumn[] required
The items, in order.

Returns

Tree The same instance.
public static Tree AddValueColumns(Tree tree, IEnumerable<TableColumn> items) #

Adds items to Tree.ValueColumns: Aligned value columns, keyed by TableColumn.Id in TreeNode.Values. Default alignment is right. Wide layouts reserve at least 40% for labels and shrink value columns before dropping them. Below 120 cells fitting detail precedes value notes. Lower priorities drop first; labels always receive space first. With columns the tree uses single-line labels, regardless of Tree.WrapLabels.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.TableColumn> required
The items, in order.

Returns

Tree The same instance.
public static TableColumn Aggregate(TableColumn tableColumn, ColumnAggregate value) #

Sets TableColumn.Aggregate: How the column is summarised in group subtotals and the totals row.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value ConsoleMonster.Widgets.ColumnAggregate required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property     // C# fluent
tableColumn.Aggregate = value;    tableColumn.Aggregate(value);
Alignment 4 overloads
public static Logo Alignment(Logo logo, HorizontalAlignment value) #

Sets Logo.Alignment: Alignment of the banner and tagline (default left).

Parameters

logo ConsoleMonster.Widgets.Logo required
The instance.
value ConsoleMonster.Layout.HorizontalAlignment required
The value.

Returns

Logo The same instance.

Examples

// C# initializer or property    // C# fluent
logo.Alignment = value;          Ui.Logo().Alignment(value);
public static Rule Alignment(Rule rule, HorizontalAlignment value) #

Sets Rule.Alignment: Title alignment (default left).

Parameters

rule ConsoleMonster.Widgets.Rule required
The instance.
value ConsoleMonster.Layout.HorizontalAlignment required
The value.

Returns

Rule The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.Rule { Alignment = value };    Ui.Rule().Alignment(value);
public static TextBlock Alignment(TextBlock textBlock, HorizontalAlignment value) #

Sets TextBlock.Alignment: Alignment (default left).

Parameters

textBlock ConsoleMonster.Widgets.TextBlock required
The instance.
value ConsoleMonster.Layout.HorizontalAlignment required
The value.

Returns

TextBlock The same instance.

Examples

// C# initializer or property    // C# fluent
textBlock.Alignment = value;     Ui.Text().Markup().Alignment(value);
public static TableColumn Alignment(TableColumn tableColumn, HorizontalAlignment? value) #

Sets TableColumn.Alignment: Alignment; null = automatic (right for numeric columns, left otherwise). The header follows it.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value ConsoleMonster.Layout.HorizontalAlignment? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property     // C# fluent
tableColumn.Alignment = value;    tableColumn.Alignment(value);
AlwaysCards``1 2 overloads
public static TSelf AlwaysCards<TSelf>(TSelf table, bool value) #

Sets Table.AlwaysCards: Shows the rows as record cards at any width (the Cards view of Show-Console).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.Table { AlwaysCards = value };    Ui.Table().AlwaysCards(value);
public static TSelf AlwaysCards<TSelf>(TSelf table) #

Sets Table.AlwaysCards to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
public static Matrix AsciiListDirection(Matrix matrix, string? value) #

Sets Matrix.AsciiListDirection: The ASCII connector for Matrix.ListDirection; null uses that connector unchanged.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property         // C# fluent
matrix.AsciiListDirection = value;    matrix.AsciiListDirection(value);
AsciiMarker 2 overloads
public static TableRowRole AsciiMarker(TableRowRole tableRowRole, string? value) #

Sets TableRowRole.AsciiMarker: The ASCII marker; null uses TableRowRole.Marker.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance.
value string? required
The value.

Returns

TableRowRole The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.TableRowRole { AsciiMarker = value };    tableRowRole.AsciiMarker(value);
public static TreeNode AsciiMarker(TreeNode treeNode, string? value) #

Sets TreeNode.AsciiMarker: The ASCII alternative to TreeNode.Marker; null uses that marker unchanged.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value string? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.AsciiMarker = value;    treeNode.AsciiMarker(value);
AutoTotals``1 2 overloads
public static TSelf AutoTotals<TSelf>(TSelf table, bool value) #

Sets Table.AutoTotals: With Table.ShowTotals, also sums every column whose values are all numbers (not the key column and not identifier columns such as Id or Port) when it has no TableColumn.Aggregate of its own.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Table { AutoTotals = value };    Ui.Table().AutoTotals(value);
public static TSelf AutoTotals<TSelf>(TSelf table) #

Sets Table.AutoTotals to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
public static BarChart AxisLabel(BarChart barChart, string? value) #

Sets BarChart.AxisLabel: A shared plain text label below the bars, for example elapsed time since an observation.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value string? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.BarChart { AxisLabel = value };    barChart.AxisLabel(value);
Bare 2 overloads
public static TreeNode Bare(TreeNode treeNode, bool value) #

Sets TreeNode.Bare: Render a container without a guide and exclude its label from value-column sizing.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value bool required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Bare = value;           treeNode.Bare(value);
public static TreeNode Bare(TreeNode treeNode) #

Sets TreeNode.Bare to true.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance to configure.

Returns

TreeNode The same instance.
public static BarChart BarHeader(BarChart barChart, string? value) #

Sets BarChart.BarHeader: Optional bar-column heading.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value string? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.BarChart { BarHeader = value };    barChart.BarHeader(value);
BarWidth 2 overloads
public static BarChart BarWidth(BarChart barChart, int? value) #

Sets BarChart.BarWidth: Optional maximum bar width in cells; null uses all available room.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value int? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.BarChart { BarWidth = value };    barChart.BarWidth(value);
public static SummaryBar BarWidth(SummaryBar summaryBar, int value) #

Sets SummaryBar.BarWidth: The bar width in cells (default 20; narrow regions shrink it).

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar required
The instance.
value int required
The value.

Returns

SummaryBar The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.SummaryBar { BarWidth = value };    Ui.SummaryBar().BarWidth(value);
public static ExceptionView BasePath(ExceptionView exceptionView, string? value) #

Sets ExceptionView.BasePath: The folder paths are shown relative to (default the current directory).

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value string? required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property      // C# fluent
exceptionView.BasePath = value;    exceptionView.BasePath(value);
public static TreeNode BasicMarker(TreeNode treeNode, string? value) #

Sets TreeNode.BasicMarker: An optional glyph used only in the Basic tier; null retains TreeNode.Marker.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value string? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.BasicMarker = value;    treeNode.BasicMarker(value);
public static TableColumn BelowWidth(TableColumn tableColumn, int value) #

Sets TableColumn.BelowWidth: Largest content width at which a Below column moves under its row (default 80).

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property      // C# fluent
tableColumn.BelowWidth = value;    tableColumn.BelowWidth(value);
Bold 4 overloads
public static PathHop Bold(PathHop pathHop, bool value) #

Sets PathHop.Bold: Whether the hop label is bold.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
value bool required
The value.

Returns

PathHop The same instance.

Examples

// C# initializer or property    // C# fluent
pathHop.Bold = value;            pathHop.Bold(value);
public static PathHop Bold(PathHop pathHop) #

Sets PathHop.Bold to true.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance to configure.

Returns

PathHop The same instance.
public static TableRowRole Bold(TableRowRole tableRowRole, bool value) #

Sets TableRowRole.Bold: Apply bold emphasis to every cell.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance.
value bool required
The value.

Returns

TableRowRole The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.TableRowRole { Bold = value };    tableRowRole.Bold(value);
public static TableRowRole Bold(TableRowRole tableRowRole) #

Sets TableRowRole.Bold to true.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance to configure.

Returns

TableRowRole The same instance.
BoldActive 2 overloads
public static Lanes BoldActive(Lanes lanes, bool value) #

Sets Lanes.BoldActive: Whether a running lane's label is bold, so the active work stands out (default false).

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Lanes { BoldActive = value };    Ui.Lanes().BoldActive(value);
public static Lanes BoldActive(Lanes lanes) #

Sets Lanes.BoldActive to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
public static TSelf Border<TSelf>(TSelf table, TableBorder value) #

Sets Table.Border: The border style (default rounded).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value ConsoleMonster.Widgets.TableBorder required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Widgets.Table { Border = value };    Ui.Table().Border(value);
Branch 2 overloads
public static Flow Branch(Flow flow, FlowBranch? value) #

Sets Flow.Branch: The single optional branch.

Parameters

flow ConsoleMonster.Widgets.Flow required
The instance.
value ConsoleMonster.Widgets.FlowBranch? required
The value.

Returns

Flow The same instance.

Examples

// C# initializer or property                                  // C# fluent
new global::ConsoleMonster.Widgets.Flow { Branch = value };    Ui.Flow().Branch(value);
public static ShellPrompt Branch(ShellPrompt shellPrompt, string? value) #

Sets ShellPrompt.Branch: The branch name, or a detached commit identifier; null omits git information.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance.
value string? required
The value.

Returns

ShellPrompt The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.ShellPrompt { Branch = value };    shellPrompt.Branch(value);
Capacity 4 overloads
public static LineChart Capacity(LineChart lineChart, int value) #

Sets LineChart.Capacity: How many values each series keeps (default 512).

Parameters

lineChart ConsoleMonster.Widgets.LineChart required
The instance.
value int required
The value.

Returns

LineChart The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.LineChart { Capacity = value };    lineChart.Capacity(value);
public static LogRegion Capacity(LogRegion logRegion, int value) #

Sets LogRegion.Capacity: How many lines are kept (default 1000).

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value int required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { Capacity = value };    Ui.LogRegion().Capacity(value);
public static Sparkline Capacity(Sparkline sparkline, int value) #

Sets Sparkline.Capacity: How many values are kept (default 1024).

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance.
value int required
The value.

Returns

Sparkline The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Sparkline { Capacity = value };    sparkline.Capacity(value);
public static ChartOptions Capacity(ChartOptions chartOptions, int? value) #

Sets ChartOptions.Capacity: Retained Line, Scatter or Sparkline samples; null keeps that kind's default.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value int? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Capacity = value };    Ui.Chart().Capacity(value);
public static TSelf Caption<TSelf>(TSelf table, string? value) #

Sets Table.Caption: A caption shown below the table (markup, muted).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value string? required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.Table { Caption = value };    Ui.Table().Caption(value);
public static TSelf CardsBelow<TSelf>(TSelf table, int value) #

Sets Table.CardsBelow: Below this many cells of width the rows render as record cards (key column as the card title); 0 disables cards. Default 60. Cards are used only when the grid cannot fit its minimum widths; they also take over when hiding columns would leave only the key column.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value int required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Table { CardsBelow = value };    Ui.Table().CardsBelow(value);
public static Matrix CellNote(Matrix matrix, string? value) #

Sets Matrix.CellNote: An optional literal explanation of what each cell contains.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.CellNote = value;         matrix.CellNote(value);
public static Lanes CollapseWhen(Lanes lanes, StatusKind? value) #

Sets 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 required
The instance.
value ConsoleMonster.Styling.StatusKind? required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Lanes { CollapseWhen = value };    Ui.Lanes().CollapseWhen(value);
CollapseWhenFinished 2 overloads
public static Lanes CollapseWhenFinished(Lanes lanes, bool value) #

Sets 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 required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.Lanes { CollapseWhenFinished = value };    Ui.Lanes().CollapseWhenFinished(value);
public static Lanes CollapseWhenFinished(Lanes lanes) #

Sets Lanes.CollapseWhenFinished to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
public static Matrix ColumnAxisCaption(Matrix matrix, string? value) #

Sets Matrix.ColumnAxisCaption: An optional plain text caption for the column axis, shown in grids and attention lists.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property        // C# fluent
matrix.ColumnAxisCaption = value;    matrix.ColumnAxisCaption(value);
Columns 5 overloads
public static CellMap Columns(CellMap cellMap, int value) #

Sets CellMap.Columns: The cells per row (0 = as many as fit, the default). Set it to draw a grid, such as one row per server and one column per check; cells past the width are cut off rather than moved to the next row.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
value int required
The value.

Returns

CellMap The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.CellMap { Columns = value };    Ui.CellMap().Columns(value);
public static KeyValueList Columns(KeyValueList keyValueList, int value) #

Sets KeyValueList.Columns: Preferred number of pairs per row; narrow layouts reduce the count automatically.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
value int required
The value.

Returns

KeyValueList The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.KeyValueList { Columns = value };    Ui.KeyValue().Columns(value);
public static Lanes Columns(Lanes lanes, IList<ProgressColumn>? value) #

Sets 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 required
The instance.
value System.Collections.Generic.IList<ConsoleMonster.Widgets.ProgressColumn>? required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.Lanes { Columns = value };    Ui.Lanes().Columns(value);
public static ProgressBar Columns(ProgressBar progressBar, IList<ProgressColumn>? value) #

Sets ProgressBar.Columns: The columns of the bar's row (see ProgressColumns: description, bar, percent, count, elapsed, remaining time, rate, custom...), or null (default) for the classic label, bar, percentage and count. With columns set, the stream heartbeat line summarises the bar through them.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value System.Collections.Generic.IList<ConsoleMonster.Widgets.ProgressColumn>? required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { Columns = value };    progressBar.Columns(value);
public static ProgressOptions Columns(ProgressOptions progressOptions, IList<ProgressColumn>? value) #

Sets ProgressOptions.Columns: The ordered progress columns.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value System.Collections.Generic.IList<ConsoleMonster.Widgets.ProgressColumn>? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Columns = value };    Ui.Progress().Columns(value);
Compact 2 overloads
public static ExceptionView Compact(ExceptionView exceptionView, bool value) #

Sets ExceptionView.Compact: Uses a message-first layout with the invocation line and a folded inner-exception count.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value bool required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property     // C# fluent
exceptionView.Compact = value;    exceptionView.Compact(value);
public static ExceptionView Compact(ExceptionView exceptionView) #

Sets ExceptionView.Compact to true.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance to configure.

Returns

ExceptionView The same instance.
CompactBranches 2 overloads
public static PathSet CompactBranches(PathSet pathSet, bool value) #

Sets PathSet.CompactBranches: Show the origin once and use compact branching chains with four-cell hanging continuations.

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance.
value bool required
The value.

Returns

PathSet The same instance.

Examples

// C# initializer or property       // C# fluent
pathSet.CompactBranches = value;    pathSet.CompactBranches(value);
public static PathSet CompactBranches(PathSet pathSet) #

Sets PathSet.CompactBranches to true.

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance to configure.

Returns

PathSet The same instance.
CompactGuides 2 overloads
public static Tree CompactGuides(Tree tree, bool value) #

Sets Tree.CompactGuides: Use three-cell guides rather than the original four-cell guides.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value bool required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Tree { CompactGuides = value };    Ui.Tree().CompactGuides(value);
public static Tree CompactGuides(Tree tree) #

Sets Tree.CompactGuides to true.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance to configure.

Returns

Tree The same instance.
Configure 6 overloads
public static Dashboard Configure(Dashboard dashboard, Action<Dashboard> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
configure System.Action<ConsoleMonster.Widgets.Dashboard> required
Assignments applied in order.

Returns

Dashboard The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.Dashboard { CompactSummary = value };    Ui.Dashboard().Configure(configured => configured.CompactSummary = value);
public static FooterBar Configure(FooterBar footerBar, Action<FooterBar> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
configure System.Action<ConsoleMonster.Widgets.FooterBar> required
Assignments applied in order.

Returns

FooterBar The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.FooterBar { HintsSource = value };    Ui.FooterBar().Configure(configured => configured.HintsSource = value);
public static Histogram Configure(Histogram histogram, Action<Histogram> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

histogram ConsoleMonster.Widgets.Histogram required
The instance.
configure System.Action<ConsoleMonster.Widgets.Histogram> required
Assignments applied in order.

Returns

Histogram The same instance.

Examples

// C# initializer or property    // C# fluent
histogram.EdgeFormat = value;    histogram.Configure(configured => configured.EdgeFormat = value);
public static Matrix Configure(Matrix matrix, Action<Matrix> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
configure System.Action<ConsoleMonster.Widgets.Matrix> required
Assignments applied in order.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.IsHealthy = value;        matrix.Configure(configured => configured.IsHealthy = value);
public static Tree Configure(Tree tree, Action<Tree> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
configure System.Action<ConsoleMonster.Widgets.Tree> required
Assignments applied in order.

Returns

Tree The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.Tree { CollapsedSummary = value };    Ui.Tree().Configure(configured => configured.CollapsedSummary = value);
public static TreeHierarchyOptions Configure(TreeHierarchyOptions treeHierarchyOptions, Action<TreeHierarchyOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

treeHierarchyOptions ConsoleMonster.Widgets.TreeHierarchyOptions required
The instance.
configure System.Action<ConsoleMonster.Widgets.TreeHierarchyOptions> required
Assignments applied in order.

Returns

TreeHierarchyOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { Identity = value };    treeHierarchyOptions.Configure(configured => configured.Identity = value);
// C# initializer or property                                                            // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { CollapsedSummary = value };    treeHierarchyOptions.Configure(configured => configured.CollapsedSummary = value);
// C# initializer or property                                                        // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { IsIncomplete = value };    treeHierarchyOptions.Configure(configured => configured.IsIncomplete = value);
Content 8 overloads
public static Dashboard Content(Dashboard dashboard, IWidget content) #

Configures this container's content before session ownership.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
content ConsoleMonster.Layout.IWidget required
The widget or nested content builder.

Returns

Dashboard The same instance.
public static Dashboard Content(Dashboard dashboard, Action<ContentBuilder> content) #

Configures this container's content before session ownership.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
content System.Action<ConsoleMonster.Layout.ContentBuilder> required
The widget or nested content builder.

Returns

Dashboard The same instance.
public static LayoutRegion Content(LayoutRegion layoutRegion, IWidget value) #

Sets LayoutRegion.Content: The current subtree. Swap existing subtrees while an app runs; configure new inputs before starting.

Parameters

layoutRegion ConsoleMonster.Widgets.LayoutRegion required
The instance.
value ConsoleMonster.Layout.IWidget required
The value.

Returns

LayoutRegion The same instance.

Examples

// C# initializer or property    // C# fluent
layoutRegion.Content = value;    layoutRegion.Content(value);
public static RegionWidget Content(RegionWidget regionWidget, IWidget content) #

Configures this container's content before session ownership.

Parameters

regionWidget ConsoleMonster.Widgets.RegionWidget required
The instance.
content ConsoleMonster.Layout.IWidget required
The widget or nested content builder.

Returns

RegionWidget The same instance.
public static RegionWidget Content(RegionWidget regionWidget, Action<ContentBuilder> content) #

Configures this container's content before session ownership.

Parameters

regionWidget ConsoleMonster.Widgets.RegionWidget required
The instance.
content System.Action<ConsoleMonster.Layout.ContentBuilder> required
The widget or nested content builder.

Returns

RegionWidget The same instance.
public static ScrollView Content(ScrollView scrollView, IWidget content) #

Configures this container's content before session ownership.

Parameters

scrollView ConsoleMonster.Widgets.ScrollView required
The instance.
content ConsoleMonster.Layout.IWidget required
The widget or nested content builder.

Returns

ScrollView The same instance.
public static ScrollView Content(ScrollView scrollView, Action<ContentBuilder> content) #

Configures this container's content before session ownership.

Parameters

scrollView ConsoleMonster.Widgets.ScrollView required
The instance.
content System.Action<ConsoleMonster.Layout.ContentBuilder> required
The widget or nested content builder.

Returns

ScrollView The same instance.
public static TextBlock Content(TextBlock textBlock, string value) #

Sets TextBlock.Content: The content (markup unless TextBlock.IsMarkup is false).

Parameters

textBlock ConsoleMonster.Widgets.TextBlock required
The instance.
value string required
The value.

Returns

TextBlock The same instance.

Examples

// C# initializer or property    // C# fluent
textBlock.Content = value;       Ui.Text().Markup().Content(value);
CountColumn 10 overloads
public static Lanes CountColumn(Lanes lanes, ColumnFormat value) #

Sets 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 required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.Lanes { CountColumn = value };    Ui.Lanes().CountColumn(value);
public static Lanes CountColumn(Lanes lanes, Action<ColumnFormat> configure) #

Configures 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 required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

Lanes The same instance.
public static ProgressBar CountColumn(ProgressBar progressBar, ColumnFormat value) #

Sets ProgressBar.CountColumn: Layout of the value in the value/total count (default right-aligned). The value reserves the width of the total, so the bar keeps its length as the value grows from 9 to 10.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { CountColumn = value };    progressBar.CountColumn(value);
public static ProgressBar CountColumn(ProgressBar progressBar, Action<ColumnFormat> configure) #

Configures ProgressBar.CountColumn in place: Layout of the value in the value/total count (default right-aligned). The value reserves the width of the total, so the bar keeps its length as the value grows from 9 to 10.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

ProgressBar The same instance.
public static StackedBar CountColumn(StackedBar stackedBar, ColumnFormat value) #

Sets StackedBar.CountColumn: Layout of the legend count column (default right-aligned; reserves the digits of the overall total).

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

StackedBar The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.StackedBar { CountColumn = value };    stackedBar.CountColumn(value);
public static StackedBar CountColumn(StackedBar stackedBar, Action<ColumnFormat> configure) #

Configures StackedBar.CountColumn in place: Layout of the legend count column (default right-aligned; reserves the digits of the overall total).

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

StackedBar The same instance.
public static ProgressOptions CountColumn(ProgressOptions progressOptions, ColumnFormat? value) #

Sets ProgressOptions.CountColumn: The numeric count format.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value ConsoleMonster.Layout.ColumnFormat? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { CountColumn = value };    Ui.Progress().CountColumn(value);
public static ProgressOptions CountColumn(ProgressOptions progressOptions, Action<ColumnFormat> configure) #

Configures ProgressOptions.CountColumn in place: The numeric count format.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

ProgressOptions The same instance.
public static ChartOptions CountColumn(ChartOptions chartOptions, ColumnFormat? value) #

Sets ChartOptions.CountColumn: The stacked numeric-column format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value ConsoleMonster.Layout.ColumnFormat? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { CountColumn = value };    Ui.Chart().CountColumn(value);
public static ChartOptions CountColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #

Configures ChartOptions.CountColumn in place: The stacked numeric-column format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

ChartOptions The same instance.
CountSkipped 2 overloads
public static Lanes CountSkipped(Lanes lanes, bool value) #

Sets 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 required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Lanes { CountSkipped = value };    Ui.Lanes().CountSkipped(value);
public static Lanes CountSkipped(Lanes lanes) #

Sets Lanes.CountSkipped to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
Critical 2 overloads
public static BarChart Critical(BarChart barChart, double? value) #

Sets BarChart.Critical: The value from which a bar is critical (fail colour), or null. See BarChart.Warning.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value double? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.BarChart { Critical = value };    barChart.Critical(value);
public static ChartOptions Critical(ChartOptions chartOptions, double? value) #

Sets ChartOptions.Critical: The critical threshold.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value double? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Critical = value };    Ui.Chart().Critical(value);
public static Calendar Culture(Calendar calendar, CultureInfo? value) #

Sets Calendar.Culture: Explicit display culture; null uses the render context. Arithmetic and displayed years remain Gregorian.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance.
value System.Globalization.CultureInfo? required
The value.

Returns

Calendar The same instance.

Examples

// C# initializer or property    // C# fluent
calendar.Culture = value;        Ui.Calendar().Culture(value);
public static TreeHierarchyOptions Depth(TreeHierarchyOptions treeHierarchyOptions, int value) #

Sets TreeHierarchyOptions.Depth: How many levels of children are followed below each top-level item (default 5; 0 shows only the items).

Parameters

treeHierarchyOptions ConsoleMonster.Widgets.TreeHierarchyOptions required
The instance.
value int required
The value.

Returns

TreeHierarchyOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { Depth = value };    treeHierarchyOptions.Depth(value);
Detail 6 overloads
public static Dashboard Detail(Dashboard dashboard, string? value) #

Sets Dashboard.Detail: A status shown on the right of the header (markup).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
value string? required
The value.

Returns

Dashboard The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Dashboard { Detail = value };    Ui.Dashboard().Detail(value);
public static HeaderBar Detail(HeaderBar headerBar, string? value) #

Sets HeaderBar.Detail: Status text on the right (markup).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
value string? required
The value.

Returns

HeaderBar The same instance.

Examples

// C# initializer or property    // C# fluent
headerBar.Detail = value;        Ui.HeaderBar().Detail(value);
public static Spinner Detail(Spinner spinner, string? value) #

Sets Spinner.Detail: Muted detail shown after the label, for example the current item.

Parameters

spinner ConsoleMonster.Widgets.Spinner required
The instance.
value string? required
The value.

Returns

Spinner The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.Spinner { Detail = value };    spinner.Detail(value);
public static ProgressOptions Detail(ProgressOptions progressOptions, string? value) #

Sets ProgressOptions.Detail: The indeterminate indicator detail.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value string? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Detail = value };    Ui.Progress().Detail(value);
public static Lane Detail(Lane lane, string? value) #

Sets Lane.Detail: What the lane is doing now (current rule, step, file); literal, and setting it clears Lane.DetailText.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value string? required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Detail = value;             lane.Detail(value);
public static TreeNode Detail(TreeNode treeNode, string? value) #

Sets TreeNode.Detail: A muted detail shown after the label (counts, values), or null.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value string? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Detail = value;         treeNode.Detail(value);
DetailColumn 2 overloads
public static StatusList DetailColumn(StatusList statusList, ColumnFormat value) #

Sets StatusList.DetailColumn: Layout of the detail column on the right (default right-aligned). All rows share its width, which never shrinks during a session, so labels keep their room as details change.

Parameters

statusList ConsoleMonster.Widgets.StatusList required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

StatusList The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.StatusList { DetailColumn = value };    Ui.StatusList().DetailColumn(value);
public static StatusList DetailColumn(StatusList statusList, Action<ColumnFormat> configure) #

Configures StatusList.DetailColumn in place: Layout of the detail column on the right (default right-aligned). All rows share its width, which never shrinks during a session, so labels keep their room as details change.

Parameters

statusList ConsoleMonster.Widgets.StatusList required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

StatusList The same instance.
public static ExceptionView DetailsHint(ExceptionView exceptionView, string? value) #

Sets ExceptionView.DetailsHint: A muted next-step hint, or null for no hint.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value string? required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property         // C# fluent
exceptionView.DetailsHint = value;    exceptionView.DetailsHint(value);
DetailText 2 overloads
public static Lane DetailText(Lane lane, RichText? value) #

Sets Lane.DetailText: A multicolour detail, or null for the literal Lane.Detail (which becomes its plain text).

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value ConsoleMonster.Text.RichText? required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.DetailText = value;         lane.DetailText(value);
public static Lane DetailText(Lane lane, Action<RichText> configure) #

Configures Lane.DetailText in place: A multicolour detail, or null for the literal Lane.Detail (which becomes its plain text).

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
configure System.Action<ConsoleMonster.Text.RichText> required
Configures the value.

Returns

Lane The same instance.
DetectRepeatedNodes 4 overloads
public static Tree DetectRepeatedNodes(Tree tree, bool value) #

Sets Tree.DetectRepeatedNodes: Mark identities seen on earlier branches as shown above instead of expanding them again.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value bool required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.Tree { DetectRepeatedNodes = value };    Ui.Tree().DetectRepeatedNodes(value);
public static Tree DetectRepeatedNodes(Tree tree) #

Sets Tree.DetectRepeatedNodes to true.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance to configure.

Returns

Tree The same instance.
public static TreeHierarchyOptions DetectRepeatedNodes(TreeHierarchyOptions treeHierarchyOptions, bool value) #

Sets TreeHierarchyOptions.DetectRepeatedNodes: Suppress identities already shown on another branch, using explicit repeat markers (default false).

Parameters

treeHierarchyOptions ConsoleMonster.Widgets.TreeHierarchyOptions required
The instance.
value bool required
The value.

Returns

TreeHierarchyOptions The same instance.

Examples

// C# initializer or property                                                               // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { DetectRepeatedNodes = value };    treeHierarchyOptions.DetectRepeatedNodes(value);
public static TreeHierarchyOptions DetectRepeatedNodes(TreeHierarchyOptions treeHierarchyOptions) #

Sets TreeHierarchyOptions.DetectRepeatedNodes to true.

Parameters

treeHierarchyOptions ConsoleMonster.Widgets.TreeHierarchyOptions required
The instance to configure.

Returns

TreeHierarchyOptions The same instance.
Differences 2 overloads
public static WatchView Differences(WatchView watchView, bool value) #

Sets WatchView.Differences: Whether values that changed since the previous run are highlighted (bold on a soft surface; a marker without colour).

Parameters

watchView ConsoleMonster.Widgets.WatchView required
The instance.
value bool required
The value.

Returns

WatchView The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.WatchView { Differences = value };    watchView.Differences(value);
public static WatchView Differences(WatchView watchView) #

Sets WatchView.Differences to true.

Parameters

watchView ConsoleMonster.Widgets.WatchView required
The instance to configure.

Returns

WatchView The same instance.
DimPending 2 overloads
public static Lanes DimPending(Lanes lanes, bool value) #

Sets Lanes.DimPending: Whether a waiting (pending) lane's label is dimmed (default true).

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Lanes { DimPending = value };    Ui.Lanes().DimPending(value);
public static Lanes DimPending(Lanes lanes) #

Sets Lanes.DimPending to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
DimRepeats 2 overloads
public static TableColumn DimRepeats(TableColumn tableColumn, bool value) #

Sets TableColumn.DimRepeats: Whether consecutive repeated values of this key are muted while remaining copyable.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value bool required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property      // C# fluent
tableColumn.DimRepeats = value;    tableColumn.DimRepeats(value);
public static TableColumn DimRepeats(TableColumn tableColumn) #

Sets TableColumn.DimRepeats to true.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance to configure.

Returns

TableColumn The same instance.
Dirty 2 overloads
public static ShellPrompt Dirty(ShellPrompt shellPrompt, bool value) #

Sets ShellPrompt.Dirty: Whether git reported working tree or index changes.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance.
value bool required
The value.

Returns

ShellPrompt The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ShellPrompt { Dirty = value };    shellPrompt.Dirty(value);
public static ShellPrompt Dirty(ShellPrompt shellPrompt) #

Sets ShellPrompt.Dirty to true.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance to configure.

Returns

ShellPrompt The same instance.
public static SummaryBar DoneLabel(SummaryBar summaryBar, string? value) #

Sets SummaryBar.DoneLabel: The label for the count done while the total is unknown, with {0} for the count, or null (default) for "{0} done".

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar required
The instance.
value string? required
The value.

Returns

SummaryBar The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.SummaryBar { DoneLabel = value };    Ui.SummaryBar().DoneLabel(value);
public static ShellPrompt Duration(ShellPrompt shellPrompt, TimeSpan value) #

Sets ShellPrompt.Duration: The last completed command's duration. Only values strictly above two seconds are shown.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance.
value System.TimeSpan required
The value.

Returns

ShellPrompt The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.ShellPrompt { Duration = value };    shellPrompt.Duration(value);
public static ChartOptions Edges(ChartOptions chartOptions, double[]? value) #

Sets ChartOptions.Edges: Strictly ascending histogram bucket edges.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value double[]? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Edges = value };    Ui.Chart().Edges(value);
Elapsed 2 overloads
public static HeaderBar Elapsed(HeaderBar headerBar, TimeSpan? value) #

Sets HeaderBar.Elapsed: The clock value; null uses the render context's elapsed time.

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
value System.TimeSpan? required
The value.

Returns

HeaderBar The same instance.

Examples

// C# initializer or property    // C# fluent
headerBar.Elapsed = value;       Ui.HeaderBar().Elapsed(value);
public static SummaryBar Elapsed(SummaryBar summaryBar, TimeSpan? value) #

Sets SummaryBar.Elapsed: The elapsed time to estimate from, or null (default) for the time since the first progress: on the live session's clock while the bar is drawn in a session, real time otherwise.

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar required
The instance.
value System.TimeSpan? required
The value.

Returns

SummaryBar The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.SummaryBar { Elapsed = value };    Ui.SummaryBar().Elapsed(value);
public static Logo EndColor(Logo logo, Color value) #

Sets Logo.EndColor: The gradient end colour (default violet).

Parameters

logo ConsoleMonster.Widgets.Logo required
The instance.
value ConsoleMonster.Styling.Color required
The value.

Returns

Logo The same instance.

Examples

// C# initializer or property    // C# fluent
logo.EndColor = value;           Ui.Logo().EndColor(value);
Expand``1 2 overloads
public static TSelf Expand<TSelf>(TSelf table, bool value) #

Sets Table.Expand: Whether the table fills the available width: the free-text columns share the spare width in proportion to their widths, unless columns set TableColumn.Weight or TableColumn.Flexible; number, date and status columns keep their natural width.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Widgets.Table { Expand = value };    Ui.Table().Expand(value);
public static TSelf Expand<TSelf>(TSelf table) #

Sets Table.Expand to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
public static Lane Failed(Lane lane, int value) #

Sets Lane.Failed: Steps that failed.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value int required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Failed = value;             lane.Failed(value);
Finished 3 overloads
public static Spinner Finished(Spinner spinner, TimeSpan? value) #

Sets Spinner.Finished: When the spinner finished on the session clock, or null while running.

Parameters

spinner ConsoleMonster.Widgets.Spinner required
The instance.
value System.TimeSpan? required
The value.

Returns

Spinner The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Spinner { Finished = value };    spinner.Finished(value);
public static ProgressOptions Finished(ProgressOptions progressOptions, TimeSpan? value) #

Sets ProgressOptions.Finished: Initial indeterminate completion time on the session clock; null leaves it unfinished.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value System.TimeSpan? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Finished = value };    Ui.Progress().Finished(value);
public static Lane Finished(Lane lane, TimeSpan? value) #

Sets Lane.Finished: When the lane finished (session time), if it has.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value System.TimeSpan? required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Finished = value;           lane.Finished(value);
public static Calendar FirstDayOfWeek(Calendar calendar, DayOfWeek? value) #

Sets Calendar.FirstDayOfWeek: Override for the culture's first day of week.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance.
value System.DayOfWeek? required
The value.

Returns

Calendar The same instance.

Examples

// C# initializer or property       // C# fluent
calendar.FirstDayOfWeek = value;    Ui.Calendar().FirstDayOfWeek(value);
public static CodeView FirstLine(CodeView codeView, int value) #

Sets CodeView.FirstLine: The number of the first line (default 1), for excerpts.

Parameters

codeView ConsoleMonster.Widgets.CodeView required
The instance.
value int required
The value.

Returns

CodeView The same instance.

Examples

// C# initializer or property    // C# fluent
codeView.FirstLine = value;      codeView.FirstLine(value);
FixedSlots 2 overloads
public static FooterBar FixedSlots(FooterBar footerBar, bool value) #

Sets FooterBar.FixedSlots: Keeps every registry entry in a fixed slot, shortening labels rather than hiding unavailable or trailing commands.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
value bool required
The value.

Returns

FooterBar The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.FooterBar { FixedSlots = value };    Ui.FooterBar().FixedSlots(value);
public static FooterBar FixedSlots(FooterBar footerBar) #

Sets FooterBar.FixedSlots to true.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance to configure.

Returns

FooterBar The same instance.
Flexible 2 overloads
public static TableColumn Flexible(TableColumn tableColumn, bool value) #

Sets TableColumn.Flexible: Whether this column takes spare width when the table expands (the main text column). Flexible columns share it evenly.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value bool required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Flexible = value;    tableColumn.Flexible(value);
public static TableColumn Flexible(TableColumn tableColumn) #

Sets TableColumn.Flexible to true.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance to configure.

Returns

TableColumn The same instance.
Footer 2 overloads
Gap 4 overloads
public static CellMap Gap(CellMap cellMap, int value) #

Sets CellMap.Gap: The cells between symbols (default 1).

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
value int required
The value.

Returns

CellMap The same instance.

Examples

// C# initializer or property                                  // C# fluent
new global::ConsoleMonster.Widgets.CellMap { Gap = value };    Ui.CellMap().Gap(value);
public static KeyValueList Gap(KeyValueList keyValueList, int value) #

Sets KeyValueList.Gap: Cells between the key column and the values (default 2).

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
value int required
The value.

Returns

KeyValueList The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.KeyValueList { Gap = value };    Ui.KeyValue().Gap(value);
public static LayoutRegions Gap(LayoutRegions layoutRegions, int value) #

Sets LayoutRegions.Gap: The gap in cells between regions.

Parameters

layoutRegions ConsoleMonster.Widgets.LayoutRegions required
The instance.
value int required
The value.

Returns

LayoutRegions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.LayoutRegions { Gap = value };    Ui.LayoutRegions().Gap(value);
public static TableColumn Gap(TableColumn tableColumn, int? value) #

Sets TableColumn.Gap: Optional cells before this column in an unboxed table; the first visible column has no gap.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Gap = value;         tableColumn.Gap(value);
public static TSelf GroupGap<TSelf>(TSelf table, int value) #

Sets Table.GroupGap: Blank lines before each group after the first (default zero).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value int required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.Table { GroupGap = value };    Ui.Table().GroupGap(value);
GroupHeadersAsRows``1 2 overloads
public static TSelf GroupHeadersAsRows<TSelf>(TSelf table, bool value) #

Sets Table.GroupHeadersAsRows: Whether group labels occupy full-width section rows instead of labelled border rules (default false).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.Table { GroupHeadersAsRows = value };    Ui.Table().GroupHeadersAsRows(value);
public static TSelf GroupHeadersAsRows<TSelf>(TSelf table) #

Sets Table.GroupHeadersAsRows to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
Header 2 overloads
public static ConsoleViewFrame Header(ConsoleViewFrame consoleViewFrame, Action<ViewHeader> configure) #

Configures ConsoleViewFrame.Header in place: The title line.

Parameters

consoleViewFrame ConsoleMonster.Widgets.ConsoleViewFrame required
The instance.
configure System.Action<ConsoleMonster.Widgets.ViewHeader> required
Configures the value.

Returns

ConsoleViewFrame The same instance.
public static TableColumn Header(TableColumn tableColumn, string value) #

Sets TableColumn.Header: The header (markup).

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value string required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Header = value;      tableColumn.Header(value);
public static TableColumn HeaderAlignment(TableColumn tableColumn, HorizontalAlignment? value) #

Sets TableColumn.HeaderAlignment: Optional header alignment independent of the cell values.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value ConsoleMonster.Layout.HorizontalAlignment? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property           // C# fluent
tableColumn.HeaderAlignment = value;    tableColumn.HeaderAlignment(value);
public static HeaderBar HeaderRight(HeaderBar headerBar, string? value) #

Sets HeaderBar.HeaderRight: Plain text on the right, before the clock (an app's subtitle, a step count).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
value string? required
The value.

Returns

HeaderBar The same instance.

Examples

// C# initializer or property     // C# fluent
headerBar.HeaderRight = value;    Ui.HeaderBar().HeaderRight(value);
HeaderSeparator``1 2 overloads
public static TSelf HeaderSeparator<TSelf>(TSelf table, bool value) #

Sets Table.HeaderSeparator: Whether a separator row is drawn under the header (default true). When false the header is underlined instead, so data starts on the row directly below it.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.Table { HeaderSeparator = value };    Ui.Table().HeaderSeparator(value);
public static TSelf HeaderSeparator<TSelf>(TSelf table) #

Sets Table.HeaderSeparator to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
public static ConsoleViewFrame Headline(ConsoleViewFrame consoleViewFrame, IWidget? value) #

Sets ConsoleViewFrame.Headline: An optional headline directly beneath the title.

Parameters

consoleViewFrame ConsoleMonster.Widgets.ConsoleViewFrame required
The instance.
value ConsoleMonster.Layout.IWidget? required
The value.

Returns

ConsoleViewFrame The same instance.

Examples

// C# initializer or property         // C# fluent
consoleViewFrame.Headline = value;    consoleViewFrame.Headline(value);
Height 4 overloads
public static Histogram Height(Histogram histogram, int value) #

Sets Histogram.Height: Rows for the bars (default 6).

Parameters

histogram ConsoleMonster.Widgets.Histogram required
The instance.
value int required
The value.

Returns

Histogram The same instance.

Examples

// C# initializer or property    // C# fluent
histogram.Height = value;        histogram.Height(value);
public static LineChart Height(LineChart lineChart, int value) #

Sets LineChart.Height: Rows for the plot including the x axis (default 8).

Parameters

lineChart ConsoleMonster.Widgets.LineChart required
The instance.
value int required
The value.

Returns

LineChart The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.LineChart { Height = value };    lineChart.Height(value);
public static Sparkline Height(Sparkline sparkline, int value) #

Sets Sparkline.Height: Rows (default 1).

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance.
value int required
The value.

Returns

Sparkline The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Sparkline { Height = value };    sparkline.Height(value);
public static ChartOptions Height(ChartOptions chartOptions, int? value) #

Sets ChartOptions.Height: The plot height; omitted uses the selected kind default.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value int? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Height = value };    Ui.Chart().Height(value);
HideCompleted 2 overloads
public static Lanes HideCompleted(Lanes lanes, bool value) #

Sets 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 required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Lanes { HideCompleted = value };    Ui.Lanes().HideCompleted(value);
public static Lanes HideCompleted(Lanes lanes) #

Sets Lanes.HideCompleted to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
HideEmpty 2 overloads
public static RecordView HideEmpty(RecordView recordView, bool value) #

Sets RecordView.HideEmpty: Whether empty values (null, empty text) are left out (default true).

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance.
value bool required
The value.

Returns

RecordView The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.RecordView { HideEmpty = value };    recordView.HideEmpty(value);
public static RecordView HideEmpty(RecordView recordView) #

Sets RecordView.HideEmpty to true.

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance to configure.

Returns

RecordView The same instance.
HighlightSharedHops 2 overloads
public static PathSet HighlightSharedHops(PathSet pathSet, bool value) #

Sets PathSet.HighlightSharedHops: Mark hops present in more than one distinct chain with an asterisk and a legend.

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance.
value bool required
The value.

Returns

PathSet The same instance.

Examples

// C# initializer or property           // C# fluent
pathSet.HighlightSharedHops = value;    pathSet.HighlightSharedHops(value);
public static PathSet HighlightSharedHops(PathSet pathSet) #

Sets PathSet.HighlightSharedHops to true.

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance to configure.

Returns

PathSet The same instance.
public static LogRegion HighlightText(LogRegion logRegion, string? value) #

Sets LogRegion.HighlightText: Literal ordinal case-insensitive substring to emphasize in plain-text entries; null or empty disables it.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value string? required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { HighlightText = value };    Ui.LogRegion().HighlightText(value);
public static ShellPrompt Home(ShellPrompt shellPrompt, string? value) #

Sets ShellPrompt.Home: The home directory, abbreviated only at a complete path boundary.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance.
value string? required
The value.

Returns

ShellPrompt The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.ShellPrompt { Home = value };    shellPrompt.Home(value);
public static TreeNode Identity(TreeNode treeNode, object? value) #

Sets TreeNode.Identity: An optional stable identity for cycle and repeated-node detection; null uses node reference identity.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value object? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Identity = value;       treeNode.Identity(value);
public static TreeHierarchyOptions IdentityComparer(TreeHierarchyOptions treeHierarchyOptions, IEqualityComparer<object>? value) #

Sets TreeHierarchyOptions.IdentityComparer: An optional identity comparer. Null preserves reference identity, including for custom identities.

Parameters

treeHierarchyOptions ConsoleMonster.Widgets.TreeHierarchyOptions required
The instance.
value System.Collections.Generic.IEqualityComparer<object>? required
The value.

Returns

TreeHierarchyOptions The same instance.

Examples

// C# initializer or property                                                            // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { IdentityComparer = value };    treeHierarchyOptions.IdentityComparer(value);
public static FooterBar Indent(FooterBar footerBar, int value) #

Sets FooterBar.Indent: The first column (default 1).

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
value int required
The value.

Returns

FooterBar The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.FooterBar { Indent = value };    Ui.FooterBar().Indent(value);
public static RecordView IndentWidth(RecordView recordView, int value) #

Sets RecordView.IndentWidth: Cells each nesting level indents (default 2).

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance.
value int required
The value.

Returns

RecordView The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.RecordView { IndentWidth = value };    recordView.IndentWidth(value);
Indeterminate 2 overloads
public static ProgressOptions Indeterminate(ProgressOptions progressOptions, bool value) #

Sets ProgressOptions.Indeterminate: Creates an indicator for work without a known total.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value bool required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Indeterminate = value };    Ui.Progress().Indeterminate(value);
public static ProgressOptions Indeterminate(ProgressOptions progressOptions) #

Sets ProgressOptions.Indeterminate to true.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance to configure.

Returns

ProgressOptions The same instance.
InlineAxes 2 overloads
public static Matrix InlineAxes(Matrix matrix, bool value) #

Sets Matrix.InlineAxes: Use inline axis captions, a left band column and the full/short/numbered fit chain.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value bool required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.InlineAxes = value;       matrix.InlineAxes(value);
public static Matrix InlineAxes(Matrix matrix) #

Sets Matrix.InlineAxes to true.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance to configure.

Returns

Matrix The same instance.
KeepAllColumns``1 2 overloads
public static TSelf KeepAllColumns<TSelf>(TSelf table, bool value) #

Sets Table.KeepAllColumns: Keep all columns by rendering consecutive grids with the key repeated when the full grid cannot fit.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.Table { KeepAllColumns = value };    Ui.Table().KeepAllColumns(value);
public static TSelf KeepAllColumns<TSelf>(TSelf table) #

Sets Table.KeepAllColumns to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
KeepLast 2 overloads
public static FooterBar KeepLast(FooterBar footerBar, bool value) #

Sets FooterBar.KeepLast: Keeps the last hint (the key map) when others have to be dropped.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
value bool required
The value.

Returns

FooterBar The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.FooterBar { KeepLast = value };    Ui.FooterBar().KeepLast(value);
public static FooterBar KeepLast(FooterBar footerBar) #

Sets FooterBar.KeepLast to true.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance to configure.

Returns

FooterBar The same instance.
Key 3 overloads
public static TableColumn Key(TableColumn tableColumn, string? value) #

Sets TableColumn.Key: An identifier for the column (a property name), or null to use the header.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value string? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Key = value;         tableColumn.Key(value);
public static TableColumn Key(TableColumn tableColumn, bool value) #

Sets TableColumn.IsKey: Whether this is a key column: it never hides, and it titles the record cards.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value bool required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.IsKey = value;       tableColumn.Key(value);
public static TableColumn Key(TableColumn tableColumn) #

Sets TableColumn.IsKey to true.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance to configure.

Returns

TableColumn The same instance.
public static LiveTable KeyProperty(LiveTable liveTable, string? value) #

Sets LiveTable.KeyProperty: The input field used as the row key; null uses the first column's key or header.

Parameters

liveTable ConsoleMonster.Widgets.LiveTable required
The instance.
value string? required
The value.

Returns

LiveTable The same instance.

Examples

// C# initializer or property     // C# fluent
liveTable.KeyProperty = value;    liveTable.KeyProperty(value);
public static KeyValueList KeyRole(KeyValueList keyValueList, ThemeToken value) #

Sets KeyValueList.KeyRole: Theme colour for keys.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
value ConsoleMonster.Styling.ThemeToken required
The value.

Returns

KeyValueList The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.KeyValueList { KeyRole = value };    Ui.KeyValue().KeyRole(value);
Label 6 overloads
public static ProgressBar Label(ProgressBar progressBar, string value) #

Sets ProgressBar.Label: The label (markup).

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value string required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { Label = value };    progressBar.Label(value);
public static Spinner Label(Spinner spinner, string value) #

Sets Spinner.Label: The label (markup).

Parameters

spinner ConsoleMonster.Widgets.Spinner required
The instance.
value string required
The value.

Returns

Spinner The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.Spinner { Label = value };    spinner.Label(value);
public static ProgressOptions Label(ProgressOptions progressOptions, string value) #

Sets ProgressOptions.Label: The label, including supported markup.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value string required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Label = value };    Ui.Progress().Label(value);
public static ChartSeries Label(ChartSeries chartSeries, string value) #

Sets ChartSeries.Label: Visible legend text, independently of the series key.

Parameters

chartSeries ConsoleMonster.Widgets.ChartSeries required
The instance.
value string required
The value.

Returns

ChartSeries The same instance.

Examples

// C# initializer or property    // C# fluent
chartSeries.Label = value;       chartSeries.Label(value);
public static Lane Label(Lane lane, string value) #

Sets Lane.Label: Display label (literal; setting it clears Lane.LabelText).

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value string required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Label = value;              lane.Label(value);
public static TreeNode Label(TreeNode treeNode, string value) #

Sets TreeNode.Label: The label (markup).

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value string required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Label = value;          treeNode.Label(value);
LabelColumn 4 overloads
public static StackedBar LabelColumn(StackedBar stackedBar, ColumnFormat value) #

Sets StackedBar.LabelColumn: Layout of the legend label column (default left-aligned).

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

StackedBar The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.StackedBar { LabelColumn = value };    stackedBar.LabelColumn(value);
public static StackedBar LabelColumn(StackedBar stackedBar, Action<ColumnFormat> configure) #

Configures StackedBar.LabelColumn in place: Layout of the legend label column (default left-aligned).

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

StackedBar The same instance.
public static ChartOptions LabelColumn(ChartOptions chartOptions, ColumnFormat? value) #

Sets ChartOptions.LabelColumn: The stacked legend-label format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value ConsoleMonster.Layout.ColumnFormat? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { LabelColumn = value };    Ui.Chart().LabelColumn(value);
public static ChartOptions LabelColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #

Configures ChartOptions.LabelColumn in place: The stacked legend-label format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

ChartOptions The same instance.
public static BarChart LabelHeader(BarChart barChart, string? value) #

Sets BarChart.LabelHeader: Optional label-column heading; any heading enables a segmented table header.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value string? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.BarChart { LabelHeader = value };    barChart.LabelHeader(value);
LabelText 6 overloads
public static ChartItem LabelText(ChartItem chartItem, RichText? value) #

Sets ChartItem.LabelText: A multicolour label shown instead of ChartItem.Label (which stays the key), or null.

Parameters

chartItem ConsoleMonster.Widgets.ChartItem required
The instance.
value ConsoleMonster.Text.RichText? required
The value.

Returns

ChartItem The same instance.

Examples

// C# initializer or property    // C# fluent
chartItem.LabelText = value;     chartItem.LabelText(value);
public static ChartItem LabelText(ChartItem chartItem, Action<RichText> configure) #

Configures ChartItem.LabelText in place: A multicolour label shown instead of ChartItem.Label (which stays the key), or null.

Parameters

chartItem ConsoleMonster.Widgets.ChartItem required
The instance.
configure System.Action<ConsoleMonster.Text.RichText> required
Configures the value.

Returns

ChartItem The same instance.
public static ChartSeries LabelText(ChartSeries chartSeries, RichText? value) #

Sets ChartSeries.LabelText: A multicolour legend name shown instead of ChartSeries.Key (which stays the key), or null.

Parameters

chartSeries ConsoleMonster.Widgets.ChartSeries required
The instance.
value ConsoleMonster.Text.RichText? required
The value.

Returns

ChartSeries The same instance.

Examples

// C# initializer or property     // C# fluent
chartSeries.LabelText = value;    chartSeries.LabelText(value);
public static ChartSeries LabelText(ChartSeries chartSeries, Action<RichText> configure) #

Configures ChartSeries.LabelText in place: A multicolour legend name shown instead of ChartSeries.Key (which stays the key), or null.

Parameters

chartSeries ConsoleMonster.Widgets.ChartSeries required
The instance.
configure System.Action<ConsoleMonster.Text.RichText> required
Configures the value.

Returns

ChartSeries The same instance.
public static Lane LabelText(Lane lane, RichText? value) #

Sets Lane.LabelText: A multicolour label, or null for the literal Lane.Label (which becomes its plain text).

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value ConsoleMonster.Text.RichText? required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.LabelText = value;          lane.LabelText(value);
public static Lane LabelText(Lane lane, Action<RichText> configure) #

Configures Lane.LabelText in place: A multicolour label, or null for the literal Lane.Label (which becomes its plain text).

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
configure System.Action<ConsoleMonster.Text.RichText> required
Configures the value.

Returns

Lane The same instance.
LabelWidth 2 overloads
public static ProgressBar LabelWidth(ProgressBar progressBar, int? value) #

Sets ProgressBar.LabelWidth: A fixed label column width, or null to fit the label.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value int? required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { LabelWidth = value };    progressBar.LabelWidth(value);
public static ProgressOptions LabelWidth(ProgressOptions progressOptions, int? value) #

Sets ProgressOptions.LabelWidth: The fixed label width, when supplied.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value int? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { LabelWidth = value };    Ui.Progress().LabelWidth(value);
public static CellMap LegendLines(CellMap cellMap, int value) #

Sets CellMap.LegendLines: The most lines the legend wraps onto when it is wider than the map (default 1: it is cut off instead).

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
value int required
The value.

Returns

CellMap The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.CellMap { LegendLines = value };    Ui.CellMap().LegendLines(value);
LevelColumn 2 overloads
public static LogRegion LevelColumn(LogRegion logRegion, ColumnFormat value) #

Sets LogRegion.LevelColumn: Layout of the level column (ERR, WARN, VERB...). Every row shares its width, including info lines that have no tag, so messages always start in the same column; the width never shrinks during a session.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { LevelColumn = value };    Ui.LogRegion().LevelColumn(value);
public static LogRegion LevelColumn(LogRegion logRegion, Action<ColumnFormat> configure) #

Configures LogRegion.LevelColumn in place: Layout of the level column (ERR, WARN, VERB...). Every row shares its width, including info lines that have no tag, so messages always start in the same column; the width never shrinks during a session.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

LogRegion The same instance.
LineNumbers 2 overloads
public static CodeView LineNumbers(CodeView codeView, bool value) #

Sets CodeView.LineNumbers: Shows line numbers.

Parameters

codeView ConsoleMonster.Widgets.CodeView required
The instance.
value bool required
The value.

Returns

CodeView The same instance.

Examples

// C# initializer or property    // C# fluent
codeView.LineNumbers = value;    codeView.LineNumbers(value);
public static CodeView LineNumbers(CodeView codeView) #

Sets CodeView.LineNumbers to true.

Parameters

codeView ConsoleMonster.Widgets.CodeView required
The instance to configure.

Returns

CodeView The same instance.
public static Rule LineRole(Rule rule, ThemeToken value) #

Sets Rule.LineRole: The line's theme role (default ThemeToken.Border).

Parameters

rule ConsoleMonster.Widgets.Rule required
The instance.
value ConsoleMonster.Styling.ThemeToken required
The value.

Returns

Rule The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.Rule { LineRole = value };    Ui.Rule().LineRole(value);
public static Rule LineStyle(Rule rule, BoxStyle? value) #

Sets Rule.LineStyle: The line's box style, or null to use the glyph profile's ordinary rule line.

Parameters

rule ConsoleMonster.Widgets.Rule required
The instance.
value ConsoleMonster.Glyphs.BoxStyle? required
The value.

Returns

Rule The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.Rule { LineStyle = value };    Ui.Rule().LineStyle(value);
public static Matrix ListDirection(Matrix matrix, string? value) #

Sets Matrix.ListDirection: An optional literal connector between row and column identities in lists; null retains a slash.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.ListDirection = value;    matrix.ListDirection(value);
public static RunDashboard Log(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 required
The instance.
configure System.Action<ConsoleMonster.Widgets.LogRegion> required
Configures the value.

Returns

RunDashboard The same instance.
LogPaused 2 overloads
public static RunDashboard LogPaused(RunDashboard runDashboard, bool value) #

Sets RunDashboard.LogPaused: Whether completion lines are temporarily held.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance.
value bool required
The value.

Returns

RunDashboard The same instance.

Examples

// C# initializer or property      // C# fluent
runDashboard.LogPaused = value;    runDashboard.LogPaused(value);
public static RunDashboard LogPaused(RunDashboard runDashboard) #

Sets RunDashboard.LogPaused to true.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance to configure.

Returns

RunDashboard The same instance.
Marker 2 overloads
public static TableRowRole Marker(TableRowRole tableRowRole, string? value) #

Sets TableRowRole.Marker: A plain text marker for RoleTable's dedicated marker column.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance.
value string? required
The value.

Returns

TableRowRole The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.TableRowRole { Marker = value };    tableRowRole.Marker(value);
public static TreeNode Marker(TreeNode treeNode, string? value) #

Sets TreeNode.Marker: An optional plain text glyph replacing the status glyph, without changing the node's status tone.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value string? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Marker = value;         treeNode.Marker(value);
MarkerTone 2 overloads
public static TableRowRole MarkerTone(TableRowRole tableRowRole, ThemeToken? value) #

Sets TableRowRole.MarkerTone: Optional marker-only role, without changing the rest of the row.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

TableRowRole The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.TableRowRole { MarkerTone = value };    tableRowRole.MarkerTone(value);
public static TreeNode MarkerTone(TreeNode treeNode, ThemeToken? value) #

Sets TreeNode.MarkerTone: An optional theme tone for the marker, independent of status semantics. Null preserves the status or text tone.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.MarkerTone = value;     treeNode.MarkerTone(value);
Markup 2 overloads
public static TextBlock Markup(TextBlock textBlock, bool value) #

Sets TextBlock.IsMarkup: Whether TextBlock.Content is markup (default true).

Parameters

textBlock ConsoleMonster.Widgets.TextBlock required
The instance.
value bool required
The value.

Returns

TextBlock The same instance.

Examples

// C# initializer or property    // C# fluent
textBlock.IsMarkup = value;      Ui.Text().Markup().Markup(value);
public static TextBlock Markup(TextBlock textBlock) #

Sets TextBlock.IsMarkup to true.

Parameters

textBlock ConsoleMonster.Widgets.TextBlock required
The instance to configure.

Returns

TextBlock The same instance.
public static RunView MaxCellRows(RunView runView, int value) #

Sets RunView.MaxCellRows: The most rows of item cells (default 4).

Parameters

runView ConsoleMonster.Widgets.RunView required
The instance.
value int required
The value.

Returns

RunView The same instance.

Examples

// C# initializer or property    // C# fluent
runView.MaxCellRows = value;     runView.MaxCellRows(value);
public static ScrollView MaxContentHeight(ScrollView scrollView, int value) #

Sets ScrollView.MaxContentHeight: Maximum rows composed for non-virtualized content. Use a list, grid or log for larger data.

Parameters

scrollView ConsoleMonster.Widgets.ScrollView required
The instance.
value int required
The value.

Returns

ScrollView The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Widgets.ScrollView { MaxContentHeight = value };    Ui.ScrollView().MaxContentHeight(value);
public static RunView MaxFailures(RunView runView, int value) #

Sets RunView.MaxFailures: The most failures listed while the run goes on (default 3); more are counted.

Parameters

runView ConsoleMonster.Widgets.RunView required
The instance.
value int required
The value.

Returns

RunView The same instance.

Examples

// C# initializer or property    // C# fluent
runView.MaxFailures = value;     runView.MaxFailures(value);
public static RunView MaxFailuresWhenDone(RunView runView, int value) #

Sets 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 required
The instance.
value int required
The value.

Returns

RunView The same instance.

Examples

// C# initializer or property           // C# fluent
runView.MaxFailuresWhenDone = value;    runView.MaxFailuresWhenDone(value);
public static ExceptionView MaxFrames(ExceptionView exceptionView, int value) #

Sets ExceptionView.MaxFrames: The most app frames shown per error (default 8); the rest are counted.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value int required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property       // C# fluent
exceptionView.MaxFrames = value;    exceptionView.MaxFrames(value);
public static Matrix MaxGridSize(Matrix matrix, int value) #

Sets Matrix.MaxGridSize: The largest axis allowed in grid mode (default 16). Larger axes use the attention list.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value int required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.MaxGridSize = value;      matrix.MaxGridSize(value);
public static PathSet MaxHops(PathSet pathSet, int value) #

Sets PathSet.MaxHops: The maximum accepted hops per chain, excluding the origin (default 100).

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance.
value int required
The value.

Returns

PathSet The same instance.

Examples

// C# initializer or property    // C# fluent
pathSet.MaxHops = value;         pathSet.MaxHops(value);
Maximum 5 overloads
public static BarChart Maximum(BarChart barChart, double? value) #

Sets BarChart.Maximum: The value of a full bar, or null for the largest item. Non-finite maxima use the largest finite item; a negative maximum is treated as zero, so signed bars always include their zero baseline.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value double? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.BarChart { Maximum = value };    barChart.Maximum(value);
public static LineChart Maximum(LineChart lineChart, double? value) #

Sets LineChart.Maximum: A fixed maximum for the y axis, or null.

Parameters

lineChart ConsoleMonster.Widgets.LineChart required
The instance.
value double? required
The value.

Returns

LineChart The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.LineChart { Maximum = value };    lineChart.Maximum(value);
public static ScoreGauge Maximum(ScoreGauge scoreGauge, double value) #

Sets ScoreGauge.Maximum: The maximum score.

Parameters

scoreGauge ConsoleMonster.Widgets.ScoreGauge required
The instance.
value double required
The value.

Returns

ScoreGauge The same instance.

Examples

// C# initializer or property    // C# fluent
scoreGauge.Maximum = value;      scoreGauge.Maximum(value);
public static Sparkline Maximum(Sparkline sparkline, double? value) #

Sets Sparkline.Maximum: A fixed maximum, or null to scale to the visible values.

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance.
value double? required
The value.

Returns

Sparkline The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.Sparkline { Maximum = value };    sparkline.Maximum(value);
public static ChartOptions Maximum(ChartOptions chartOptions, double? value) #

Sets ChartOptions.Maximum: The upper numeric limit.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value double? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Maximum = value };    Ui.Chart().Maximum(value);
public static ExceptionView MaxInner(ExceptionView exceptionView, int value) #

Sets ExceptionView.MaxInner: How many inner errors are shown (default 4).

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value int required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property      // C# fluent
exceptionView.MaxInner = value;    exceptionView.MaxInner(value);
public static TreeHierarchyOptions MaxItems(TreeHierarchyOptions treeHierarchyOptions, int value) #

Sets TreeHierarchyOptions.MaxItems: The most children listed per node, and top-level items listed, before a "+N more" note (default 25; 0 or less lists all).

Parameters

treeHierarchyOptions ConsoleMonster.Widgets.TreeHierarchyOptions required
The instance.
value int required
The value.

Returns

TreeHierarchyOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { MaxItems = value };    treeHierarchyOptions.MaxItems(value);
public static KeyValueList MaxKeyFraction(KeyValueList keyValueList, double value) #

Sets KeyValueList.MaxKeyFraction: Preferred key fraction when the natural label and value widths cannot both fit (default 0.4).

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
value double required
The value.

Returns

KeyValueList The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Widgets.KeyValueList { MaxKeyFraction = value };    Ui.KeyValue().MaxKeyFraction(value);
public static RecordView MaxLabelFraction(RecordView recordView, double value) #

Sets RecordView.MaxLabelFraction: The widest a label column may be, as a fraction of the width (default 0.4).

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance.
value double required
The value.

Returns

RecordView The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Widgets.RecordView { MaxLabelFraction = value };    recordView.MaxLabelFraction(value);
public static Lanes MaxLabelWidth(Lanes lanes, int value) #

Sets Lanes.MaxLabelWidth: The widest label column (default 28).

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value int required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Lanes { MaxLabelWidth = value };    Ui.Lanes().MaxLabelWidth(value);
MaxLegendColumns 2 overloads
public static StackedBar MaxLegendColumns(StackedBar stackedBar, int value) #

Sets StackedBar.MaxLegendColumns: The most legend columns per row, or 0 (default) to fit as many as the width allows. Entries fill rows left to right and every row shares one grid, so labels, counts and percentages line up.

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
value int required
The value.

Returns

StackedBar The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Widgets.StackedBar { MaxLegendColumns = value };    stackedBar.MaxLegendColumns(value);
public static ChartOptions MaxLegendColumns(ChartOptions chartOptions, int value) #

Sets ChartOptions.MaxLegendColumns: Maximum Stacked legend columns; zero fits the available width.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value int required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { MaxLegendColumns = value };    Ui.Chart().MaxLegendColumns(value);
MaxLines 2 overloads
public static CodeView MaxLines(CodeView codeView, int value) #

Sets CodeView.MaxLines: The most lines shown (default 2000); the rest are counted.

Parameters

codeView ConsoleMonster.Widgets.CodeView required
The instance.
value int required
The value.

Returns

CodeView The same instance.

Examples

// C# initializer or property    // C# fluent
codeView.MaxLines = value;       codeView.MaxLines(value);
public static TableColumn MaxLines(TableColumn tableColumn, int value) #

Sets TableColumn.MaxLines: The most lines a wrapped value may use: 0 (the default) follows the table's Table.WrapLines (3 unless changed), TableColumn.Unlimited shows every line. The last line ends with an ellipsis when cut.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.MaxLines = value;    tableColumn.MaxLines(value);
public static LogRegion MaxLinesPerEntry(LogRegion logRegion, int value) #

Sets LogRegion.MaxLinesPerEntry: The most rows one entry may use when LogRegion.Wrap is on; the last row ends with an ellipsis when cut (default 3).

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value int required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { MaxLinesPerEntry = value };    Ui.LogRegion().MaxLinesPerEntry(value);
public static Matrix MaxListRows(Matrix matrix, int value) #

Sets Matrix.MaxListRows: The most attention entries shown (default 10; zero shows all), followed by an omission count.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value int required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.MaxListRows = value;      matrix.MaxListRows(value);
public static RunView MaxListWidth(RunView runView, int value) #

Sets 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 required
The instance.
value int required
The value.

Returns

RunView The same instance.

Examples

// C# initializer or property    // C# fluent
runView.MaxListWidth = value;    runView.MaxListWidth(value);
public static TreeHierarchyOptions MaxNodes(TreeHierarchyOptions treeHierarchyOptions, int value) #

Sets TreeHierarchyOptions.MaxNodes: The most nodes the whole hierarchy may add (default 5000; 0 or less for no limit); beyond it a "node limit reached" note ends the walk.

Parameters

treeHierarchyOptions ConsoleMonster.Widgets.TreeHierarchyOptions required
The instance.
value int required
The value.

Returns

TreeHierarchyOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.Widgets.TreeHierarchyOptions { MaxNodes = value };    treeHierarchyOptions.MaxNodes(value);
public static PathSet MaxPaths(PathSet pathSet, int value) #

Sets PathSet.MaxPaths: The most chains rendered (default 10; zero shows all); omitted chains are counted.

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance.
value int required
The value.

Returns

PathSet The same instance.

Examples

// C# initializer or property    // C# fluent
pathSet.MaxPaths = value;        pathSet.MaxPaths(value);
MaxRows 2 overloads
public static CellMap MaxRows(CellMap cellMap, int value) #

Sets CellMap.MaxRows: The most rows of cells (0 = all); a last line then counts the items not shown.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
value int required
The value.

Returns

CellMap The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.CellMap { MaxRows = value };    Ui.CellMap().MaxRows(value);
public static LiveTable MaxRows(LiveTable liveTable, int value) #

Sets LiveTable.MaxRows: Keeps only the most recently added rows (0, the default, keeps them all): a bounded "recent N" window.

Parameters

liveTable ConsoleMonster.Widgets.LiveTable required
The instance.
value int required
The value.

Returns

LiveTable The same instance.

Examples

// C# initializer or property    // C# fluent
liveTable.MaxRows = value;       liveTable.MaxRows(value);
public static TSelf MaxRows<TSelf>(TSelf table, int value) #

Sets Table.MaxRows: Shows only the first N rows (0 = all) followed by Showing N of M; totals still cover every row.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value int required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.Table { MaxRows = value };    Ui.Table().MaxRows(value);
public static RunView MaxRunning(RunView runView, int value) #

Sets RunView.MaxRunning: The most running items listed (default 8); more are counted.

Parameters

runView ConsoleMonster.Widgets.RunView required
The instance.
value int required
The value.

Returns

RunView The same instance.

Examples

// C# initializer or property    // C# fluent
runView.MaxRunning = value;      runView.MaxRunning(value);
public static ActivityList MaxVisible(ActivityList activityList, int value) #

Sets ActivityList.MaxVisible: The most activities shown (default 8); more are summarised in one line.

Parameters

activityList ConsoleMonster.Widgets.ActivityList required
The instance.
value int required
The value.

Returns

ActivityList The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ActivityList { MaxVisible = value };    Ui.ActivityList().MaxVisible(value);
public static TableColumn MaxWidth(TableColumn tableColumn, int? value) #

Sets TableColumn.MaxWidth: A maximum width, or null.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.MaxWidth = value;    tableColumn.MaxWidth(value);
MeasureBareLabel 2 overloads
public static TreeNode MeasureBareLabel(TreeNode treeNode, bool value) #

Sets TreeNode.MeasureBareLabel: Include a bare node with values when sizing after-label value columns.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value bool required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property         // C# fluent
treeNode.MeasureBareLabel = value;    treeNode.MeasureBareLabel(value);
public static TreeNode MeasureBareLabel(TreeNode treeNode) #

Sets TreeNode.MeasureBareLabel to true.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance to configure.

Returns

TreeNode The same instance.
public static FooterBar Message(FooterBar footerBar, StyledLine? value) #

Sets FooterBar.Message: A line shown instead of the hints (a toast), or null.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
value ConsoleMonster.Text.StyledLine? required
The value.

Returns

FooterBar The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.FooterBar { Message = value };    Ui.FooterBar().Message(value);
public static Matrix MinCellWidth(Matrix matrix, int value) #

Sets Matrix.MinCellWidth: Minimum cell width for an inline grid (default one).

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value int required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.MinCellWidth = value;     matrix.MinCellWidth(value);
Minimum 2 overloads
public static LineChart Minimum(LineChart lineChart, double? value) #

Sets LineChart.Minimum: A fixed minimum for the y axis, or null (0 when all values are positive).

Parameters

lineChart ConsoleMonster.Widgets.LineChart required
The instance.
value double? required
The value.

Returns

LineChart The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.LineChart { Minimum = value };    lineChart.Minimum(value);
public static ChartOptions Minimum(ChartOptions chartOptions, double? value) #

Sets ChartOptions.Minimum: The lower numeric limit.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value double? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Minimum = value };    Ui.Chart().Minimum(value);
public static Dashboard MinimumSize(Dashboard dashboard, Size value) #

Sets Dashboard.MinimumSize: The smallest window the full layout needs (default 60 ร— 14). Below it a live session renders the compact form: a one-line status and the highest-priority Prioritized widgets that fit.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
value ConsoleMonster.Layout.Size required
The value.

Returns

Dashboard The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.Dashboard { MinimumSize = value };    Ui.Dashboard().MinimumSize(value);
public static TableColumn MinWidth(TableColumn tableColumn, int? value) #

Sets TableColumn.MinWidth: A minimum width, or null.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.MinWidth = value;    tableColumn.MinWidth(value);
public static Matrix MissingLegendLabel(Matrix matrix, string? value) #

Sets Matrix.MissingLegendLabel: The plain text absent-observation legend word, or null for the built-in word.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property         // C# fluent
matrix.MissingLegendLabel = value;    matrix.MissingLegendLabel(value);
MissingText 2 overloads
public static BarChart MissingText(BarChart barChart, string? value) #

Sets BarChart.MissingText: The plain text shown for non-finite values; null retains the tier-appropriate dash.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value string? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.BarChart { MissingText = value };    barChart.MissingText(value);
public static ChartItem MissingText(ChartItem chartItem, string? value) #

Sets ChartItem.MissingText: A plain text replacement for a non-finite value in a bar chart; null uses the chart default.

Parameters

chartItem ConsoleMonster.Widgets.ChartItem required
The instance.
value string? required
The value.

Returns

ChartItem The same instance.

Examples

// C# initializer or property     // C# fluent
chartItem.MissingText = value;    chartItem.MissingText(value);
public static Calendar Month(Calendar calendar, int value) #

Sets Calendar.Month: The month used in Month view.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance.
value int required
The value.

Returns

Calendar The same instance.

Examples

// C# initializer or property    // C# fluent
calendar.Month = value;          Ui.Calendar().Month(value);
public static ViewHint MoreRows(ViewHint viewHint, long value) #

Sets ViewHint.MoreRows: The number of additional rows.

Parameters

viewHint ConsoleMonster.Widgets.ViewHint required
The instance.
value long required
The value.

Returns

ViewHint The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ViewHint { MoreRows = value };    viewHint.MoreRows(value);
Muted 2 overloads
public static TableRowRole Muted(TableRowRole tableRowRole, bool value) #

Sets TableRowRole.Muted: Mute every cell; an explicit TableRowRole.Tone takes precedence.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance.
value bool required
The value.

Returns

TableRowRole The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.TableRowRole { Muted = value };    tableRowRole.Muted(value);
public static TableRowRole Muted(TableRowRole tableRowRole) #

Sets TableRowRole.Muted to true.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance to configure.

Returns

TableRowRole The same instance.
public static LayoutRegions NarrowBelow(LayoutRegions layoutRegions, int value) #

Sets LayoutRegions.NarrowBelow: The minimum width for showing regions side by side.

Parameters

layoutRegions ConsoleMonster.Widgets.LayoutRegions required
The instance.
value int required
The value.

Returns

LayoutRegions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Widgets.LayoutRegions { NarrowBelow = value };    Ui.LayoutRegions().NarrowBelow(value);
NonHealthyOnly 2 overloads
public static Matrix NonHealthyOnly(Matrix matrix, bool value) #

Sets Matrix.NonHealthyOnly: Always render the non-healthy list instead of the grid.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value bool required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property     // C# fluent
matrix.NonHealthyOnly = value;    matrix.NonHealthyOnly(value);
public static Matrix NonHealthyOnly(Matrix matrix) #

Sets Matrix.NonHealthyOnly to true.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance to configure.

Returns

Matrix The same instance.
NumberColumn 2 overloads
public static KeyValueList NumberColumn(KeyValueList keyValueList, ColumnFormat value) #

Sets KeyValueList.NumberColumn: Layout of the leading number of each value (234 / 332, 8.4 rules/s, ~12s): when every value starts with a number, the numbers share a column, right-aligned by default, so they line up under each other. A list that mixes in text (a host name, an OS) keeps every value left-aligned as written, so "3 days" under a name is not pushed right. Set the alignment to HorizontalAlignment.Left to always print values as written.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

KeyValueList The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Widgets.KeyValueList { NumberColumn = value };    Ui.KeyValue().NumberColumn(value);
public static KeyValueList NumberColumn(KeyValueList keyValueList, Action<ColumnFormat> configure) #

Configures KeyValueList.NumberColumn in place: Layout of the leading number of each value (234 / 332, 8.4 rules/s, ~12s): when every value starts with a number, the numbers share a column, right-aligned by default, so they line up under each other. A list that mixes in text (a host name, an OS) keeps every value left-aligned as written, so "3 days" under a name is not pushed right. Set the alignment to HorizontalAlignment.Left to always print values as written.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

KeyValueList The same instance.
public static Lane Order(Lane lane, int value) #

Sets Lane.Order: Insertion order, used to keep rows stable.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value int required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Order = value;              lane.Order(value);
public static PathSet Origin(PathSet pathSet, Action<PathHop> configure) #

Configures PathSet.Origin in place: The common origin.

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance.
configure System.Action<ConsoleMonster.Widgets.PathHop> required
Configures the value.

Returns

PathSet The same instance.
Overflow 2 overloads
public static TextBlock Overflow(TextBlock textBlock, TextOverflow value) #

Sets TextBlock.Overflow: Overflow handling (default wrap).

Parameters

textBlock ConsoleMonster.Widgets.TextBlock required
The instance.
value ConsoleMonster.Widgets.TextOverflow required
The value.

Returns

TextBlock The same instance.

Examples

// C# initializer or property    // C# fluent
textBlock.Overflow = value;      Ui.Text().Markup().Overflow(value);
public static TableColumn Overflow(TableColumn tableColumn, ColumnOverflow value) #

Sets TableColumn.Overflow: What happens to values wider than the column: wrap (default), truncate at the end, truncate in the middle, or never shorten.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value ConsoleMonster.Widgets.ColumnOverflow required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Overflow = value;    tableColumn.Overflow(value);
public static Lane Passed(Lane lane, int value) #

Sets Lane.Passed: Steps that passed.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value int required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Passed = value;             lane.Passed(value);
public static ShellPrompt Path(ShellPrompt shellPrompt, string value) #

Sets ShellPrompt.Path: The current provider path.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance.
value string required
The value.

Returns

ShellPrompt The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.ShellPrompt { Path = value };    shellPrompt.Path(value);
PercentColumn 6 overloads
public static Lanes PercentColumn(Lanes lanes, ColumnFormat value) #

Sets Lanes.PercentColumn: Layout of the percentage column (default right-aligned, four cells for "100%").

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Lanes { PercentColumn = value };    Ui.Lanes().PercentColumn(value);
public static Lanes PercentColumn(Lanes lanes, Action<ColumnFormat> configure) #

Configures Lanes.PercentColumn in place: Layout of the percentage column (default right-aligned, four cells for "100%").

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

Lanes The same instance.
public static StackedBar PercentColumn(StackedBar stackedBar, ColumnFormat value) #

Sets StackedBar.PercentColumn: Layout of the legend percentage column (default right-aligned, four cells).

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

StackedBar The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.StackedBar { PercentColumn = value };    stackedBar.PercentColumn(value);
public static StackedBar PercentColumn(StackedBar stackedBar, Action<ColumnFormat> configure) #

Configures StackedBar.PercentColumn in place: Layout of the legend percentage column (default right-aligned, four cells).

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

StackedBar The same instance.
public static ChartOptions PercentColumn(ChartOptions chartOptions, ColumnFormat? value) #

Sets ChartOptions.PercentColumn: The stacked percent-column format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value ConsoleMonster.Layout.ColumnFormat? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { PercentColumn = value };    Ui.Chart().PercentColumn(value);
public static ChartOptions PercentColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #

Configures ChartOptions.PercentColumn in place: The stacked percent-column format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

ChartOptions The same instance.
public static TableColumn Placement(TableColumn tableColumn, ColumnPlacement value) #

Sets TableColumn.Placement: Where evidence moves when this column cannot fit.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value ConsoleMonster.Widgets.ColumnPlacement required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property     // C# fluent
tableColumn.Placement = value;    tableColumn.Placement(value);
public static WatchView PollInterval(WatchView watchView, TimeSpan value) #

Sets WatchView.PollInterval: The time between runs, shown in the heading.

Parameters

watchView ConsoleMonster.Widgets.WatchView required
The instance.
value System.TimeSpan required
The value.

Returns

WatchView The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.WatchView { PollInterval = value };    watchView.PollInterval(value);
public static LogRegion PreferredHeight(LogRegion logRegion, int value) #

Sets LogRegion.PreferredHeight: Rows requested when measured without a height limit (default 8).

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value int required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { PreferredHeight = value };    Ui.LogRegion().PreferredHeight(value);
Presentation 8 overloads
public static InspectorView Presentation(InspectorView inspectorView, PresentationOptions value) #

Sets InspectorView.Presentation: Culture, clock and time zone for values.

Parameters

inspectorView ConsoleMonster.Widgets.InspectorView required
The instance.
value ConsoleMonster.Presenters.PresentationOptions required
The value.

Returns

InspectorView The same instance.

Examples

// C# initializer or property          // C# fluent
inspectorView.Presentation = value;    inspectorView.Presentation(value);
public static InspectorView Presentation(InspectorView inspectorView, Action<PresentationOptions> configure) #

Configures InspectorView.Presentation in place (creating it when not set): Culture, clock and time zone for values.

Parameters

inspectorView ConsoleMonster.Widgets.InspectorView required
The instance.
configure System.Action<ConsoleMonster.Presenters.PresentationOptions> required
Configures the value.

Returns

InspectorView The same instance.
public static KeyValueList Presentation(KeyValueList keyValueList, PresentationOptions value) #

Sets KeyValueList.Presentation: Culture, clock and time zone for values added with KeyValueList.AddValue.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
value ConsoleMonster.Presenters.PresentationOptions required
The value.

Returns

KeyValueList The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Widgets.KeyValueList { Presentation = value };    Ui.KeyValue().Presentation(value);
public static KeyValueList Presentation(KeyValueList keyValueList, Action<PresentationOptions> configure) #

Configures KeyValueList.Presentation in place (creating it when not set): Culture, clock and time zone for values added with KeyValueList.AddValue.

Parameters

keyValueList ConsoleMonster.Widgets.KeyValueList required
The instance.
configure System.Action<ConsoleMonster.Presenters.PresentationOptions> required
Configures the value.

Returns

KeyValueList The same instance.
public static RecordView Presentation(RecordView recordView, PresentationOptions value) #

Sets RecordView.Presentation: Culture, clock and time zone for raw values.

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance.
value ConsoleMonster.Presenters.PresentationOptions required
The value.

Returns

RecordView The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.RecordView { Presentation = value };    recordView.Presentation(value);
public static RecordView Presentation(RecordView recordView, Action<PresentationOptions> configure) #

Configures RecordView.Presentation in place (creating it when not set): Culture, clock and time zone for raw values.

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance.
configure System.Action<ConsoleMonster.Presenters.PresentationOptions> required
Configures the value.

Returns

RecordView The same instance.
public static Tree Presentation(Tree tree, PresentationOptions value) #

Sets Tree.Presentation: Culture, clock and time zone for node values.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value ConsoleMonster.Presenters.PresentationOptions required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.Tree { Presentation = value };    Ui.Tree().Presentation(value);
public static Tree Presentation(Tree tree, Action<PresentationOptions> configure) #

Configures Tree.Presentation in place (creating it when not set): Culture, clock and time zone for node values.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
configure System.Action<ConsoleMonster.Presenters.PresentationOptions> required
Configures the value.

Returns

Tree The same instance.
Presentation``1 2 overloads
public static TSelf Presentation<TSelf>(TSelf table, PresentationOptions value) #

Sets Table.Presentation: Culture, clock and time zone for raw values.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value ConsoleMonster.Presenters.PresentationOptions required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Table { Presentation = value };    Ui.Table().Presentation(value);
public static TSelf Presentation<TSelf>(TSelf table, Action<PresentationOptions> configure) #

Configures Table.Presentation in place (creating it when not set): Culture, clock and time zone for raw values.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
configure System.Action<ConsoleMonster.Presenters.PresentationOptions> required
Configures the value.

Returns

TSelf The same instance.
Presenter 2 overloads
public static TableColumn Presenter(TableColumn tableColumn, ICellPresenter? value) #

Sets TableColumn.Presenter: How raw cell values are shown, or null for automatic (by value type). Markup cells are shown as written.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value ConsoleMonster.Presenters.ICellPresenter? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property     // C# fluent
tableColumn.Presenter = value;    tableColumn.Presenter(value);
public static TreeNode Presenter(TreeNode treeNode, ICellPresenter? value) #

Sets TreeNode.Presenter: The presenter for TreeNode.Value, or null for automatic.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value ConsoleMonster.Presenters.ICellPresenter? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Presenter = value;      treeNode.Presenter(value);
public static TableColumn Priority(TableColumn tableColumn, int value) #

Sets TableColumn.Priority: The column's importance when the table is too wide: columns with the lowest priority hide first (ties hide from the right). The default is 0. Key columns never hide.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Priority = value;    tableColumn.Priority(value);
ProblemsOnly 2 overloads
public static RunDashboard ProblemsOnly(RunDashboard runDashboard, bool value) #

Sets RunDashboard.ProblemsOnly: Whether only problems are appended to the log.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance.
value bool required
The value.

Returns

RunDashboard The same instance.

Examples

// C# initializer or property         // C# fluent
runDashboard.ProblemsOnly = value;    runDashboard.ProblemsOnly(value);
public static RunDashboard ProblemsOnly(RunDashboard runDashboard) #

Sets RunDashboard.ProblemsOnly to true.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance to configure.

Returns

RunDashboard The same instance.
RateWindow 3 overloads
public static Lanes RateWindow(Lanes lanes, TimeSpan value) #

Sets Lanes.RateWindow: The moving window that smooths rates and remaining-time estimates (default 10 seconds).

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value System.TimeSpan required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Lanes { RateWindow = value };    Ui.Lanes().RateWindow(value);
public static ProgressBar RateWindow(ProgressBar progressBar, TimeSpan value) #

Sets ProgressBar.RateWindow: The moving window that smooths the rate and the remaining time (default 10 seconds).

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value System.TimeSpan required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { RateWindow = value };    progressBar.RateWindow(value);
public static ProgressOptions RateWindow(ProgressOptions progressOptions, TimeSpan value) #

Sets ProgressOptions.RateWindow: The smoothing interval for rate and remaining time.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value System.TimeSpan required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { RateWindow = value };    Ui.Progress().RateWindow(value);
public static TSelf RecordViewRows<TSelf>(TSelf table, int value) #

Sets Table.RecordViewRows: A table with at most this many rows renders as a record view (default 1; 0 disables).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value int required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.Table { RecordViewRows = value };    Ui.Table().RecordViewRows(value);
public static TreeNode Reference(TreeNode treeNode, TreeReferenceKind value) #

Sets TreeNode.Reference: Explicit reference and completeness markers. Cycle, repeat and collapse markers stop traversal.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value ConsoleMonster.Widgets.TreeReferenceKind required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Reference = value;      treeNode.Reference(value);
public static TreeNode ReferenceSummary(TreeNode treeNode, string? value) #

Sets TreeNode.ReferenceSummary: An optional plain text aggregate or reference detail shown with the marker.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value string? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property         // C# fluent
treeNode.ReferenceSummary = value;    treeNode.ReferenceSummary(value);
public static RunSummary ReportPath(RunSummary runSummary, string? value) #

Sets RunSummary.ReportPath: Optional report location printed after the problems.

Parameters

runSummary ConsoleMonster.Widgets.RunSummary required
The instance.
value string? required
The value.

Returns

RunSummary The same instance.

Examples

// C# initializer or property     // C# fluent
runSummary.ReportPath = value;    runSummary.ReportPath(value);
public static RunView RetryCount(RunView runView, int value) #

Sets RunView.RetryCount: The retries allowed per item, for the "retry n of m" note on a running retry; zero shows only the attempt.

Parameters

runView ConsoleMonster.Widgets.RunView required
The instance.
value int required
The value.

Returns

RunView The same instance.

Examples

// C# initializer or property    // C# fluent
runView.RetryCount = value;      runView.RetryCount(value);
public static FooterBar Right(FooterBar footerBar, StyledLine? value) #

Sets FooterBar.Right: Text on the right, or null.

Parameters

footerBar ConsoleMonster.Widgets.FooterBar required
The instance.
value ConsoleMonster.Text.StyledLine? required
The value.

Returns

FooterBar The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.FooterBar { Right = value };    Ui.FooterBar().Right(value);
Role 10 overloads
public static BarChart Role(BarChart barChart, ThemeToken value) #

Sets BarChart.Role: The default bar colour (default ThemeToken.Series1).

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value ConsoleMonster.Styling.ThemeToken required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.BarChart { Role = value };    barChart.Role(value);
public static FactFlow Role(FactFlow factFlow, ThemeToken? value) #

Sets FactFlow.Role: An optional role beneath each fact.

Parameters

factFlow ConsoleMonster.Widgets.FactFlow required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

FactFlow The same instance.

Examples

// C# initializer or property    // C# fluent
factFlow.Role = value;           factFlow.Role(value);
public static Histogram Role(Histogram histogram, ThemeToken value) #

Sets Histogram.Role: The bar colour role (default ThemeToken.Series1).

Parameters

histogram ConsoleMonster.Widgets.Histogram required
The instance.
value ConsoleMonster.Styling.ThemeToken required
The value.

Returns

Histogram The same instance.

Examples

// C# initializer or property    // C# fluent
histogram.Role = value;          histogram.Role(value);
public static ScoreGauge Role(ScoreGauge scoreGauge, ThemeToken value) #

Sets ScoreGauge.Role: The worst finding's role, supplied by the caller.

Parameters

scoreGauge ConsoleMonster.Widgets.ScoreGauge required
The instance.
value ConsoleMonster.Styling.ThemeToken required
The value.

Returns

ScoreGauge The same instance.

Examples

// C# initializer or property    // C# fluent
scoreGauge.Role = value;         scoreGauge.Role(value);
public static Sparkline Role(Sparkline sparkline, ThemeToken value) #

Sets Sparkline.Role: The colour role (default ThemeToken.Accent).

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance.
value ConsoleMonster.Styling.ThemeToken required
The value.

Returns

Sparkline The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.Sparkline { Role = value };    sparkline.Role(value);
public static TextBlock Role(TextBlock textBlock, ThemeToken? value) #

Sets TextBlock.Role: A theme role layered under the text, or null.

Parameters

textBlock ConsoleMonster.Widgets.TextBlock required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

TextBlock The same instance.

Examples

// C# initializer or property    // C# fluent
textBlock.Role = value;          Ui.Text().Markup().Role(value);
public static ChartOptions Role(ChartOptions chartOptions, ThemeToken? value) #

Sets ChartOptions.Role: The chart color role.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Role = value };    Ui.Chart().Role(value);
public static ChartItem Role(ChartItem chartItem, ThemeToken? value) #

Sets ChartItem.Role: The colour role.

Parameters

chartItem ConsoleMonster.Widgets.ChartItem required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

ChartItem The same instance.

Examples

// C# initializer or property    // C# fluent
chartItem.Role = value;          chartItem.Role(value);
public static ChartSeries Role(ChartSeries chartSeries, ThemeToken value) #

Sets ChartSeries.Role: The colour role.

Parameters

chartSeries ConsoleMonster.Widgets.ChartSeries required
The instance.
value ConsoleMonster.Styling.ThemeToken required
The value.

Returns

ChartSeries The same instance.

Examples

// C# initializer or property    // C# fluent
chartSeries.Role = value;        chartSeries.Role(value);
public static PathHop Role(PathHop pathHop, ThemeToken? value) #

Sets PathHop.Role: Optional label role, independent of the health marker.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

PathHop The same instance.

Examples

// C# initializer or property    // C# fluent
pathHop.Role = value;            pathHop.Role(value);
public static Tree Root(Tree tree, Action<TreeNode> configure) #

Configures Tree.Root in place: The root node.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
configure System.Action<ConsoleMonster.Widgets.TreeNode> required
Configures the value.

Returns

Tree The same instance.
public static Matrix RowAxisCaption(Matrix matrix, string? value) #

Sets Matrix.RowAxisCaption: An optional plain text caption for the row axis, shown in grids and attention lists.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property     // C# fluent
matrix.RowAxisCaption = value;    matrix.RowAxisCaption(value);
public static TSelf RowTitles<TSelf>(TSelf table, IList<string?>? value) #

Sets Table.RowTitles: Titles for the rows in record and card views, by data row index (a null or empty entry uses the key column), so a caller can title a record "pwsh (90836)" while the key column stays the name. Null for none.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value System.Collections.Generic.IList<string?>? required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.Table { RowTitles = value };    Ui.Table().RowTitles(value);
Scatter 2 overloads
public static LineChart Scatter(LineChart lineChart, bool value) #

Sets LineChart.Scatter: Whether points are joined by lines (default) or drawn as a scatter.

Parameters

lineChart ConsoleMonster.Widgets.LineChart required
The instance.
value bool required
The value.

Returns

LineChart The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.LineChart { Scatter = value };    lineChart.Scatter(value);
public static LineChart Scatter(LineChart lineChart) #

Sets LineChart.Scatter to true.

Parameters

lineChart ConsoleMonster.Widgets.LineChart required
The instance to configure.

Returns

LineChart The same instance.
Scrollback 2 overloads
public static LogRegion Scrollback(LogRegion logRegion, bool value) #

Sets LogRegion.Scrollback: Also append each entry to normal scrollback above an inline live area. The retained entries still obey LogRegion.Capacity.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value bool required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { Scrollback = value };    Ui.LogRegion().Scrollback(value);
public static LogRegion Scrollback(LogRegion logRegion) #

Sets LogRegion.Scrollback to true.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance to configure.

Returns

LogRegion The same instance.
ScrollOffset 2 overloads
public static LogRegion ScrollOffset(LogRegion logRegion, int value) #

Sets LogRegion.ScrollOffset: Entries skipped from the newest end while scrolling; zero follows the newest entries.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value int required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { ScrollOffset = value };    Ui.LogRegion().ScrollOffset(value);
public static ScrollView ScrollOffset(ScrollView scrollView, int value) #

Sets ScrollView.ScrollOffset: The first visible content row, clamped after measurement.

Parameters

scrollView ConsoleMonster.Widgets.ScrollView required
The instance.
value int required
The value.

Returns

ScrollView The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ScrollView { ScrollOffset = value };    Ui.ScrollView().ScrollOffset(value);
public static Tabs SelectedIndex(Tabs tabs, int value) #

Sets Tabs.SelectedIndex: The active tab index.

Parameters

tabs ConsoleMonster.Widgets.Tabs required
The instance.
value int required
The value.

Returns

Tabs The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Tabs { SelectedIndex = value };    Ui.Tabs().SelectedIndex(value);
public static Matrix SelfLegendLabel(Matrix matrix, string? value) #

Sets Matrix.SelfLegendLabel: The plain text self-cell legend word, or null for the built-in word.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property      // C# fluent
matrix.SelfLegendLabel = value;    matrix.SelfLegendLabel(value);
public static FactFlow Separator(FactFlow factFlow, string? value) #

Sets FactFlow.Separator: Optional literal separator; the default is the tier's middle dot.

Parameters

factFlow ConsoleMonster.Widgets.FactFlow required
The instance.
value string? required
The value.

Returns

FactFlow The same instance.

Examples

// C# initializer or property    // C# fluent
factFlow.Separator = value;      factFlow.Separator(value);
Shape 5 overloads
public static BarChart Shape(BarChart barChart, BarShape value) #

Sets BarChart.Shape: The bar shape: BarShape.Block (default, solid three-quarter-height bars that keep a gap between rows) or BarShape.Line.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value ConsoleMonster.Widgets.BarShape required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.BarChart { Shape = value };    barChart.Shape(value);
public static Lanes Shape(Lanes lanes, BarShape value) #

Sets Lanes.Shape: The bar shape: BarShape.Line (default, thin strokes that keep rows apart) or BarShape.Block.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value ConsoleMonster.Widgets.BarShape required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                  // C# fluent
new global::ConsoleMonster.Widgets.Lanes { Shape = value };    Ui.Lanes().Shape(value);
public static ProgressBar Shape(ProgressBar progressBar, BarShape value) #

Sets ProgressBar.Shape: The bar shape: BarShape.Line (default, a thin stroke) or BarShape.Block (solid blocks).

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value ConsoleMonster.Widgets.BarShape required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { Shape = value };    progressBar.Shape(value);
public static ProgressOptions Shape(ProgressOptions progressOptions, BarShape value) #

Sets ProgressOptions.Shape: The bar shape.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value ConsoleMonster.Widgets.BarShape required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Shape = value };    Ui.Progress().Shape(value);
public static ChartOptions Shape(ChartOptions chartOptions, BarShape value) #

Sets ChartOptions.Shape: The bar shape.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value ConsoleMonster.Widgets.BarShape required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Shape = value };    Ui.Chart().Shape(value);
public static Matrix ShortColumnAxisCaption(Matrix matrix, string? value) #

Sets Matrix.ShortColumnAxisCaption: Abbreviated column caption for numbered grids.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property             // C# fluent
matrix.ShortColumnAxisCaption = value;    matrix.ShortColumnAxisCaption(value);
public static TableColumn ShortHeader(TableColumn tableColumn, string? value) #

Sets TableColumn.ShortHeader: An optional short header used when the full header exceeds its value-driven width.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value string? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property       // C# fluent
tableColumn.ShortHeader = value;    tableColumn.ShortHeader(value);
public static Matrix ShortRowAxisCaption(Matrix matrix, string? value) #

Sets Matrix.ShortRowAxisCaption: Abbreviated row caption for numbered grids.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property          // C# fluent
matrix.ShortRowAxisCaption = value;    matrix.ShortRowAxisCaption(value);
ShowCardCount``1 2 overloads
public static TSelf ShowCardCount<TSelf>(TSelf table, bool value) #

Sets Table.ShowCardCount: Show the record count beneath cards (default true). Omitted-row notices remain visible when false.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Table { ShowCardCount = value };    Ui.Table().ShowCardCount(value);
public static TSelf ShowCardCount<TSelf>(TSelf table) #

Sets Table.ShowCardCount to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
ShowCount 4 overloads
public static ProgressBar ShowCount(ProgressBar progressBar, bool value) #

Sets ProgressBar.ShowCount: Whether the value/total count is shown (default true).

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value bool required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { ShowCount = value };    progressBar.ShowCount(value);
public static ProgressBar ShowCount(ProgressBar progressBar) #

Sets ProgressBar.ShowCount to true.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance to configure.

Returns

ProgressBar The same instance.
public static ProgressOptions ShowCount(ProgressOptions progressOptions, bool value) #

Sets ProgressOptions.ShowCount: Whether the default bar layout shows its count.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value bool required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { ShowCount = value };    Ui.Progress().ShowCount(value);
public static ProgressOptions ShowCount(ProgressOptions progressOptions) #

Sets ProgressOptions.ShowCount to true.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance to configure.

Returns

ProgressOptions The same instance.
ShowDetail 2 overloads
public static Lanes ShowDetail(Lanes lanes, bool value) #

Sets Lanes.ShowDetail: Whether the detail column is shown (default true).

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Lanes { ShowDetail = value };    Ui.Lanes().ShowDetail(value);
public static Lanes ShowDetail(Lanes lanes) #

Sets Lanes.ShowDetail to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
ShowElapsed 14 overloads
public static ActivityList ShowElapsed(ActivityList activityList, bool value) #

Sets ActivityList.ShowElapsed: Whether each row ends with the time since the activity started, right-aligned (default true).

Parameters

activityList ConsoleMonster.Widgets.ActivityList required
The instance.
value bool required
The value.

Returns

ActivityList The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.ActivityList { ShowElapsed = value };    Ui.ActivityList().ShowElapsed(value);
public static ActivityList ShowElapsed(ActivityList activityList) #

Sets ActivityList.ShowElapsed to true.

Parameters

activityList ConsoleMonster.Widgets.ActivityList required
The instance to configure.

Returns

ActivityList The same instance.
public static Dashboard ShowElapsed(Dashboard dashboard, bool value) #

Sets Dashboard.ShowElapsed: Whether the elapsed clock is shown in the header (default true).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
value bool required
The value.

Returns

Dashboard The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.Dashboard { ShowElapsed = value };    Ui.Dashboard().ShowElapsed(value);
public static Dashboard ShowElapsed(Dashboard dashboard) #

Sets Dashboard.ShowElapsed to true.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance to configure.

Returns

Dashboard The same instance.
public static HeaderBar ShowElapsed(HeaderBar headerBar, bool value) #

Sets HeaderBar.ShowElapsed: Shows the elapsed clock on the right.

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
value bool required
The value.

Returns

HeaderBar The same instance.

Examples

// C# initializer or property     // C# fluent
headerBar.ShowElapsed = value;    Ui.HeaderBar().ShowElapsed(value);
public static HeaderBar ShowElapsed(HeaderBar headerBar) #

Sets HeaderBar.ShowElapsed to true.

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance to configure.

Returns

HeaderBar The same instance.
public static LogRegion ShowElapsed(LogRegion logRegion, bool value) #

Sets LogRegion.ShowElapsed: Whether entries show their session time (default true).

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value bool required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { ShowElapsed = value };    Ui.LogRegion().ShowElapsed(value);
public static LogRegion ShowElapsed(LogRegion logRegion) #

Sets LogRegion.ShowElapsed to true.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance to configure.

Returns

LogRegion The same instance.
public static Spinner ShowElapsed(Spinner spinner, bool value) #

Sets Spinner.ShowElapsed: Whether the elapsed time is shown on the right (default true).

Parameters

spinner ConsoleMonster.Widgets.Spinner required
The instance.
value bool required
The value.

Returns

Spinner The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Spinner { ShowElapsed = value };    spinner.ShowElapsed(value);
public static Spinner ShowElapsed(Spinner spinner) #

Sets Spinner.ShowElapsed to true.

Parameters

spinner ConsoleMonster.Widgets.Spinner required
The instance to configure.

Returns

Spinner The same instance.
public static SummaryBar ShowElapsed(SummaryBar summaryBar, bool value) #

Sets SummaryBar.ShowElapsed: Whether a finished run shows how long it took ("in 12s") after the counters (default true; needs SummaryBar.Elapsed or a live session's clock).

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar required
The instance.
value bool required
The value.

Returns

SummaryBar The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.SummaryBar { ShowElapsed = value };    Ui.SummaryBar().ShowElapsed(value);
public static SummaryBar ShowElapsed(SummaryBar summaryBar) #

Sets SummaryBar.ShowElapsed to true.

Parameters

summaryBar ConsoleMonster.Widgets.SummaryBar required
The instance to configure.

Returns

SummaryBar The same instance.
public static ProgressOptions ShowElapsed(ProgressOptions progressOptions, bool value) #

Sets ProgressOptions.ShowElapsed: Whether an indeterminate indicator shows elapsed time.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value bool required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { ShowElapsed = value };    Ui.Progress().ShowElapsed(value);
public static ProgressOptions ShowElapsed(ProgressOptions progressOptions) #

Sets ProgressOptions.ShowElapsed to true.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance to configure.

Returns

ProgressOptions The same instance.
ShowExamples 2 overloads
public static HelpView ShowExamples(HelpView helpView, bool value) #

Sets HelpView.ShowExamples: Whether the examples are shown (default true).

Parameters

helpView ConsoleMonster.Widgets.HelpView required
The instance.
value bool required
The value.

Returns

HelpView The same instance.

Examples

// C# initializer or property     // C# fluent
helpView.ShowExamples = value;    helpView.ShowExamples(value);
public static HelpView ShowExamples(HelpView helpView) #

Sets HelpView.ShowExamples to true.

Parameters

helpView ConsoleMonster.Widgets.HelpView required
The instance to configure.

Returns

HelpView The same instance.
ShowFrameworkFrames 2 overloads
public static ExceptionView ShowFrameworkFrames(ExceptionView exceptionView, bool value) #

Sets ExceptionView.ShowFrameworkFrames: Shows framework frames instead of collapsing them.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value bool required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property                 // C# fluent
exceptionView.ShowFrameworkFrames = value;    exceptionView.ShowFrameworkFrames(value);
public static ExceptionView ShowFrameworkFrames(ExceptionView exceptionView) #

Sets ExceptionView.ShowFrameworkFrames to true.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance to configure.

Returns

ExceptionView The same instance.
ShowGroupCounts``1 2 overloads
public static TSelf ShowGroupCounts<TSelf>(TSelf table, bool value) #

Sets Table.ShowGroupCounts: Append automatic row counts to group headings (default true).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.Table { ShowGroupCounts = value };    Ui.Table().ShowGroupCounts(value);
public static TSelf ShowGroupCounts<TSelf>(TSelf table) #

Sets Table.ShowGroupCounts to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
ShowGroups 2 overloads
public static RunDashboard ShowGroups(RunDashboard runDashboard, bool value) #

Sets RunDashboard.ShowGroups: Whether group rows may use spare dashboard space.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance.
value bool required
The value.

Returns

RunDashboard The same instance.

Examples

// C# initializer or property       // C# fluent
runDashboard.ShowGroups = value;    runDashboard.ShowGroups(value);
public static RunDashboard ShowGroups(RunDashboard runDashboard) #

Sets RunDashboard.ShowGroups to true.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance to configure.

Returns

RunDashboard The same instance.
ShowHeader 2 overloads
public static InspectorView ShowHeader(InspectorView inspectorView, bool value) #

Sets InspectorView.ShowHeader: Whether the title and summary line is shown (default true; nested inspectors turn it off).

Parameters

inspectorView ConsoleMonster.Widgets.InspectorView required
The instance.
value bool required
The value.

Returns

InspectorView The same instance.

Examples

// C# initializer or property        // C# fluent
inspectorView.ShowHeader = value;    inspectorView.ShowHeader(value);
public static InspectorView ShowHeader(InspectorView inspectorView) #

Sets InspectorView.ShowHeader to true.

Parameters

inspectorView ConsoleMonster.Widgets.InspectorView required
The instance to configure.

Returns

InspectorView The same instance.
ShowHeader``1 2 overloads
public static TSelf ShowHeader<TSelf>(TSelf table, bool value) #

Sets Table.ShowHeader: Whether the header row is shown (default true).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Table { ShowHeader = value };    Ui.Table().ShowHeader(value);
public static TSelf ShowHeader<TSelf>(TSelf table) #

Sets Table.ShowHeader to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
ShowHelp 2 overloads
public static RunDashboard ShowHelp(RunDashboard runDashboard, bool value) #

Sets RunDashboard.ShowHelp: Whether the key help is expanded.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance.
value bool required
The value.

Returns

RunDashboard The same instance.

Examples

// C# initializer or property     // C# fluent
runDashboard.ShowHelp = value;    runDashboard.ShowHelp(value);
public static RunDashboard ShowHelp(RunDashboard runDashboard) #

Sets RunDashboard.ShowHelp to true.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance to configure.

Returns

RunDashboard The same instance.
ShowHiddenColumns``1 2 overloads
public static TSelf ShowHiddenColumns<TSelf>(TSelf table, bool value) #

Sets Table.ShowHiddenColumns: Whether a footer names the columns hidden for lack of width (default true).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.Table { ShowHiddenColumns = value };    Ui.Table().ShowHiddenColumns(value);
public static TSelf ShowHiddenColumns<TSelf>(TSelf table) #

Sets Table.ShowHiddenColumns to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
ShowIds 2 overloads
public static ActivityList ShowIds(ActivityList activityList, bool value) #

Sets ActivityList.ShowIds: Whether each row starts with the activity's id (#3), for parallel work (default false).

Parameters

activityList ConsoleMonster.Widgets.ActivityList required
The instance.
value bool required
The value.

Returns

ActivityList The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.ActivityList { ShowIds = value };    Ui.ActivityList().ShowIds(value);
public static ActivityList ShowIds(ActivityList activityList) #

Sets ActivityList.ShowIds to true.

Parameters

activityList ConsoleMonster.Widgets.ActivityList required
The instance to configure.

Returns

ActivityList The same instance.
ShowKeyField``1 2 overloads
public static TSelf ShowKeyField<TSelf>(TSelf table, bool value) #

Sets Table.ShowKeyField: Also show the complete key as a wrapped field in record/card layouts, where headings may be omitted or truncated. Default false.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Table { ShowKeyField = value };    Ui.Table().ShowKeyField(value);
public static TSelf ShowKeyField<TSelf>(TSelf table) #

Sets Table.ShowKeyField to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
ShowKeys 2 overloads
public static RunDashboard ShowKeys(RunDashboard runDashboard, bool value) #

Sets RunDashboard.ShowKeys: Whether the key hints are visible.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance.
value bool required
The value.

Returns

RunDashboard The same instance.

Examples

// C# initializer or property     // C# fluent
runDashboard.ShowKeys = value;    runDashboard.ShowKeys(value);
public static RunDashboard ShowKeys(RunDashboard runDashboard) #

Sets RunDashboard.ShowKeys to true.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance to configure.

Returns

RunDashboard The same instance.
ShowLatest 4 overloads
public static Sparkline ShowLatest(Sparkline sparkline, bool value) #

Sets Sparkline.ShowLatest: Whether the latest value is shown on the right (default true).

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance.
value bool required
The value.

Returns

Sparkline The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.Sparkline { ShowLatest = value };    sparkline.ShowLatest(value);
public static Sparkline ShowLatest(Sparkline sparkline) #

Sets Sparkline.ShowLatest to true.

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance to configure.

Returns

Sparkline The same instance.
public static ChartOptions ShowLatest(ChartOptions chartOptions, bool value) #

Sets ChartOptions.ShowLatest: Whether the latest sparkline value is shown.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value bool required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ShowLatest = value };    Ui.Chart().ShowLatest(value);
public static ChartOptions ShowLatest(ChartOptions chartOptions) #

Sets ChartOptions.ShowLatest to true.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance to configure.

Returns

ChartOptions The same instance.
ShowLegend 10 overloads
public static Calendar ShowLegend(Calendar calendar, bool value) #

Sets Calendar.ShowLegend: Whether the legend follows the displayed period. Defaults to true.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance.
value bool required
The value.

Returns

Calendar The same instance.

Examples

// C# initializer or property    // C# fluent
calendar.ShowLegend = value;     Ui.Calendar().ShowLegend(value);
public static Calendar ShowLegend(Calendar calendar) #

Sets Calendar.ShowLegend to true.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance to configure.

Returns

Calendar The same instance.
public static CellMap ShowLegend(CellMap cellMap, bool value) #

Sets CellMap.ShowLegend: Whether a legend line with each state's count follows the cells (default true).

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
value bool required
The value.

Returns

CellMap The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.CellMap { ShowLegend = value };    Ui.CellMap().ShowLegend(value);
public static CellMap ShowLegend(CellMap cellMap) #

Sets CellMap.ShowLegend to true.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance to configure.

Returns

CellMap The same instance.
public static Matrix ShowLegend(Matrix matrix, bool value) #

Sets Matrix.ShowLegend: Show counts of supplied statuses, self cells and absent observations (default true).

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value bool required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.ShowLegend = value;       matrix.ShowLegend(value);
public static Matrix ShowLegend(Matrix matrix) #

Sets Matrix.ShowLegend to true.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance to configure.

Returns

Matrix The same instance.
public static StackedBar ShowLegend(StackedBar stackedBar, bool value) #

Sets StackedBar.ShowLegend: Whether the legend line is shown (default true).

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance.
value bool required
The value.

Returns

StackedBar The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.StackedBar { ShowLegend = value };    stackedBar.ShowLegend(value);
public static StackedBar ShowLegend(StackedBar stackedBar) #

Sets StackedBar.ShowLegend to true.

Parameters

stackedBar ConsoleMonster.Widgets.StackedBar required
The instance to configure.

Returns

StackedBar The same instance.
public static ChartOptions ShowLegend(ChartOptions chartOptions, bool value) #

Sets ChartOptions.ShowLegend: Whether Stacked charts show their legend.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value bool required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ShowLegend = value };    Ui.Chart().ShowLegend(value);
public static ChartOptions ShowLegend(ChartOptions chartOptions) #

Sets ChartOptions.ShowLegend to true.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance to configure.

Returns

ChartOptions The same instance.
ShowLegendCounts 2 overloads
public static Matrix ShowLegendCounts(Matrix matrix, bool value) #

Sets Matrix.ShowLegendCounts: Include observed cell counts after state labels in an inline legend (default true).

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value bool required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property       // C# fluent
matrix.ShowLegendCounts = value;    matrix.ShowLegendCounts(value);
public static Matrix ShowLegendCounts(Matrix matrix) #

Sets Matrix.ShowLegendCounts to true.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance to configure.

Returns

Matrix The same instance.
ShowParameters 2 overloads
public static HelpView ShowParameters(HelpView helpView, bool value) #

Sets HelpView.ShowParameters: Whether the parameter table is shown (default true).

Parameters

helpView ConsoleMonster.Widgets.HelpView required
The instance.
value bool required
The value.

Returns

HelpView The same instance.

Examples

// C# initializer or property       // C# fluent
helpView.ShowParameters = value;    helpView.ShowParameters(value);
public static HelpView ShowParameters(HelpView helpView) #

Sets HelpView.ShowParameters to true.

Parameters

helpView ConsoleMonster.Widgets.HelpView required
The instance to configure.

Returns

HelpView The same instance.
ShowRoot 2 overloads
public static Tree ShowRoot(Tree tree, bool value) #

Sets Tree.ShowRoot: Whether the root label is shown.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value bool required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.Tree { ShowRoot = value };    Ui.Tree().ShowRoot(value);
public static Tree ShowRoot(Tree tree) #

Sets Tree.ShowRoot to true.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance to configure.

Returns

Tree The same instance.
ShowRunningCount 2 overloads
public static Lanes ShowRunningCount(Lanes lanes, bool value) #

Sets Lanes.ShowRunningCount: Whether a last row counts the running lanes ("โ— 3 running") while any run (default false).

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.Lanes { ShowRunningCount = value };    Ui.Lanes().ShowRunningCount(value);
public static Lanes ShowRunningCount(Lanes lanes) #

Sets Lanes.ShowRunningCount to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
ShowSource 2 overloads
public static ExceptionView ShowSource(ExceptionView exceptionView, bool value) #

Sets ExceptionView.ShowSource: Shows the source lines around the first app frame whose file can be read (default true), highlighted.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value bool required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property        // C# fluent
exceptionView.ShowSource = value;    exceptionView.ShowSource(value);
public static ExceptionView ShowSource(ExceptionView exceptionView) #

Sets ExceptionView.ShowSource to true.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance to configure.

Returns

ExceptionView The same instance.
ShowStack 2 overloads
public static ExceptionView ShowStack(ExceptionView exceptionView, bool value) #

Sets ExceptionView.ShowStack: Shows the stack frames (default true); off shows the type, message and position only.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance.
value bool required
The value.

Returns

ExceptionView The same instance.

Examples

// C# initializer or property       // C# fluent
exceptionView.ShowStack = value;    exceptionView.ShowStack(value);
public static ExceptionView ShowStack(ExceptionView exceptionView) #

Sets ExceptionView.ShowStack to true.

Parameters

exceptionView ConsoleMonster.Widgets.ExceptionView required
The instance to configure.

Returns

ExceptionView The same instance.
ShowSubtotals``1 2 overloads
public static TSelf ShowSubtotals<TSelf>(TSelf table, bool value) #

Sets Table.ShowSubtotals: Whether each group ends with a subtotal row for columns that have an TableColumn.Aggregate.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Table { ShowSubtotals = value };    Ui.Table().ShowSubtotals(value);
public static TSelf ShowSubtotals<TSelf>(TSelf table) #

Sets Table.ShowSubtotals to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
ShowTimestamp 2 overloads
public static LogRegion ShowTimestamp(LogRegion logRegion, bool value) #

Sets LogRegion.ShowTimestamp: Shows source timestamps instead of session time; missing timestamps reserve a blank aligned cell.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value bool required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { ShowTimestamp = value };    Ui.LogRegion().ShowTimestamp(value);
public static LogRegion ShowTimestamp(LogRegion logRegion) #

Sets LogRegion.ShowTimestamp to true.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance to configure.

Returns

LogRegion The same instance.
ShowTotals``1 2 overloads
public static TSelf ShowTotals<TSelf>(TSelf table, bool value) #

Sets Table.ShowTotals: Whether a totals row summarises all rows (columns with an TableColumn.Aggregate), unless a footer is set.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Table { ShowTotals = value };    Ui.Table().ShowTotals(value);
public static TSelf ShowTotals<TSelf>(TSelf table) #

Sets Table.ShowTotals to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
ShowTrack 2 overloads
public static BarChart ShowTrack(BarChart barChart, bool value) #

Sets BarChart.ShowTrack: Draw the unused portion of each bar as a muted track.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value bool required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.BarChart { ShowTrack = value };    barChart.ShowTrack(value);
public static BarChart ShowTrack(BarChart barChart) #

Sets BarChart.ShowTrack to true.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance to configure.

Returns

BarChart The same instance.
ShowTrend 2 overloads
public static RunDashboard ShowTrend(RunDashboard runDashboard, bool value) #

Sets RunDashboard.ShowTrend: The optional throughput trend beside the rate.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance.
value bool required
The value.

Returns

RunDashboard The same instance.

Examples

// C# initializer or property      // C# fluent
runDashboard.ShowTrend = value;    runDashboard.ShowTrend(value);
public static RunDashboard ShowTrend(RunDashboard runDashboard) #

Sets RunDashboard.ShowTrend to true.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance to configure.

Returns

RunDashboard The same instance.
ShowValueHeaders 2 overloads
public static Tree ShowValueHeaders(Tree tree, bool value) #

Sets Tree.ShowValueHeaders: Show headings above aligned value columns (default true).

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value bool required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.Tree { ShowValueHeaders = value };    Ui.Tree().ShowValueHeaders(value);
public static Tree ShowValueHeaders(Tree tree) #

Sets Tree.ShowValueHeaders to true.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance to configure.

Returns

Tree The same instance.
ShowValues 4 overloads
public static BarChart ShowValues(BarChart barChart, bool value) #

Sets BarChart.ShowValues: Whether values are shown after the bars (default true).

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value bool required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.BarChart { ShowValues = value };    barChart.ShowValues(value);
public static BarChart ShowValues(BarChart barChart) #

Sets BarChart.ShowValues to true.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance to configure.

Returns

BarChart The same instance.
public static ChartOptions ShowValues(ChartOptions chartOptions, bool value) #

Sets ChartOptions.ShowValues: Whether Bar charts show each numeric value.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value bool required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ShowValues = value };    Ui.Chart().ShowValues(value);
public static ChartOptions ShowValues(ChartOptions chartOptions) #

Sets ChartOptions.ShowValues to true.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance to configure.

Returns

ChartOptions The same instance.
Signed 4 overloads
public static BarChart Signed(BarChart barChart, bool value) #

Sets BarChart.Signed: Draws negative values to the left of a shared zero baseline; default false preserves zero-based bars.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value bool required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.BarChart { Signed = value };    barChart.Signed(value);
public static BarChart Signed(BarChart barChart) #

Sets BarChart.Signed to true.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance to configure.

Returns

BarChart The same instance.
public static ChartOptions Signed(ChartOptions chartOptions, bool value) #

Sets ChartOptions.Signed: Whether Bar charts reserve space on both sides of zero.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value bool required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Signed = value };    Ui.Chart().Signed(value);
public static ChartOptions Signed(ChartOptions chartOptions) #

Sets ChartOptions.Signed to true.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance to configure.

Returns

ChartOptions The same instance.
public static Lane Skipped(Lane lane, int value) #

Sets Lane.Skipped: Steps skipped.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value int required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Skipped = value;            lane.Skipped(value);
public static LiveTable SortColumn(LiveTable liveTable, int? value) #

Sets LiveTable.SortColumn: The column index to keep rows sorted by, or null (default) for insertion order.

Parameters

liveTable ConsoleMonster.Widgets.LiveTable required
The instance.
value int? required
The value.

Returns

LiveTable The same instance.

Examples

// C# initializer or property    // C# fluent
liveTable.SortColumn = value;    liveTable.SortColumn(value);
SortDescending 2 overloads
public static LiveTable SortDescending(LiveTable liveTable, bool value) #

Sets LiveTable.SortDescending: Whether LiveTable.SortColumn sorts from the largest value down.

Parameters

liveTable ConsoleMonster.Widgets.LiveTable required
The instance.
value bool required
The value.

Returns

LiveTable The same instance.

Examples

// C# initializer or property        // C# fluent
liveTable.SortDescending = value;    liveTable.SortDescending(value);
public static LiveTable SortDescending(LiveTable liveTable) #

Sets LiveTable.SortDescending to true.

Parameters

liveTable ConsoleMonster.Widgets.LiveTable required
The instance to configure.

Returns

LiveTable The same instance.
SpanMissingValues 2 overloads
public static BarChart SpanMissingValues(BarChart barChart, bool value) #

Sets BarChart.SpanMissingValues: Let a missing measurement's explanation span the bar and value columns.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value bool required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.BarChart { SpanMissingValues = value };    barChart.SpanMissingValues(value);
public static BarChart SpanMissingValues(BarChart barChart) #

Sets BarChart.SpanMissingValues to true.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance to configure.

Returns

BarChart The same instance.
SpinRunning 2 overloads
public static CellMap SpinRunning(CellMap cellMap, bool value) #

Sets CellMap.SpinRunning: Whether running cells spin (default true); false shows the still running symbol, when another part of the screen already spins.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
value bool required
The value.

Returns

CellMap The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.CellMap { SpinRunning = value };    Ui.CellMap().SpinRunning(value);
public static CellMap SpinRunning(CellMap cellMap) #

Sets CellMap.SpinRunning to true.

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance to configure.

Returns

CellMap The same instance.
StableWidths``1 2 overloads
public static TSelf StableWidths<TSelf>(TSelf table, bool value) #

Sets Table.StableWidths: Whether column widths never shrink while the same table is re-rendered (live tables; default true), so columns do not jump as values change. Widths still fit the available space.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Table { StableWidths = value };    Ui.Table().StableWidths(value);
public static TSelf StableWidths<TSelf>(TSelf table) #

Sets Table.StableWidths to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
public static Logo StartColor(Logo logo, Color value) #

Sets Logo.StartColor: The gradient start colour (default sky blue).

Parameters

logo ConsoleMonster.Widgets.Logo required
The instance.
value ConsoleMonster.Styling.Color required
The value.

Returns

Logo The same instance.

Examples

// C# initializer or property    // C# fluent
logo.StartColor = value;         Ui.Logo().StartColor(value);
Started 3 overloads
public static Spinner Started(Spinner spinner, TimeSpan? value) #

Sets Spinner.Started: When the current run started on the session clock, or null for "when the session started". Set by the start operation and by the first running state event.

Parameters

spinner ConsoleMonster.Widgets.Spinner required
The instance.
value System.TimeSpan? required
The value.

Returns

Spinner The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.Spinner { Started = value };    spinner.Started(value);
public static ProgressOptions Started(ProgressOptions progressOptions, TimeSpan? value) #

Sets ProgressOptions.Started: Initial indeterminate start time on the session clock; null leaves it unstarted.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value System.TimeSpan? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Started = value };    Ui.Progress().Started(value);
public static Lane Started(Lane lane, TimeSpan? value) #

Sets Lane.Started: When the lane started (session time), if it has.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value System.TimeSpan? required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Started = value;            lane.Started(value);
public static ViewHeader State(ViewHeader viewHeader, string value) #

Sets ViewHeader.State: State markup, including an optional observation time.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
value string required
The value.

Returns

ViewHeader The same instance.

Examples

// C# initializer or property    // C# fluent
viewHeader.State = value;        viewHeader.State(value);
Status 9 overloads
public static Dashboard Status(Dashboard dashboard, StatusKind? value) #

Sets Dashboard.Status: The status kind, shown as a marker before Dashboard.Detail.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
value ConsoleMonster.Styling.StatusKind? required
The value.

Returns

Dashboard The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Dashboard { Status = value };    Ui.Dashboard().Status(value);
public static HeaderBar Status(HeaderBar headerBar, StatusKind? value) #

Sets HeaderBar.Status: The status kind; its marker goes before the status text.

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
value ConsoleMonster.Styling.StatusKind? required
The value.

Returns

HeaderBar The same instance.

Examples

// C# initializer or property    // C# fluent
headerBar.Status = value;        Ui.HeaderBar().Status(value);
public static ProgressBar Status(ProgressBar progressBar, StatusKind value) #

Sets ProgressBar.Status: The status; Pass/Fail/Warn change the bar colour once finished.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value ConsoleMonster.Styling.StatusKind required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { Status = value };    progressBar.Status(value);
public static Spinner Status(Spinner spinner, StatusKind value) #

Sets Spinner.Status: The status; anything other than Running or Pending replaces the animation with the status marker.

Parameters

spinner ConsoleMonster.Widgets.Spinner required
The instance.
value ConsoleMonster.Styling.StatusKind required
The value.

Returns

Spinner The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.Spinner { Status = value };    spinner.Status(value);
public static ProgressOptions Status(ProgressOptions progressOptions, StatusKind value) #

Sets ProgressOptions.Status: The initial state.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value ConsoleMonster.Styling.StatusKind required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                             // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Status = value };    Ui.Progress().Status(value);
public static ChartItem Status(ChartItem chartItem, StatusKind? value) #

Sets ChartItem.Status: An explicit status, shown as a glyph as well as a theme role in bar charts.

Parameters

chartItem ConsoleMonster.Widgets.ChartItem required
The instance.
value ConsoleMonster.Styling.StatusKind? required
The value.

Returns

ChartItem The same instance.

Examples

// C# initializer or property    // C# fluent
chartItem.Status = value;        chartItem.Status(value);
public static Lane Status(Lane lane, StatusKind value) #

Sets Lane.Status: The lane status.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value ConsoleMonster.Styling.StatusKind required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Status = value;             lane.Status(value);
public static PathHop Status(PathHop pathHop, StatusKind? value) #

Sets PathHop.Status: An optional status, rendered with its glyph and theme role.

Parameters

pathHop ConsoleMonster.Widgets.PathHop required
The instance.
value ConsoleMonster.Styling.StatusKind? required
The value.

Returns

PathHop The same instance.

Examples

// C# initializer or property    // C# fluent
pathHop.Status = value;          pathHop.Status(value);
public static TreeNode Status(TreeNode treeNode, StatusKind? value) #

Sets TreeNode.Status: An optional status marker shown before the label.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value ConsoleMonster.Styling.StatusKind? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Status = value;         treeNode.Status(value);
StepCounter 2 overloads
public static Phases StepCounter(Phases phases, bool value) #

Sets Phases.StepCounter: Draws a numbered ledger with hanging labels and right-aligned details, placing a detail below its label when they cannot share a row.

Parameters

phases ConsoleMonster.Widgets.Phases required
The instance.
value bool required
The value.

Returns

Phases The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Phases { StepCounter = value };    Ui.Phases().StepCounter(value);
public static Phases StepCounter(Phases phases) #

Sets Phases.StepCounter to true.

Parameters

phases ConsoleMonster.Widgets.Phases required
The instance to configure.

Returns

Phases The same instance.
Streaming 2 overloads
public static ViewHeader Streaming(ViewHeader viewHeader, bool value) #

Sets ViewHeader.Streaming: Whether the header describes an open stream, whose verdict is not known yet.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
value bool required
The value.

Returns

ViewHeader The same instance.

Examples

// C# initializer or property    // C# fluent
viewHeader.Streaming = value;    viewHeader.Streaming(value);
public static ViewHeader Streaming(ViewHeader viewHeader) #

Sets ViewHeader.Streaming to true.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance to configure.

Returns

ViewHeader The same instance.
Subtitle 2 overloads
public static Dashboard Subtitle(Dashboard dashboard, string? value) #

Sets Dashboard.Subtitle: The subtitle (markup), shown after the title.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
value string? required
The value.

Returns

Dashboard The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.Dashboard { Subtitle = value };    Ui.Dashboard().Subtitle(value);
public static HeaderBar Subtitle(HeaderBar headerBar, string? value) #

Sets HeaderBar.Subtitle: A subtitle after the title, separated by a dot (markup).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
value string? required
The value.

Returns

HeaderBar The same instance.

Examples

// C# initializer or property    // C# fluent
headerBar.Subtitle = value;      Ui.HeaderBar().Subtitle(value);
Succeeded 2 overloads
public static ShellPrompt Succeeded(ShellPrompt shellPrompt, bool value) #

Sets ShellPrompt.Succeeded: Whether PowerShell reported the last command as successful.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance.
value bool required
The value.

Returns

ShellPrompt The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ShellPrompt { Succeeded = value };    shellPrompt.Succeeded(value);
public static ShellPrompt Succeeded(ShellPrompt shellPrompt) #

Sets ShellPrompt.Succeeded to true.

Parameters

shellPrompt ConsoleMonster.Widgets.ShellPrompt required
The instance to configure.

Returns

ShellPrompt The same instance.
public static RecordView Summary(RecordView recordView, string? value) #

Sets RecordView.Summary: A muted summary after the title (12 targets ยท 4 failing), or null.

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance.
value string? required
The value.

Returns

RecordView The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.RecordView { Summary = value };    recordView.Summary(value);
Table 2 overloads
public static LiveTable Table(LiveTable liveTable, Action<Table> configure) #

Configures LiveTable.Table in place: The table that defines the columns, presenters and options.

Parameters

liveTable ConsoleMonster.Widgets.LiveTable required
The instance.
configure System.Action<ConsoleMonster.Widgets.Table> required
Configures the value.

Returns

LiveTable The same instance.
public static RoleTable Table(RoleTable roleTable, Action<Table> configure) #

Configures RoleTable.Table in place: The composed table, for ordinary border, header, card, grouping and summary options.

Parameters

roleTable ConsoleMonster.Widgets.RoleTable required
The instance.
configure System.Action<ConsoleMonster.Widgets.Table> required
Configures the value.

Returns

RoleTable The same instance.
public static Logo Tagline(Logo logo, string? value) #

Sets Logo.Tagline: The tagline (markup).

Parameters

logo ConsoleMonster.Widgets.Logo required
The instance.
value string? required
The value.

Returns

Logo The same instance.

Examples

// C# initializer or property    // C# fluent
logo.Tagline = value;            Ui.Logo().Tagline(value);
public static Logo Text(Logo logo, string value) #

Sets Logo.Text: The banner text.

Parameters

logo ConsoleMonster.Widgets.Logo required
The instance.
value string required
The value.

Returns

Logo The same instance.

Examples

// C# initializer or property    // C# fluent
logo.Text = value;               Ui.Logo().Text(value);
public static LogRegion TimestampFormat(LogRegion logRegion, string value) #

Sets LogRegion.TimestampFormat: Source timestamp format, using invariant culture (default ISO date, time, milliseconds and offset).

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value string required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                                // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { TimestampFormat = value };    Ui.LogRegion().TimestampFormat(value);
Title 15 overloads
public static CodeView Title(CodeView codeView, string? value) #

Sets CodeView.Title: A title (a file name) drawn on a panel around the code, or null for no panel.

Parameters

codeView ConsoleMonster.Widgets.CodeView required
The instance.
value string? required
The value.

Returns

CodeView The same instance.

Examples

// C# initializer or property    // C# fluent
codeView.Title = value;          codeView.Title(value);
public static Dashboard Title(Dashboard dashboard, string value) #

Sets Dashboard.Title: The title (markup).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard required
The instance.
value string required
The value.

Returns

Dashboard The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.Dashboard { Title = value };    Ui.Dashboard().Title(value);
public static HeaderBar Title(HeaderBar headerBar, string value) #

Sets HeaderBar.Title: The title (markup).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar required
The instance.
value string required
The value.

Returns

HeaderBar The same instance.

Examples

// C# initializer or property    // C# fluent
headerBar.Title = value;         Ui.HeaderBar().Title(value);
public static Matrix Title(Matrix matrix, string? value) #

Sets Matrix.Title: An optional markup title.

Parameters

matrix ConsoleMonster.Widgets.Matrix required
The instance.
value string? required
The value.

Returns

Matrix The same instance.

Examples

// C# initializer or property    // C# fluent
matrix.Title = value;            matrix.Title(value);
public static PathSet Title(PathSet pathSet, string? value) #

Sets PathSet.Title: An optional markup title.

Parameters

pathSet ConsoleMonster.Widgets.PathSet required
The instance.
value string? required
The value.

Returns

PathSet The same instance.

Examples

// C# initializer or property    // C# fluent
pathSet.Title = value;           pathSet.Title(value);
public static RecordView Title(RecordView recordView, string? value) #

Sets RecordView.Title: The title (markup) on the summary header line, or null.

Parameters

recordView ConsoleMonster.Widgets.RecordView required
The instance.
value string? required
The value.

Returns

RecordView The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.RecordView { Title = value };    recordView.Title(value);
public static Rule Title(Rule rule, string? value) #

Sets Rule.Title: The title (markup).

Parameters

rule ConsoleMonster.Widgets.Rule required
The instance.
value string? required
The value.

Returns

Rule The same instance.

Examples

// C# initializer or property                                 // C# fluent
new global::ConsoleMonster.Widgets.Rule { Title = value };    Ui.Rule().Title(value);
public static RunDashboard Title(RunDashboard runDashboard, string value) #

Sets RunDashboard.Title: The run name, shown as literal text.

Parameters

runDashboard ConsoleMonster.Widgets.RunDashboard required
The instance.
value string required
The value.

Returns

RunDashboard The same instance.

Examples

// C# initializer or property    // C# fluent
runDashboard.Title = value;      runDashboard.Title(value);
public static RunSummary Title(RunSummary runSummary, string value) #

Sets RunSummary.Title: The literal run name.

Parameters

runSummary ConsoleMonster.Widgets.RunSummary required
The instance.
value string required
The value.

Returns

RunSummary The same instance.

Examples

// C# initializer or property    // C# fluent
runSummary.Title = value;        runSummary.Title(value);
public static RunView Title(RunView runView, string? value) #

Sets RunView.Title: A title above the summary line (markup), or null.

Parameters

runView ConsoleMonster.Widgets.RunView required
The instance.
value string? required
The value.

Returns

RunView The same instance.

Examples

// C# initializer or property    // C# fluent
runView.Title = value;           runView.Title(value);
public static Sparkline Title(Sparkline sparkline, string? value) #

Sets Sparkline.Title: A caption shown on the left (markup), or null.

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance.
value string? required
The value.

Returns

Sparkline The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.Sparkline { Title = value };    sparkline.Title(value);
public static Tree Title(Tree tree, string? value) #

Sets Tree.Title: The root title (markup); null hides the root while preserving its children.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value string? required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                 // C# fluent
new global::ConsoleMonster.Widgets.Tree { Title = value };    Ui.Tree().Title(value);
public static ViewHeader Title(ViewHeader viewHeader, string value) #

Sets ViewHeader.Title: The literal title.

Parameters

viewHeader ConsoleMonster.Widgets.ViewHeader required
The instance.
value string required
The value.

Returns

ViewHeader The same instance.

Examples

// C# initializer or property    // C# fluent
viewHeader.Title = value;        viewHeader.Title(value);
public static WatchView Title(WatchView watchView, string? value) #

Sets WatchView.Title: What is being watched, shown in the heading (markup), or null.

Parameters

watchView ConsoleMonster.Widgets.WatchView required
The instance.
value string? required
The value.

Returns

WatchView The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.WatchView { Title = value };    watchView.Title(value);
public static ChartOptions Title(ChartOptions chartOptions, string? value) #

Sets ChartOptions.Title: The sparkline caption shown before the trend.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value string? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                         // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Title = value };    Ui.Chart().Title(value);
public static TSelf TitleIndent<TSelf>(TSelf table, int? value) #

Sets Table.TitleIndent: Optional grid-title indentation in cells; null retains the border-aligned default. Record and card views retain their own title layout.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value int? required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.Table { TitleIndent = value };    Ui.Table().TitleIndent(value);
public static TSelf Title<TSelf>(TSelf table, string? value) #

Sets Table.Title: A title shown above the table (markup).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value string? required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                  // C# fluent
new global::ConsoleMonster.Widgets.Table { Title = value };    Ui.Table().Title(value);
public static Calendar Today(Calendar calendar, DateTime? value) #

Sets Calendar.Today: The civil date to emphasize as today; null leaves all dates neutral.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance.
value System.DateTime? required
The value.

Returns

Calendar The same instance.

Examples

// C# initializer or property    // C# fluent
calendar.Today = value;          Ui.Calendar().Today(value);
public static TableRowRole Tone(TableRowRole tableRowRole, ThemeToken? value) #

Sets TableRowRole.Tone: An optional theme role for every cell in the row.

Parameters

tableRowRole ConsoleMonster.Widgets.TableRowRole required
The instance.
value ConsoleMonster.Styling.ThemeToken? required
The value.

Returns

TableRowRole The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.TableRowRole { Tone = value };    tableRowRole.Tone(value);
public static HelpView Topic(HelpView helpView, Action<HelpTopic> configure) #

Configures HelpView.Topic in place: The help shown.

Parameters

helpView ConsoleMonster.Widgets.HelpView required
The instance.
configure System.Action<ConsoleMonster.Help.HelpTopic> required
Configures the value.

Returns

HelpView The same instance.
Total 3 overloads
public static ProgressBar Total(ProgressBar progressBar, double value) #

Sets ProgressBar.Total: The total (default 100).

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value double required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { Total = value };    progressBar.Total(value);
public static ProgressOptions Total(ProgressOptions progressOptions, double value) #

Sets ProgressOptions.Total: The planned total.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value double required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Total = value };    Ui.Progress().Total(value);
public static Lane Total(Lane lane, double value) #

Sets Lane.Total: Planned steps (0 = unknown).

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value double required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Total = value;              lane.Total(value);
public static TSelf TotalLabel<TSelf>(TSelf table, string? value) #

Sets Table.TotalLabel: The label of the totals row, or null (default) for the built-in word (Total in English).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value string? required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.Table { TotalLabel = value };    Ui.Table().TotalLabel(value);
public static TSelf TotalRowCount<TSelf>(TSelf table, int? value) #

Sets Table.TotalRowCount: The total number of records when the caller added only some of them (for example the first 50 of 1,234), so the footer can say Showing 50 of 1,234; null when every record was added.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value int? required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Table { TotalRowCount = value };    Ui.Table().TotalRowCount(value);
public static TSelf Totals<TSelf>(TSelf table, string? label = null) #

Adds a totals row that sums every numeric column (Table.ShowTotals with Table.AutoTotals); columns with their own TableColumn.Aggregate keep it.

Type Parameters

TSelf
The table type.

Parameters

table TSelf required
The table.
label string? = null optional
The label of the totals row, or null for the built-in word.

Returns

TSelf The same table.
Transient 2 overloads
public static Lanes Transient(Lanes lanes, bool value) #

Sets 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 required
The instance.
value bool required
The value.

Returns

Lanes The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.Lanes { Transient = value };    Ui.Lanes().Transient(value);
public static Lanes Transient(Lanes lanes) #

Sets Lanes.Transient to true.

Parameters

lanes ConsoleMonster.Widgets.Lanes required
The instance to configure.

Returns

Lanes The same instance.
TruncateLabelInMiddle 2 overloads
public static TreeNode TruncateLabelInMiddle(TreeNode treeNode, bool value) #

Sets TreeNode.TruncateLabelInMiddle: Use a middle ellipsis for this identity label, independently of sibling prose labels.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value bool required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property              // C# fluent
treeNode.TruncateLabelInMiddle = value;    treeNode.TruncateLabelInMiddle(value);
public static TreeNode TruncateLabelInMiddle(TreeNode treeNode) #

Sets TreeNode.TruncateLabelInMiddle to true.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance to configure.

Returns

TreeNode The same instance.
TruncateLabelsInMiddle 2 overloads
public static Tree TruncateLabelsInMiddle(Tree tree, bool value) #

Sets Tree.TruncateLabelsInMiddle: Use a middle ellipsis for shortened identity labels, preserving both ends (default false).

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value bool required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Widgets.Tree { TruncateLabelsInMiddle = value };    Ui.Tree().TruncateLabelsInMiddle(value);
public static Tree TruncateLabelsInMiddle(Tree tree) #

Sets Tree.TruncateLabelsInMiddle to true.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance to configure.

Returns

Tree The same instance.
TruncateNotesInMiddle 2 overloads
public static Tree TruncateNotesInMiddle(Tree tree, bool value) #

Sets Tree.TruncateNotesInMiddle: Use the rendering context's middle ellipsis for shortened notes and value notes, preserving both ends (default false). Labels keep priority; wrapped notes continue to wrap.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value bool required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                                 // C# fluent
new global::ConsoleMonster.Widgets.Tree { TruncateNotesInMiddle = value };    Ui.Tree().TruncateNotesInMiddle(value);
public static Tree TruncateNotesInMiddle(Tree tree) #

Sets Tree.TruncateNotesInMiddle to true.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance to configure.

Returns

Tree The same instance.
public static ChartOptions Type(ChartOptions chartOptions, ChartType value) #

Sets ChartOptions.Type: The numeric chart kind.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value ConsoleMonster.Widgets.ChartType required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Type = value };    Ui.Chart().Type(value);
Unit 5 overloads
public static BarChart Unit(BarChart barChart, string? value) #

Sets BarChart.Unit: A unit appended to values (for example ms).

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value string? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Widgets.BarChart { Unit = value };    barChart.Unit(value);
public static Histogram Unit(Histogram histogram, string? value) #

Sets Histogram.Unit: A unit for bucket labels (for example s).

Parameters

histogram ConsoleMonster.Widgets.Histogram required
The instance.
value string? required
The value.

Returns

Histogram The same instance.

Examples

// C# initializer or property    // C# fluent
histogram.Unit = value;          histogram.Unit(value);
public static LineChart Unit(LineChart lineChart, string? value) #

Sets LineChart.Unit: A unit appended to axis labels.

Parameters

lineChart ConsoleMonster.Widgets.LineChart required
The instance.
value string? required
The value.

Returns

LineChart The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.LineChart { Unit = value };    lineChart.Unit(value);
public static Sparkline Unit(Sparkline sparkline, string? value) #

Sets Sparkline.Unit: A unit appended to the latest value.

Parameters

sparkline ConsoleMonster.Widgets.Sparkline required
The instance.
value string? required
The value.

Returns

Sparkline The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.Sparkline { Unit = value };    sparkline.Unit(value);
public static ChartOptions Unit(ChartOptions chartOptions, string? value) #

Sets ChartOptions.Unit: The unit on numeric labels.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value string? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Unit = value };    Ui.Chart().Unit(value);
public static TableColumn UnknownText(TableColumn tableColumn, string? value) #

Sets TableColumn.UnknownText: Literal text for missing evidence, or null to keep the ordinary null presenter.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value string? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property       // C# fluent
tableColumn.UnknownText = value;    tableColumn.UnknownText(value);
Value 6 overloads
public static ProgressBar Value(ProgressBar progressBar, double value) #

Sets ProgressBar.Value: The current value.

Parameters

progressBar ConsoleMonster.Widgets.ProgressBar required
The instance.
value double required
The value.

Returns

ProgressBar The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.ProgressBar { Value = value };    progressBar.Value(value);
public static ScoreGauge Value(ScoreGauge scoreGauge, double value) #

Sets ScoreGauge.Value: The engine's score.

Parameters

scoreGauge ConsoleMonster.Widgets.ScoreGauge required
The instance.
value double required
The value.

Returns

ScoreGauge The same instance.

Examples

// C# initializer or property    // C# fluent
scoreGauge.Value = value;        scoreGauge.Value(value);
public static ProgressOptions Value(ProgressOptions progressOptions, double value) #

Sets ProgressOptions.Value: The initial completed value.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value double required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { Value = value };    Ui.Progress().Value(value);
public static ChartItem Value(ChartItem chartItem, double value) #

Sets ChartItem.Value: The value.

Parameters

chartItem ConsoleMonster.Widgets.ChartItem required
The instance.
value double required
The value.

Returns

ChartItem The same instance.

Examples

// C# initializer or property    // C# fluent
chartItem.Value = value;         chartItem.Value(value);
public static Lane Value(Lane lane, double value) #

Sets Lane.Value: Completed steps.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value double required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Value = value;              lane.Value(value);
public static TreeNode Value(TreeNode treeNode, TableCell? value) #

Sets TreeNode.Value: A value shown after the label through TreeNode.Presenter (dates, sizes, statuses...), or null.

Parameters

treeNode ConsoleMonster.Widgets.TreeNode required
The instance.
value ConsoleMonster.Widgets.TableCell? required
The value.

Returns

TreeNode The same instance.

Examples

// C# initializer or property    // C# fluent
treeNode.Value = value;          treeNode.Value(value);
ValueColumn 4 overloads
public static BarChart ValueColumn(BarChart barChart, ColumnFormat value) #

Sets BarChart.ValueColumn: Layout of the value column on the right (default right-aligned). Its numeric width never shrinks during a session, so the bars keep their scale when a value grows from 9 to 10. Missing explanations use only the current frame's available space and do not reserve width after a measurement arrives.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value ConsoleMonster.Layout.ColumnFormat required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.BarChart { ValueColumn = value };    barChart.ValueColumn(value);
public static BarChart ValueColumn(BarChart barChart, Action<ColumnFormat> configure) #

Configures BarChart.ValueColumn in place: Layout of the value column on the right (default right-aligned). Its numeric width never shrinks during a session, so the bars keep their scale when a value grows from 9 to 10. Missing explanations use only the current frame's available space and do not reserve width after a measurement arrives.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

BarChart The same instance.
public static ChartOptions ValueColumn(ChartOptions chartOptions, ColumnFormat? value) #

Sets ChartOptions.ValueColumn: The bar numeric-column format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value ConsoleMonster.Layout.ColumnFormat? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { ValueColumn = value };    Ui.Chart().ValueColumn(value);
public static ChartOptions ValueColumn(ChartOptions chartOptions, Action<ColumnFormat> configure) #

Configures ChartOptions.ValueColumn in place: The bar numeric-column format.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> required
Configures the value.

Returns

ChartOptions The same instance.
public static BarChart ValueHeader(BarChart barChart, string? value) #

Sets BarChart.ValueHeader: Optional value-column heading.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value string? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.BarChart { ValueHeader = value };    barChart.ValueHeader(value);
public static Tree ValuePlacement(Tree tree, TreeValuePlacement value) #

Sets Tree.ValuePlacement: Where value columns begin. Default views use AfterLabel.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value ConsoleMonster.Widgets.TreeValuePlacement required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.Tree { ValuePlacement = value };    Ui.Tree().ValuePlacement(value);
public static BarChart ValuePresenter(BarChart barChart, ICellPresenter? value) #

Sets BarChart.ValuePresenter: Optional presenter for measured values, such as compact durations.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value ConsoleMonster.Presenters.ICellPresenter? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                              // C# fluent
new global::ConsoleMonster.Widgets.BarChart { ValuePresenter = value };    barChart.ValuePresenter(value);
public static ChartOptions Values(ChartOptions chartOptions, double[]? value) #

Sets ChartOptions.Values: Initial numeric samples.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value double[]? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                          // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Values = value };    Ui.Chart().Values(value);
public static Calendar View(Calendar calendar, CalendarView value) #

Sets Calendar.View: Month or year presentation.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance.
value ConsoleMonster.Widgets.CalendarView required
The value.

Returns

Calendar The same instance.

Examples

// C# initializer or property    // C# fluent
calendar.View = value;           Ui.Calendar().View(value);
public static Lane Warned(Lane lane, int value) #

Sets Lane.Warned: Steps with warnings.

Parameters

lane ConsoleMonster.Widgets.Lane required
The instance.
value int required
The value.

Returns

Lane The same instance.

Examples

// C# initializer or property    // C# fluent
lane.Warned = value;             lane.Warned(value);
Warning 2 overloads
public static BarChart Warning(BarChart barChart, double? value) #

Sets BarChart.Warning: The value from which a bar is a warning (warning colour), or null. With BarChart.Critical below it, lower values are worse (free space); otherwise higher values are (disk use). An item's own colour wins.

Parameters

barChart ConsoleMonster.Widgets.BarChart required
The instance.
value double? required
The value.

Returns

BarChart The same instance.

Examples

// C# initializer or property                                       // C# fluent
new global::ConsoleMonster.Widgets.BarChart { Warning = value };    barChart.Warning(value);
public static ChartOptions Warning(ChartOptions chartOptions, double? value) #

Sets ChartOptions.Warning: The warning threshold.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value double? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                           // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { Warning = value };    Ui.Chart().Warning(value);
public static TableColumn Weight(TableColumn tableColumn, int value) #

Sets TableColumn.Weight: This column's share of the spare width when the table expands, relative to other weighted columns (0, the default, takes no weighted share). When no column has a weight, Flexible columns share the spare width, otherwise the free-text columns in proportion to their widths.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Weight = value;      tableColumn.Weight(value);
WidgetId 2 overloads
public static ProgressOptions WidgetId(ProgressOptions progressOptions, string? value) #

Sets ProgressOptions.WidgetId: The live identifier; omitted uses progress or spinner.

Parameters

progressOptions ConsoleMonster.Widgets.ProgressOptions required
The instance.
value string? required
The value.

Returns

ProgressOptions The same instance.

Examples

// C# initializer or property                                               // C# fluent
new global::ConsoleMonster.Widgets.ProgressOptions { WidgetId = value };    Ui.Progress().WidgetId(value);
public static ChartOptions WidgetId(ChartOptions chartOptions, string? value) #

Sets ChartOptions.WidgetId: The live identifier; omitted uses the chart kind.

Parameters

chartOptions ConsoleMonster.Widgets.ChartOptions required
The instance.
value string? required
The value.

Returns

ChartOptions The same instance.

Examples

// C# initializer or property                                            // C# fluent
new global::ConsoleMonster.Widgets.ChartOptions { WidgetId = value };    Ui.Chart().WidgetId(value);
Width 2 overloads
public static ScoreGauge Width(ScoreGauge scoreGauge, int value) #

Sets ScoreGauge.Width: A fixed gauge width, or zero for 24 cells at wide widths and 20 at narrow widths.

Parameters

scoreGauge ConsoleMonster.Widgets.ScoreGauge required
The instance.
value int required
The value.

Returns

ScoreGauge The same instance.

Examples

// C# initializer or property    // C# fluent
scoreGauge.Width = value;        scoreGauge.Width(value);
public static TableColumn Width(TableColumn tableColumn, int? value) #

Sets TableColumn.Width: A fixed width, or null.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value int? required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Width = value;       tableColumn.Width(value);
public static CellMap Window(CellMap cellMap, CellWindow value) #

Sets CellMap.Window: Which rows show when there are more than CellMap.MaxRows (default CellWindow.Head).

Parameters

cellMap ConsoleMonster.Widgets.CellMap required
The instance.
value ConsoleMonster.Widgets.CellMap.CellWindow required
The value.

Returns

CellMap The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.CellMap { Window = value };    Ui.CellMap().Window(value);
Wrap 6 overloads
public static CodeView Wrap(CodeView codeView, bool value) #

Sets CodeView.Wrap: Wraps long lines instead of truncating them.

Parameters

codeView ConsoleMonster.Widgets.CodeView required
The instance.
value bool required
The value.

Returns

CodeView The same instance.

Examples

// C# initializer or property    // C# fluent
codeView.Wrap = value;           codeView.Wrap(value);
public static CodeView Wrap(CodeView codeView) #

Sets CodeView.Wrap to true.

Parameters

codeView ConsoleMonster.Widgets.CodeView required
The instance to configure.

Returns

CodeView The same instance.
public static LogRegion Wrap(LogRegion logRegion, bool value) #

Sets LogRegion.Wrap: Whether long entries continue on further rows, aligned under the message, instead of being truncated (default false). Lines break after spaces, then after separators, as everywhere else.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance.
value bool required
The value.

Returns

LogRegion The same instance.

Examples

// C# initializer or property                                     // C# fluent
new global::ConsoleMonster.Widgets.LogRegion { Wrap = value };    Ui.LogRegion().Wrap(value);
public static LogRegion Wrap(LogRegion logRegion) #

Sets LogRegion.Wrap to true.

Parameters

logRegion ConsoleMonster.Widgets.LogRegion required
The instance to configure.

Returns

LogRegion The same instance.
public static TableColumn Wrap(TableColumn tableColumn, bool value) #

Sets TableColumn.Wrap: Whether values may wrap onto several lines when space is short (default true). Setting it maps to TableColumn.Overflow: true is ColumnOverflow.Wrap, false is ColumnOverflow.Never (identifiers keep their width while other columns give way).

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance.
value bool required
The value.

Returns

TableColumn The same instance.

Examples

// C# initializer or property    // C# fluent
tableColumn.Wrap = value;        tableColumn.Wrap(value);
public static TableColumn Wrap(TableColumn tableColumn) #

Sets TableColumn.Wrap to true.

Parameters

tableColumn ConsoleMonster.Widgets.TableColumn required
The instance to configure.

Returns

TableColumn The same instance.
WrapHeaders``1 2 overloads
public static TSelf WrapHeaders<TSelf>(TSelf table, bool value) #

Sets Table.WrapHeaders: Wrap column headings instead of shortening them (default false).

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value bool required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                        // C# fluent
new global::ConsoleMonster.Widgets.Table { WrapHeaders = value };    Ui.Table().WrapHeaders(value);
public static TSelf WrapHeaders<TSelf>(TSelf table) #

Sets Table.WrapHeaders to true.

Type Parameters

TSelf

Parameters

table TSelf required
The instance to configure.

Returns

TSelf The same instance.
WrapLabels 2 overloads
public static Tree WrapLabels(Tree tree, bool value) #

Sets Tree.WrapLabels: Wrap labels, values and notes with a hanging indent instead of shortening them (default false).

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance.
value bool required
The value.

Returns

Tree The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.Tree { WrapLabels = value };    Ui.Tree().WrapLabels(value);
public static Tree WrapLabels(Tree tree) #

Sets Tree.WrapLabels to true.

Parameters

tree ConsoleMonster.Widgets.Tree required
The instance to configure.

Returns

Tree The same instance.
public static TSelf WrapLines<TSelf>(TSelf table, int value) #

Sets Table.WrapLines: The most lines a wrapped value uses when its column sets no TableColumn.MaxLines (default 3; 0 = no limit): a long description stays a few lines with an ellipsis instead of taking the screen.

Type Parameters

TSelf

Parameters

table TSelf required
The instance.
value int required
The value.

Returns

TSelf The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Widgets.Table { WrapLines = value };    Ui.Table().WrapLines(value);
public static TextBlock WrapSeparator(TextBlock textBlock, string? value) #

Sets TextBlock.WrapSeparator: When set, wrap at this literal separator before breaking within an oversized entry.

Parameters

textBlock ConsoleMonster.Widgets.TextBlock required
The instance.
value string? required
The value.

Returns

TextBlock The same instance.

Examples

// C# initializer or property       // C# fluent
textBlock.WrapSeparator = value;    Ui.Text().Markup().WrapSeparator(value);
public static Calendar Year(Calendar calendar, int value) #

Sets Calendar.Year: The Gregorian year.

Parameters

calendar ConsoleMonster.Widgets.Calendar required
The instance.
value int required
The value.

Returns

Calendar The same instance.

Examples

// C# initializer or property    // C# fluent
calendar.Year = value;           Ui.Calendar().Year(value);