BreakdownChart Class
A renderable breakdown chart.
public sealed class BreakdownChart : Renderable, IRenderable, IHasCulture, IExpandable
- Namespace
- Spectre
.Console - Interfaces
- Base Types
Constructors
-
BreakdownChart
() -
Initializes a new instance of the
BreakdownChart
class.
Properties
- bool Compact
- Gets or sets a value indicating whether or not the chart and tags should be rendered in compact mode.
- CultureInfo Culture
-
Gets or sets the
CultureInfo
to use when rendering values. - List<IBreakdownChartItem> Data
- Gets the breakdown chart data.
- bool Expand
-
Gets or sets a value indicating whether or not the object should
expand to the available space. If
false
, the object's width will be auto calculated. - bool ShowTags
- Gets or sets a value indicating whether or not to show tags.
- bool ShowTagValues
- Gets or sets a value indicating whether or not to show tag values.
- Color ValueColor
- Gets or sets the Color in which the values will be shown.
- Func<double, CultureInfo, string> ValueFormatter
- Gets or sets the tag value formatter.
- int? Width
- Gets or sets the width of the breakdown chart.
Methods
-
protected override Measurement Measure
(RenderOptions, int) - Measures the renderable object.
-
protected override IEnumerable<Segment> Render
(RenderOptions, int) - Renders the object.
Extension Methods
-
BreakdownChart AddItem
(string, double, Color) - Adds an item to the breakdown chart.
-
BreakdownChart AddItem
<T> (T) - Adds an item to the breakdown chart.
-
BreakdownChart AddItems
<T> (IEnumerable <T> , Func <T, I Breakdown Chart Item> ) - Adds multiple items to the breakdown chart.
-
BreakdownChart AddItems
<T> (IEnumerable <T> ) - Adds multiple items to the breakdown chart.
-
T Collapse
< Breakdown Chart> () - Tells the specified object to not expand to the available area but take as little space as possible.
-
BreakdownChart Compact
(bool) - Sets whether or not the chart and tags should be rendered in compact mode.
-
BreakdownChart Compact
() - Chart and tags is rendered in compact mode.
-
T Culture
< Breakdown Chart> (CultureInfo) - Sets the culture.
-
T Culture
< Breakdown Chart> (int) - Sets the culture.
-
T Culture
< Breakdown Chart> (string) - Sets the culture.
-
T Expand
< Breakdown Chart> () - Tells the specified object to expand to the available area.
-
BreakdownChart FullSize
() - Chart and tags is rendered in full size mode.
-
IEnumerable<Segment> GetSegments
(IAnsiConsole) - Gets the segments for a renderable using the specified console.
-
BreakdownChart HideTags
() - Tags will be not be shown.
-
BreakdownChart HideTagValues
() - Tag values will be not be shown.
-
BreakdownChart ShowPercentage
() - Tags will be shown.
-
BreakdownChart ShowTags
(bool) - Sets whether or not tags will be shown.
-
BreakdownChart ShowTags
() - Tags will be shown.
-
BreakdownChart ShowTagValues
(bool) - Sets whether or not tag values will be shown.
-
BreakdownChart ShowTagValues
() - Tag values will be shown.
-
BreakdownChart UseValueFormatter
(Func <double, CultureInfo, string> ) - Tags will be shown.
-
BreakdownChart UseValueFormatter
(Func <double, string> ) - Tags will be shown.
-
BreakdownChart Width
(int?) - Sets the width of the breakdown chart.
-
BreakdownChart WithValueColor
(Color) -
Sets the
ValueColor
.