Class

MatrixFluent

ConsoleMonster.Widgets

Namespace: ConsoleMonster.Widgets
Assembly: ConsoleMonster
Modifiers: static
Attributes: GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of Matrix, 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
MatrixFluent

Methods

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 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);

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 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);

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);

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.

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 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 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 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);

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);

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.

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 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 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 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);

ShowLegend 2 overloads

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.

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.

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);

Inheritance

Methods

Inherited Methods