Skip to content
ConsoleMonster

API Reference

Class

CellMapFluent

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

The fluent methods of CellMap, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • Object
  • CellMapFluent

Methods

public static CellMap WithGap(CellMap cellMap, Int32 value) #
Returns: CellMap

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

Parameters

cellMap ConsoleMonster.Widgets.CellMap requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static CellMap WithMaxRows(CellMap cellMap, Int32 value) #
Returns: CellMap

Sets CellMap.MaxRows: The most rows of cells (0 = all); a last line then counts the items not shown.

Parameters

cellMap ConsoleMonster.Widgets.CellMap requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static CellMap WithShowLegend(CellMap cellMap, Boolean value = true) #
Returns: CellMap

Sets CellMap.ShowLegend: Whether a legend line with each state's count follows the cells (default true).

Parameters

cellMap ConsoleMonster.Widgets.CellMap requiredposition: 0
The instance.
value System.Boolean = true optionalposition: 1
The value (default true).

Returns

The same instance.

public static CellMap WithSpinRunning(CellMap cellMap, Boolean value = true) #
Returns: CellMap

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 requiredposition: 0
The instance.
value System.Boolean = true optionalposition: 1
The value (default true).

Returns

The same instance.

public static CellMap WithWindow(CellMap cellMap, CellWindow value) #
Returns: CellMap

Sets CellMap.Window: Which rows show when there are more than CellMap.MaxRows (default CellWindow.Head).

Parameters

cellMap ConsoleMonster.Widgets.CellMap requiredposition: 0
The instance.
value ConsoleMonster.Widgets.CellMap.CellWindow requiredposition: 1
The value.

Returns

The same instance.