init(ds, options?)
init 用于初始化一个图表。
提示:
调用时,需要等待容器准备完成之后。参考
typescript
(
ds: string | HTMLElement,
options?: {
layout?: Array<{
type: 'candle' | 'indicator' | 'xAxis'
content?: Array<Indicator | string>
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
}>
}
}
}>
locale?: string
styles?: string | Styles
timezone?: string
formatter?: {
formatDate?: (params: {
dateTimeFormat: Intl.DateTimeFormat
timestamp: number
template: string
type: 'tooltip' | 'crosshair' | 'xAxis'
}) => string
formatBigNumber?: (value: string | number) => string
}
thousandsSeparator?: {
sign?: string
format: (value: number | string) => string
}
decimalFold?: {
threshold?: number
format?: (value: number | string) => string
}
}
) => Chart参数
ds容器,可以是dom元素或者元素id。options可选配置项。layout自定义布局,是一个数组。type窗口类型,支持candle,indicator和xAxis。content窗口内容,仅仅支持指标。options窗口配置。id窗口id。height高度。minHeight最小高度。dragEnabled是否可以拖拽调整高度。order顺序。state状态,支持normal,maximize和minimize。axis坐标轴配置。name坐标轴名称。reverse是否反向。inside是否在内部。position位置,支持left和right。scrollZoomEnabled是否允许滚动缩放。gap上下边距配置。top上边距。bottom下边距。
createRange创建轴上取值范围回调方法。如果是x轴此方法无用。createTicks创建分割信息回调方法。
locale语言,内置支持zh-CN和en-US。timezone时区名,如Asia/Shanghai,如果不设置会自动获取本机时区,时区对应名字列表请参阅 时区列表 。styles可以是通过klinecharts.registerStyles注册的样式名,也可以是Styles,Styles详情参阅 样式 ,支持增量。formatter一些格式化api。formatDate格式化日期。formatBigNumber格式化大的数字,如1000转换成1k,1000000转换为1M等。
thousandsSeparator千分符配置。sign标识符。format自定义格式化方法。
decimalFold小数 0 折叠配置。threshold折叠阈值。format自定义格式化方法。
返回值
init 返回一个图表实例对象 Chart。