Skip to content
Main Navigation Guide
Chart API
Instance API
ProPreviewCustomizeSponsor
9.x Docs
8.x Docs

🇬🇧 English

🇨🇳 简体中文

🇬🇧 English

🇨🇳 简体中文

Appearance

Sidebar Navigation

getDom

getSize

setStyles

getStyles

setFormatter

getFormatter

setLocale

getLocale

setTimezone

getTimezone

setThousandsSeparator

getThousandsSeparator

setDecimalFold

getDecimalFold

setOffsetRightDistance

getOffsetRightDistance

setMaxOffsetLeftDistance

setMaxOffsetRightDistance

setLeftMinVisibleBarCount

setRightMinVisibleBarCount

setBarSpace

getBarSpace

setSymbol

getSymbol

setPeriod

getPeriod

setDataLoader

resetData

getDataList

getVisibleRange

createIndicator

overrideIndicator

getIndicators

removeIndicator

createOverlay

overrideOverlay

getOverlays

removeOverlay

setPaneOptions

getPaneOptions

setZoomEnabled

isZoomEnabled

setScrollEnabled

isScrollEnabled

scrollByDistance

scrollToRealTime

scrollToDataIndex

scrollToTimestamp

zoomAtCoordinate

zoomAtDataIndex

zoomAtTimestamp

convertToPixel

convertFromPixel

executeAction

subscribeAction

unsubscribeAction

getConvertPictureUrl

resize

On this page

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 ​

Edit this page on GitHub

Last updated:

Pager
Previous pageremoveOverlay
Next pagegetPaneOptions

Released under the Apache License V2.

Copyright © 2018-2025 liihuu