Skip to content
ConsoleMonster

API Reference

Class

SparklineFluent

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

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

Inheritance

  • Object
  • SparklineFluent

Methods

public static Sparkline WithCapacity(Sparkline sparkline, Int32 value) #
Returns: Sparkline

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

Parameters

sparkline ConsoleMonster.Widgets.Sparkline requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static Sparkline WithHeight(Sparkline sparkline, Int32 value) #
Returns: Sparkline

Sets Sparkline.Height: Rows (default 1).

Parameters

sparkline ConsoleMonster.Widgets.Sparkline requiredposition: 0
The instance.
value System.Int32 requiredposition: 1
The value.

Returns

The same instance.

public static Sparkline WithLabel(Sparkline sparkline, String? value) #
Returns: Sparkline

Sets Sparkline.Label: A label shown on the left (markup), or null.

Parameters

sparkline ConsoleMonster.Widgets.Sparkline requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static Sparkline WithMax(Sparkline sparkline, Double? value) #
Returns: Sparkline

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

Parameters

sparkline ConsoleMonster.Widgets.Sparkline requiredposition: 0
The instance.
value System.Double? requiredposition: 1
The value.

Returns

The same instance.

public static Sparkline WithShowLatest(Sparkline sparkline, Boolean value = true) #
Returns: Sparkline

Sets Sparkline.ShowLatest: Whether the latest value is shown on the right (default true).

Parameters

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

Returns

The same instance.

public static Sparkline WithToken(Sparkline sparkline, ThemeToken value) #
Returns: Sparkline

Sets Sparkline.Token: The colour token (default ThemeToken.Accent).

Parameters

sparkline ConsoleMonster.Widgets.Sparkline requiredposition: 0
The instance.
value ConsoleMonster.Styling.ThemeToken requiredposition: 1
The value.

Returns

The same instance.

public static Sparkline WithUnit(Sparkline sparkline, String? value) #
Returns: Sparkline

Sets Sparkline.Unit: A unit appended to the latest value.

Parameters

sparkline ConsoleMonster.Widgets.Sparkline requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.