Skip to content

registerYAxis(yAxis) ​

registerYAxis used to custom y-axis.

Reference ​

typescript
(
  yAxis: {
    name: string
    reverse?: boolean
    inside?: boolean
    position?: 'left' | 'right'
    scrollZoomEnabled?: boolean
    gap?: {
      top?: number
      bottom?: number
    }
    valueToRealValue?: (value: number, params: object) => number
    realValueToDisplayValue?: (value: number, params: object) => number
    displayValueToRealValue?: (value: number, params: object) => number
    realValueToValue?: (value: number, params: object) => number
    displayValueToText?: (value: number, precision: number) => string
    minSpan?: (precision: number) => number
    createRange?: (params: object) => ({
      from: number
      to: number
      range: number
      realFrom: number
      realTo: number
      realRange: number
      displayFrom: number
      displayTo: number
      displayRange: number
    })
    createTicks?: (params: object) => Array<{
      coord: number
      value: number | string
      text: string
    }>
  }
) => void

Parameters ​

  • yAxis Y-axis configuration.
    • name Name, a unique identifier used for creation or modification.
    • reverse Whether it is inverted.
    • inside Whether it is inside.
    • position Position, supports left and right .
    • scrollZoomEnabled Whether scrolling and zooming are possible on the axis.
    • gap Top and bottom margin configuration.
      • top Top margin.
      • bottom Bottom margin.
    • valueToRealValue The value is converted into real value callback method.
    • realValueToDisplayValue The real value is converted into display value callback method.
    • displayValueToRealValue The display value is converted into real value callback method.
    • realValueToValue The real value is converted into value callback method.
    • displayValueToText The callback method that converts the display value into display text.
    • minSpan Minimum span calculation callback method.
    • createRange Create an axis value range callback method.
    • createTicks Create ticks information callback method.

čŋ”回å€ŧ ​

registerYAxis returns undefined .

Usage ​

Basic usage ​