Skip to main content

Interface: AxisOptions

Properties​

type​

• Optional type: AxisType

Defined in​

core/types.ts:82


low​

• Optional low: number

Overriding the natural low of the chart allows you to zoom in or limit the charts lowest displayed value

Defined in​

core/types.ts:86


high​

• Optional high: number

Overriding the natural high of the chart allows you to zoom in or limit the charts highest displayed value

Defined in​

core/types.ts:90


referenceValue​

• Optional referenceValue: number

Unless low/high are explicitly set, bar chart will be centered at zero by default. Set referenceValue to null to auto scale.

Defined in​

core/types.ts:94


offset​

• Optional offset: number

The offset of the chart drawing area to the border of the container

Defined in​

core/types.ts:98


position​

• Optional position: "start" | "end"

Position where labels are placed. Can be set to start or end where start is equivalent to left or top on vertical axis and end is equivalent to right or bottom on horizontal axis.

Defined in​

core/types.ts:103


labelOffset​

• Optional labelOffset: Object

Allows you to correct label positioning on this axis by positive or negative x and y offset.

Type declaration​

NameType
xnumber
ynumber

Defined in​

core/types.ts:107


showLabel​

• Optional showLabel: boolean

If labels should be shown or not

Defined in​

core/types.ts:114


showGrid​

• Optional showGrid: boolean

If the axis grid should be drawn or not

Defined in​

core/types.ts:118


scaleMinSpace​

• Optional scaleMinSpace: number

This value specifies the minimum width in pixel of the scale steps

Defined in​

core/types.ts:126


onlyInteger​

• Optional onlyInteger: boolean

Use only integer values (whole numbers) for the scale steps

Defined in​

core/types.ts:130


ticks​

• Optional ticks: Label[]

Defined in​

core/types.ts:131


stretch​

• Optional stretch: boolean

Defined in​

core/types.ts:132


divisor​

• Optional divisor: number

Defined in​

core/types.ts:133


highLow​

• Optional highLow: Object

Type declaration​

NameType
highnumber
lownumber

Defined in​

core/types.ts:134

Methods​

labelInterpolationFnc​

▸ Optional labelInterpolationFnc(value, index): undefined | null | Label

Interpolation function that allows you to intercept the value from the axis label

Parameters​

NameType
valueLabel
indexnumber

Returns​

undefined | null | Label

Defined in​

core/types.ts:122