Skip to content

setLayoutOptions(layout) ​

setLayoutOptions set the chart default layout options. It only affects panes and y-axes created after the call, existing panes and y-axes remain unchanged. Incremental values ​​are supported.

Reference ​

typescript
(
  layout: {
    barSpaceLimit?: {
      min?: number
      max?: number
    }
    pane?: {
      height?: number
      minHeight?: number
      dragEnabled?: boolean
      order?: number
      state?: 'normal' | 'maximize' | 'minimize'
    }
    yAxis?: {
      reverse?: boolean
      inside?: boolean
      needWidget?: boolean
      position?: 'left' | 'right'
      scrollZoomEnabled?: boolean
      gap?: {
        top?: number
        bottom?: number
      }
    }
  }
) => void

Parameters ​

  • layout Layout options.
    • barSpaceLimit Bar space limit.
    • pane Pane default options.
    • yAxis Y-axis default options.

Returns ​

setLayoutOptions returns undefined .

Usage ​

Basic ​