Skip to content

setPaneOptions(options) ​

setPaneOptions set the pane configuration.

Reference ​

typescript
(
  options?: {
    id?: string
    height?: number
    minHeight?: number
    dragEnabled?: boolean
    order?: number
    state?: 'normal' | 'maximize' | 'minimize'
    axis?: {
      name?: string
      reverse?: boolean
      inside?: 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 Pane configuration.
    • id Pane id.
    • height Height.
    • minHeight Min height.
    • dragEnabled Whether the height can be adjusted by dragging.
    • order Order.
    • state State, supports normal , maximize and minimize .
    • axis Axis configuration.
      • name The name of the axis.
      • reverse Whether to reverse.
      • inside Whether it is inside.
      • 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 ​

setPaneOptions returns undefined .

Usage ​

Basic usage ​

Height cannot be adjusted ​

Minimize the window ​

Set basic properties of the axis ​

Simple custom axis ​