Skip to main content

AxisDefinitionCommon

Common properties for value and category axes.

Extended by​

Properties​

crosshair?​

optional crosshair: boolean | CrosshairOptions

Whether to show a crosshair for this axis. If you supply 'true', defaults will be used. Otherwise you can supply options to customise the crosshair.

font?​

optional font: FontSpec

Spec for the font to use for all text on the axis. If you provide a title spec for this axis, any font settings in that spec will override these for the title.

id?​

optional id: string

Axis ID.

lineSize?​

optional lineSize: number

The width of the baseline (if visible). Defaults to 2 pixels.

position?​

optional position: AxisPosition

The position for the axis: for a Y axis, AXIS_POSITION_START means on the left (this is the default for a y axis), and AXIS_POSITION_END means on the right. For an X axis, AXIS_POSITION_START means on the top, and AXIS_POSITION_END means on the bottom (the default for an X axis).

showLine?​

optional showLine: boolean

Whether or not to show a solid line representing the axis' baseline. Defaults to false.

title?​

optional title: AxisTitleSpec

Title for the axis. Defaults to empty.