Skip to content
ConsoleMonster

API Reference

Class

BarChartFluent

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

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

Inheritance

  • Object
  • BarChartFluent

Methods

public static BarChart WithBarToken(BarChart barChart, ThemeToken value) #
Returns: BarChart

Sets BarChart.BarToken: The default bar colour (default ThemeToken.Series1).

Parameters

barChart ConsoleMonster.Widgets.BarChart requiredposition: 0
The instance.
value ConsoleMonster.Styling.ThemeToken requiredposition: 1
The value.

Returns

The same instance.

public static BarChart WithCritical(BarChart barChart, Double? value) #
Returns: BarChart

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

Parameters

barChart ConsoleMonster.Widgets.BarChart requiredposition: 0
The instance.
value System.Double? requiredposition: 1
The value.

Returns

The same instance.

public static BarChart WithMax(BarChart barChart, Double? value) #
Returns: BarChart

Sets BarChart.Max: The value of a full bar, or null for the largest item.

Parameters

barChart ConsoleMonster.Widgets.BarChart requiredposition: 0
The instance.
value System.Double? requiredposition: 1
The value.

Returns

The same instance.

public static BarChart WithShape(BarChart barChart, BarShape value) #
Returns: BarChart

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 requiredposition: 0
The instance.
value ConsoleMonster.Widgets.BarShape requiredposition: 1
The value.

Returns

The same instance.

public static BarChart WithShowValues(BarChart barChart, Boolean value = true) #
Returns: BarChart

Sets BarChart.ShowValues: Whether values are shown after the bars (default true).

Parameters

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

Returns

The same instance.

public static BarChart WithUnit(BarChart barChart, String? value) #
Returns: BarChart

Sets BarChart.Unit: A unit appended to values (for example ms).

Parameters

barChart ConsoleMonster.Widgets.BarChart requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

WithValueColumn 2 overloads
public static BarChart WithValueColumn(BarChart barChart, ColumnFormat value) #
Returns: BarChart

Sets BarChart.ValueColumn: Layout of the value column on the right (default right-aligned). Its width never shrinks during a session, so the bars keep their scale when a value grows from 9 to 10.

Parameters

barChart ConsoleMonster.Widgets.BarChart requiredposition: 0
The instance.
value ConsoleMonster.Layout.ColumnFormat requiredposition: 1
The value.

Returns

The same instance.

public static BarChart WithValueColumn(BarChart barChart, Action<ColumnFormat> configure) #
Returns: BarChart

Configures BarChart.ValueColumn in place: Layout of the value column on the right (default right-aligned). Its width never shrinks during a session, so the bars keep their scale when a value grows from 9 to 10.

Parameters

barChart ConsoleMonster.Widgets.BarChart requiredposition: 0
The instance.
configure System.Action<ConsoleMonster.Layout.ColumnFormat> requiredposition: 1
Configures the value.

Returns

The same instance.

public static BarChart WithWarning(BarChart barChart, Double? value) #
Returns: BarChart

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 requiredposition: 0
The instance.
value System.Double? requiredposition: 1
The value.

Returns

The same instance.