Spectre.Console

BreakdownChartExtensions

Contains extension methods for .

Contains extension methods for BreakdownChart.

Methods

public static BreakdownChart AddItem<T>(BreakdownChart chart, T item)

Adds an item to the breakdown chart.

Parameters:

chart (BreakdownChart)
The breakdown chart.
item (T)
The item.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart AddItems<T>(BreakdownChart chart, IEnumerable<T> items)

Adds multiple items to the breakdown chart.

Parameters:

chart (BreakdownChart)
The breakdown chart.
items (IEnumerable<T>)
The items.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart AddItems<T>(BreakdownChart chart, IEnumerable<T> items, Func<T, IBreakdownChartItem> converter)

Adds multiple items to the breakdown chart.

Parameters:

chart (BreakdownChart)
The breakdown chart.
items (IEnumerable<T>)
The items.
converter (Func<T, IBreakdownChartItem>)
The converter that converts instances of T to IBreakdownChartItem.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart Compact(BreakdownChart chart)

Chart and tags is rendered in compact mode.

Parameters:

chart (BreakdownChart)
The breakdown chart.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart Compact(BreakdownChart chart, bool compact)

Sets whether or not the chart and tags should be rendered in compact mode.

Parameters:

chart (BreakdownChart)
The breakdown chart.
compact (bool)
Whether or not the chart and tags should be rendered in compact mode.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart FullSize(BreakdownChart chart)

Chart and tags is rendered in full size mode.

Parameters:

chart (BreakdownChart)
The breakdown chart.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart HideTags(BreakdownChart chart)

Tags will be not be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart HideTagValues(BreakdownChart chart)

Tag values will be not be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart ShowPercentage(BreakdownChart chart)

Tags will be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart ShowTags(BreakdownChart chart)

Tags will be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart ShowTags(BreakdownChart chart, bool show)

Sets whether or not tags will be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.
show (bool)
Whether or not tags will be shown.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart ShowTagValues(BreakdownChart chart)

Tag values will be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart ShowTagValues(BreakdownChart chart, bool show)

Sets whether or not tag values will be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.
show (bool)
Whether or not tag values will be shown.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart UseValueFormatter(BreakdownChart chart, Func<double, CultureInfo, string> func)

Tags will be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.
func (Func<double, CultureInfo, string>)
The value formatter to use.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart UseValueFormatter(BreakdownChart chart, Func<double, string> func)

Tags will be shown.

Parameters:

chart (BreakdownChart)
The breakdown chart.
func (Func<double, string>)
The value formatter to use.

Returns:

The same instance so that multiple calls can be chained.

public static BreakdownChart Width(BreakdownChart chart, int? width)

Sets the width of the breakdown chart.

Parameters:

chart (BreakdownChart)
The breakdown chart.
width (int?)
The breakdown chart width.

Returns:

The same instance so that multiple calls can be chained.