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 轴位置,支持left和right。yAxisInside默认 y 轴是否在窗口内部。paneMinHeight默认窗口最小高度。paneHeight默认窗口高度。
panes自定义窗口列表。type窗口类型,支持candle,indicator和xAxis。content窗口内容,仅支持指标。子项可以是指标名、指标配置,或{ indicator, yAxis }。indicator指标名或指标配置。yAxis指标绑定的 y 轴配置,不需要传paneId。
options窗口配置。id窗口id。height高度。minHeight最小高度。dragEnabled是否可以拖拽调整高度。order顺序。state状态,支持normal,maximize和minimize。
locale语言,内置支持zh-CN和en-US。timezone时区名,如Asia/Shanghai,如果不设置会自动获取本机时区,时区对应名字列表请参阅 时区列表 。styles可以是通过klinecharts.registerStyles注册的样式名,也可以是Styles,Styles详情参阅 样式 ,支持增量。formatter一些格式化api。formatDate格式化日期。formatBigNumber格式化大的数字,如1000转换成1k,1000000转换为1M等。formatExtendText格式化扩展文案。
thousandsSeparator千分符配置。sign标识符。format自定义格式化方法。
decimalFold小数 0 折叠配置。threshold折叠阈值。format自定义格式化方法。
zoomAnchor缩放锚点位置,可以是last_bar、cursor,或分别配置主图和 x 轴的对象{ main, xAxis }。
返回值
init 返回一个图表实例对象 Chart。