Skip to content

overrideYAxis(options)

overrideYAxis set the y-axis configuration.

Reference

typescript
(
  yAxis?: {
    paneId?: string
    id?: string
    name?: string
    reverse?: boolean
    inside?: boolean
    needWidget?: boolean
    position?: 'left' | 'right'
    scrollZoomEnabled?: boolean
    gap?: {
      top?: number
      bottom?: 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

  • options Y-axis configuration.
    • paneId Pane id.
    • id Y-axis id.
    • name The name of the axis.
    • reverse Whether to reverse.
    • inside Whether it is inside.
    • needWidget Whether to create an axis widget.
    • position Position, supports left and right.
    • scrollZoomEnabled Whether to allow scrolling and zooming.
    • gap Top and bottom margin configuration.
      • top Top margin.
      • bottom Bottom margin.
    • createRange Create an axis value range callback method.
    • createTicks Create ticks information callback method.

Returns

overrideYAxis returns undefined .

Usage

Basic attrs

Custom ticks