Class: AxisLabels

AxisLabels(userOptions)

new AxisLabels(userOptions)

HTML element containing evenly spaced labels intended to be used as a subelement for Axis.

Parameters:
Name Type Description
userOptions AxisLabels.Options

User provided options for the axis which extends module:Element~Options

Source:
To Do:
  • We need some way to control precision, or at least provide an automatic human-readable value for label text

Extends

  • module:Element

Members

(static) deserialize

Clear any existing, then append an equal number of labels, spaced evenly, to this element.

Source:

Type Definitions

Options

These are the options specific to this class. Other options provided by Element.Options can also be passed to create an Axis.

Properties:
Name Type Description
axis AxisLocation

Axis location

range Array.<Number>

Min and max values of axis scale [min, max]

flipDirection Boolean

If true, the axis direction will be flipped with respect to the default direction

numLabels Number

Number of labels that will be displayed on the axis

Source: