API / Configuration / ChartYAxis

Defined in: src/types/chart/axis.ts:142

Extends

Properties

Property Type Description
categories? string[] -
crosshair? AxisCrosshair Configure a crosshair that follows either the mouse pointer or the hovered point.
grid? object The grid lines settings.
grid.enabled? boolean Enable or disable the grid lines. Default true
labels? ChartAxisLabels The axis labels show the number or category for each tick.
lineColor? string The color of the line marking the axis itself.
maxPadding? number Padding of the max value relative to the length of the axis. A padding of 0.05 will make a 100px axis 5px longer. Default 0.05 for Y axis, 0.01 for X axis
min? number The minimum value of the axis. If undefined the min value is automatically calculate.
plotBands? AxisPlotBand[] An array of colored bands stretching across the plot area marking an interval on the axis.
plotIndex? number Property for splitting charts. Determines which area the axis is located in.
plotLines? AxisPlotLine[] An array of lines stretching across the plot area, marking a specific value
position? "left" | "right" Axis location. Possible values - 'left' and 'right'.
ticks? object -
ticks.pixelInterval? number Pixel interval of the tick marks. Not applicable to categorized axis. The specified value is only a hint; the interval between ticks can be greater or less depending on the data.
timestamps? number[] -
title? object -
title.align? ChartAxisTitleAlignment Alignment of the title.
title.margin? number The pixel distance between the axis labels or line and the title. Default 4 for horizontal axes, 8 for vertical
title.maxRowCount? number Allows limiting of the contents of a title block to the specified number of lines. Default 1
title.style? Partial<BaseTextStyle> CSS styles for the title
title.text? string -
type? ChartAxisType -
visible? boolean Whether axis, including axis title, line, ticks and labels, should be visible.