Class Axis

Namespace

MiniTui

Assembly

MiniTui.dll

One axis of a ChartBuilder (1.x spec §8.4).

public sealed record Axis : IEquatable<Axis>

Inheritance

object

Axis

Implements

IEquatable<Axis>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Formatter

Formats the default labels' values, instead of LabelFormat (1.x spec §19.4).

public Func<double, string>? Formatter { get; init; }

Property Value

Func<double, string>

Grid

Draw a dotted line across the plot at each label, behind the data (1.x spec §19.5).

public bool Grid { get; init; }

Property Value

bool

LabelCount

How many labels to spread along the axis when Labels is null. Default 3, at least 2.

public int LabelCount { get; init; }

Property Value

int

LabelFormat

The .NET numeric format of the default labels, in the invariant culture. Default "0.##".

public string LabelFormat { get; init; }

Property Value

string

Labels

Labels spread evenly along the axis, or null for LabelCount of them from Min to Max.

public IReadOnlyList<string>? Labels { get; init; }

Property Value

IReadOnlyList<string>

Max

The value at the end of the axis, or null for the largest value in the data.

public double? Max { get; init; }

Property Value

double?

Min

The value at the start of the axis, or null for the smallest value in the data.

public double? Min { get; init; }

Property Value

double?

Ticks

Draw a tick on the axis line at each label: ┬ on the X axis, ┤ on the Y axis (1.x spec §19.5).

public bool Ticks { get; init; }

Property Value

bool

Title

The axis title, or null for none.

public string? Title { get; init; }

Property Value

string

Methods

Duration(string)

An axis of durations: values are seconds, labelled with a TimeSpan format, with - before negative ones (1.x spec §19.4).

public static Axis Duration(string format = "m\\:ss")

Parameters

format string

Returns

Axis

Time(string)

An axis of times: values are seconds since the Unix epoch (ChartTime), labelled in local time with a DateTime format in the invariant culture (1.x spec §19.4).

public static Axis Time(string format = "HH:mm:ss")

Parameters

format string

Returns

Axis