uncharted v0.2.0

Uncharted.Axes.MagnitudeAxis (uncharted v0.2.0) View Source

Exposes a struct representing configuration for an axis that has values that increase in a particular direction

Link to this section Summary

Types

grid_lines_func()

A function that takes a tuple with a minimum and maximum value that represents the min and max of a grid axis and a step value. This function is used to determine the spacial offsets of the labels on the axis and the gridlines of the chart.

max()
min()
step()
t()

Functions

default_grid_lines_fun(arg, step)

The default function used to determine spacial offsets of labels along an axis, as well as grid_lines going across a chart.

Link to this section Types

Link to this type

grid_lines_func()

View Source

Specs

grid_lines_func() :: ({min(), max()}, step() -> [Float.t()])

A function that takes a tuple with a minimum and maximum value that represents the min and max of a grid axis and a step value. This function is used to determine the spacial offsets of the labels on the axis and the gridlines of the chart.

Link to this type

max()

View Source

Specs

max() :: number()
Link to this type

min()

View Source

Specs

min() :: number()
Link to this type

step()

View Source

Specs

step() :: integer()
Link to this type

t()

View Source

Specs

t() :: %Uncharted.Axes.MagnitudeAxis{
  grid_lines: grid_lines_func(),
  label: String.t() | nil,
  max: number(),
  min: number(),
  step: integer()
}

Link to this section Functions

Link to this function

default_grid_lines_fun(arg, step)

View Source

Specs

default_grid_lines_fun({min(), max()}, step()) :: [Float.t()]

The default function used to determine spacial offsets of labels along an axis, as well as grid_lines going across a chart.

If you do not specify a different grid_lines_func function when you create a Uncharted.Axes.MagnitudeAxis struct, this implementation will be provided used.