Interface: AxisConfig

Defined in: types.ts:19

Extended by

• YAxisOptions

Properties

addTicks?

optional addTicks?: (number | Tick)[];

Defined in: types.ts:23

Extra ticks layered on top of the auto ticks (only used when ticks is not set).

---

axisLineColor?

optional axisLineColor?: string;

Defined in: types.ts:35

Axis line color. Default: the per-axis color, else theme.axis.

---

axisLineWidth?

optional axisLineWidth?: number;

Defined in: types.ts:37

Axis line width in px. Default 1.

---

format?

optional format?: (value) => string;

Defined in: types.ts:25

Formats a numeric tick value into a label when the tick has no explicit label.

Parameters

Parameter	Type
value	number

Returns

string

---

gridColor?

optional gridColor?: string;

Defined in: types.ts:61

Major grid line color. Default theme.grid.

---

gridDash?

optional gridDash?: number[];

Defined in: types.ts:65

Grid line dash pattern (Canvas setLineDash). Default solid.

---

gridMinorColor?

optional gridMinorColor?: string;

Defined in: types.ts:67

Minor grid line color. Default theme.gridMinor.

---

gridWidth?

optional gridWidth?: number;

Defined in: types.ts:63

Grid line width in px. Default 1.

---

labelColor?

optional labelColor?: string;

Defined in: types.ts:47

Tick label color. Default: the per-axis color, else theme.text.

---

labelFont?

optional labelFont?: string;

Defined in: types.ts:49

Tick label font (CSS font shorthand). Default theme.font.

---

labelRotation?

optional labelRotation?: number;

Defined in: types.ts:51

Rotate tick labels by this many degrees. Default 0.

---

labelStandoff?

optional labelStandoff?: number;

Defined in: types.ts:53

Gap in px between a tick and its label. Default 3.

---

minorTicks?

optional minorTicks?: number | boolean;

Defined in: types.ts:27

Auto minor ticks: true for a default count, or a number of subdivisions per major interval.

---

showAxisLine?

optional showAxisLine?: boolean;

Defined in: types.ts:33

Draw the axis line. Default true.

---

showGrid?

optional showGrid?: boolean;

Defined in: types.ts:59

Draw grid lines for this axis. Default true.

---

showTicks?

optional showTicks?: boolean;

Defined in: types.ts:39

Draw tick marks. Default true.

---

tickColor?

optional tickColor?: string;

Defined in: types.ts:41

Tick mark color. Default: the per-axis color, else theme.axis.

---

tickLength?

optional tickLength?: number;

Defined in: types.ts:43

Major tick length in px. Default 5 (minor ticks are 3).

---

ticks?

optional ticks?: TicksSpec;

Defined in: types.ts:21

Ticks: an array of positions, an array of Tick objects, or a generator fn.

---

tickWidth?

optional tickWidth?: number;

Defined in: types.ts:45

Tick mark line width in px. Default 1.

---

title?

optional title?: string;

Defined in: types.ts:29

Axis title, drawn along the axis.

---

titleColor?

optional titleColor?: string;

Defined in: types.ts:55

Axis title color. Default: the per-axis color, else theme.text.

---

titleFont?

optional titleFont?: string;

Defined in: types.ts:57

Axis title font (CSS font shorthand). Default theme.font.