Documentation menu

Class

Axis

An axis of a FerroPlot.

Methods

applyOptions

applyOptions(options: AxisOptions): void;

Changes options; absent keys keep their value. A new type starts from that type's defaults (grid, margins).

options

options(): Required<AxisOptions>;

The current options (every key).

setCategories

setCategories(labels: string[]): void;

Labels of a category axis: category k is labels[k].

setView

setView(lo: number, hi: number): void;

Shows lo..hi (the axis stops following the data until fit()). Sends no viewChange event.

view

view(): [
    number,
    number
];

The visible range [lo, hi] as of the last frame.

Like every object of the API, a Axis holds WebAssembly memory. Objects returned by the chart are freed with it; free() (or using) releases one earlier.