Skip to main content

AreaChart class

Namespace: Arlecchino.Widgets.Readouts · Assembly: Arlecchino

A series drawn as a filled area over as many rows as it is given, where Sparkline fits one. A cell carries two samples side by side, so it holds twice the history a row of blocks would.

public sealed class AreaChart : IArlecchinoWidget

Implements IArlecchinoWidget

Constructors

MemberSummary
AreaChart()

Properties

MemberSummary
BandsWhere the color changes as the fill climbs, in the same units as the values and in ascending order. A chart given none is drawn in AreaChart.Style throughout.
InvertDraws it hanging from the top rather than standing on the bottom, for the second half of a mirrored pair — what comes in above, what goes out below.
MaximumThe value a full chart stands for. The largest of the drawn values when left alone.
MinimumThe value an empty chart stands for. The smallest of the drawn values when left alone.
StyleColor of the fill outside every band. The theme's active color when left alone.
SymbolsWhat to draw with, which is the application's own Glyphs.Graph when left alone. One chart can differ without every other one being told.
ValuesThe numbers to draw, the oldest first. Nothing is copied, so a ring buffer the application appends to between frames is the right thing to hand over.

Methods

MemberSummary
Draw(SurfaceRegion)Draws the chart over every row of the region and returns what is left, which is nothing. A chart fills what it is given, so hand over the pane it belongs in.

Constructors in detail

AreaChart()

public AreaChart();

Properties in detail

Bands

public IReadOnlyList<GaugeBand> Bands { get; init; }

Where the color changes as the fill climbs, in the same units as the values and in ascending order. A chart given none is drawn in AreaChart.Style throughout.

Type IReadOnlyList<T><GaugeBand>

Invert

public bool Invert { get; init; }

Draws it hanging from the top rather than standing on the bottom, for the second half of a mirrored pair — what comes in above, what goes out below.

Type bool

Maximum

public Nullable<decimal> Maximum { get; init; }

The value a full chart stands for. The largest of the drawn values when left alone.

Type Nullable<T><decimal>

Minimum

public Nullable<decimal> Minimum { get; init; }

The value an empty chart stands for. The smallest of the drawn values when left alone.

Type Nullable<T><decimal>

Style

public IArlecchinoColor? Style { get; init; }

Color of the fill outside every band. The theme's active color when left alone.

Type IArlecchinoColor

Symbols

public Nullable<GraphSymbols> Symbols { get; set; }

What to draw with, which is the application's own Glyphs.Graph when left alone. One chart can differ without every other one being told.

Type Nullable<T><GraphSymbols>

Values

public IReadOnlyList<decimal> Values { get; set; }

The numbers to draw, the oldest first. Nothing is copied, so a ring buffer the application appends to between frames is the right thing to hand over.

Type IReadOnlyList<T><decimal>

Methods in detail

Draw(SurfaceRegion)

public SurfaceRegion Draw(SurfaceRegion region);

Draws the chart over every row of the region and returns what is left, which is nothing. A chart fills what it is given, so hand over the pane it belongs in.

Parameters

NameTypeDescription
regionSurfaceRegionWhere to draw.

Returns SurfaceRegion — An empty region.