ExRatatui.Widgets.Chart.Axis (ExRatatui v0.8.2)

Copy Markdown View Source

Configures one axis of a ExRatatui.Widgets.Chart.

:bounds is required — it defines the visible coordinate range for this axis as {min, max}. Tick :labels are rendered along the axis in order; for a typical line chart you'd supply three labels (min, mid, max) for each axis.

Labels accept the same string / %Span{} / %Line{} types used elsewhere in the library.

Fields

  • :title - optional axis caption (string, %Span{}, or %Line{})
  • :bounds - required {min, max} numeric tuple
  • :labels - list of tick labels (default [])
  • :style - %ExRatatui.Style{} for the axis line and labels
  • :labels_alignment - :left (default), :center, or :right

Examples

iex> alias ExRatatui.Widgets.Chart.Axis
iex> %Axis{title: "X", bounds: {0.0, 10.0}, labels: ["0", "5", "10"]}
%ExRatatui.Widgets.Chart.Axis{
  title: "X",
  bounds: {0.0, 10.0},
  labels: ["0", "5", "10"],
  style: %ExRatatui.Style{},
  labels_alignment: :left
}

Summary

Types

alignment()
line_like()
t()

Types

alignment()

@type alignment() :: :left | :center | :right

line_like()

@type line_like() :: String.t() | ExRatatui.Text.Span.t() | ExRatatui.Text.Line.t()

t()

@type t() :: %ExRatatui.Widgets.Chart.Axis{
  bounds: {number(), number()},
  labels: [line_like()],
  labels_alignment: alignment(),
  style: ExRatatui.Style.t(),
  title: line_like() | nil
}