init(ds, options?)
init 用于初始化一个图表。
提示
• 调用时,需要等待容器准备完成之后。
参考
typescript
(
ds: string | HTMLElement,
options?: {
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
}
}
}
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' }
hotkey?: {
enabled?: boolean
exclude?: string[]
}
}
) => Chart参数
ds容器,可以是dom元素或者元素id。options可选配置项。layout自定义布局配置。barSpaceLimit柱间距限制。min柱间距最小值。max柱间距最大值。
pane默认窗口配置。height高度。minHeight最小高度。dragEnabled是否可以拖拽调整高度。order顺序。state状态,支持normal,maximize和minimize。
yAxis默认 y 轴配置。reverse是否反向。inside是否在内部。needWidget是否需要创建轴组件。position位置,支持left和right。scrollZoomEnabled是否允许在 Y 轴上滚动和缩放。gap上下边距配置。top上边距。bottom下边距。
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 }。hotkey快捷键配置。enabled是否启用快捷键。exclude排除的全局快捷键名称列表。
返回值
init 返回一个图表实例对象 Chart。