Documentation / @ripl/charts / ChartYAxisItemOptions
Interface: ChartYAxisItemOptions<TData>
Defined in: charts/src/core/options.ts:501
Y-axis specific options extending the base axis item with a left/right position.
Extends
ChartAxisItemOptions<TData>
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
font | string | CSS font shorthand for the tick labels. | ChartAxisItemOptions.font | charts/src/core/options.ts:487 |
fontColor | string | Colour of the tick labels. | ChartAxisItemOptions.fontColor | charts/src/core/options.ts:489 |
format? | AxisFormatType | ((value) => string) | How tick values are formatted — a built-in AxisFormatType or a custom formatter. | ChartAxisItemOptions.format | charts/src/core/options.ts:497 |
position | "left" | "right" | Which side of the chart the y-axis is drawn on. | - | charts/src/core/options.ts:503 |
title? | string | Optional axis title drawn alongside the tick labels. | ChartAxisItemOptions.title | charts/src/core/options.ts:491 |
value? | keyof TData | ((item) => any) | Accessor selecting the value this axis reads from each data item. | ChartAxisItemOptions.value | charts/src/core/options.ts:494 |
visible | boolean | Whether the axis line, ticks, and labels are rendered. | ChartAxisItemOptions.visible | charts/src/core/options.ts:485 |