Skip to content

init(ds, options?)

init 用于初始化一个图表。

提示
• 调用时,需要等待容器准备完成之后。

参考

typescript
(
  ds: string | HTMLElement,
  options?: {
    layout?: {
      basicParams?: {
        barSpaceLimitMin?: number
        barSpaceLimitMax?: number
        yAxisPosition?: 'left' | 'right'
        yAxisInside?: boolean
        paneMinHeight?: number
        paneHeight?: number
      }
      panes?: Array<{
        type: 'candle' | 'indicator' | 'xAxis'
        content?: Array<string | IndicatorCreate | {
          indicator: string | IndicatorCreate
          yAxis?: Omit<YAxisOverride, 'paneId'>
        }>
        options?: {
          id?: string
          height?: number
          minHeight?: number
          dragEnabled?: boolean
          order?: number
          state?: 'normal' | 'maximize' | 'minimize'
        }
      }>
    }
    locale?: string
    styles?: string | DeepPartial<Styles>
    timezone?: string
    formatter?: {
      formatDate?: (params: {
        dateTimeFormat: Intl.DateTimeFormat
        timestamp: number
        template: string
        type: 'tooltip' | 'crosshair' | 'xAxis'
      }) => string
      formatBigNumber?: (value: string | number) => string
      formatExtendText?: (params: {
        type: 'last_price'
        data: KLineData
        index: number
      }) => string
    }
    thousandsSeparator?: {
      sign?: string
      format: (value: number | string) => string
    }
    decimalFold?: {
      threshold?: number
      format?: (value: number | string) => string
    }
    zoomAnchor?: 'cursor' | 'last_bar' | { main?: 'cursor' | 'last_bar', xAxis?: 'cursor' | 'last_bar' }
  }
) => Chart

参数

  • ds 容器,可以是dom元素或者元素id。
  • options 可选配置项。
    • layout 自定义布局配置。
      • basicParams 布局基础参数。
        • barSpaceLimitMin 柱间距最小值。
        • barSpaceLimitMax 柱间距最大值。
        • yAxisPosition 默认 y 轴位置,支持 leftright
        • yAxisInside 默认 y 轴是否在窗口内部。
        • paneMinHeight 默认窗口最小高度。
        • paneHeight 默认窗口高度。
      • panes 自定义窗口列表。
        • type 窗口类型,支持 candleindicatorxAxis
        • content 窗口内容,仅支持指标。子项可以是指标名、指标配置,或 { indicator, yAxis }
          • indicator 指标名或指标配置。
          • yAxis 指标绑定的 y 轴配置,不需要传 paneId
        • options 窗口配置。
          • id 窗口id。
          • height 高度。
          • minHeight 最小高度。
          • dragEnabled 是否可以拖拽调整高度。
          • order 顺序。
          • state 状态,支持 normalmaximizeminimize
    • locale 语言,内置支持 zh-CNen-US
    • timezone 时区名,如 Asia/Shanghai ,如果不设置会自动获取本机时区,时区对应名字列表请参阅 时区列表
    • styles 可以是通过 klinecharts.registerStyles 注册的样式名,也可以是 StylesStyles 详情参阅 样式 ,支持增量。
    • formatter 一些格式化api。
      • formatDate 格式化日期。
      • formatBigNumber 格式化大的数字,如1000转换成1k,1000000转换为1M等。
      • formatExtendText 格式化扩展文案。
    • thousandsSeparator 千分符配置。
      • sign 标识符。
      • format 自定义格式化方法。
    • decimalFold 小数 0 折叠配置。
      • threshold 折叠阈值。
      • format 自定义格式化方法。
    • zoomAnchor 缩放锚点位置,可以是 last_barcursor ,或分别配置主图和 x 轴的对象 { main, xAxis }

返回值

init 返回一个图表实例对象 Chart

用法

基本使用

自定义布局

内置语言

自定义扩展语言

设置时区

内置样式模版

自定义样式模版

样式直接覆盖

自定义时间显示

自定义大数字显示

不显示千分符

自定义千分符显示

小数 0 不折叠

小数 0 折叠自定义显示

缩放位置