Skip to content

createYAxis(yAxis)

createYAxis 创建 y 轴。

参考

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
    }>
  }
) => string | null

参数

  • yAxis y 轴配置项。
    • paneId 窗口 id,默认为主图窗口。
    • id y 轴 id。
    • name 坐标轴名称。
    • reverse 是否反向。
    • inside 是否在内部。
    • needWidget 是否需要创建轴组件。
    • position 位置,支持 leftright
    • scrollZoomEnabled 是否允许在 Y 轴上滚动和缩放。启用后,用户可以拖动滚动轴或使用鼠标滚轮缩放。
    • gap 上下边距配置。
      • top 上边距。
      • bottom 下边距。
    • createRange 创建轴上取值范围回调方法。
    • createTicks 创建分割信息回调方法。

返回值

createYAxis 返回创建成功的 y 轴 id,创建失败返回 null

用法

基本使用