Skip to content

YAxisConfig

Example

ts
{
  side: 'right',
  width: 80,
  border: { color: '#ddd', width: 1, style: 'solid' },
  labels: { padding: 6 }
}

Properties

side

  • Type: 'left' | 'right'
  • Default: 'right'

Which side of the panel the y-axis is rendered on.

width

  • Type: number
  • Default: 80

Width of the y-axis in pixels.

border

Configuration for the border drawn along the inner edge of the y-axis. Set to false to hide the border, or provide a LineConfig object for custom styling.

labels

Configuration for the value labels rendered along the y-axis. Set to false to hide labels, or provide a ValueLabelConfig object for custom styling.

TypeScript

ts
interface YAxisConfig {
  side?: 'left' | 'right';
  width?: number;
  border?: false | LineConfig;
  labels?: false | ValueLabelConfig;
}

React Candlesticks is available on npm and GitHub under the MIT License.