A descriptor used to configure an axis when creating a figure from JS.

Hierarchy

  • AxisDescriptor

Constructors

Properties

color?: string

The axis color.

formatPattern?: string

The format pattern used to render axis values.

formatType: string | number
gapBetweenMajorTicks?: number

The gap between adjacent major ticks.

invert?: boolean

Whether to invert the axis.

isTimeAxis?: boolean

Whether this axis should be treated as a time axis.

label?: string

The axis label.

labelFont?: string

The font used to render the axis label.

log?: boolean

Whether to use logarithmic scaling.

majorTickLocations?: number[]

Explicit locations for major ticks.

When specified, these values are used as the primary (major) tick positions instead of automatically choosing major ticks.

majorTicksVisible?: boolean

Whether major ticks are visible.

Major ticks are the primary tick marks on an axis. They typically determine the main tick spacing and are often the tick marks that are labeled.

maxRange?: number

The maximum value for the axis range, or NaN to use the default.

minRange?: number

The minimum value for the axis range, or NaN to use the default.

minorTickCount?: number

The number of minor ticks between adjacent major ticks.

minorTicksVisible?: boolean

Whether minor ticks are visible.

Minor ticks are typically small, unlabeled tick marks drawn between major ticks.

position: string | number
tickLabelAngle?: number

The angle to render tick labels at.

ticksFont?: string

The font used to render tick labels.

type: string | number