docs: v8.5.0 docs

klinecharts · May 28, 2022 · e141745 · e141745
1 parent d34bfff
commit e141745
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 0 deletions.
diff --git a/docs/en/changelog.md b/docs/en/changelog.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## 8.5.0
+`2022-05-29`
++ 🆕 Instance api add `getDom`, `scrollToTimestamp` and `zoomAtTimestamp`.
++ 🆕 Style configuration add `yAxis.reverse`.
++ 🐞 Fix typescript reference issue.
+
 ## 8.3.6
 `2022-03-23`
 + 🐞 Fix shape issues on the mobile.

diff --git a/docs/en/instance-api.md b/docs/en/instance-api.md
@@ -1,5 +1,12 @@
 # Instance API
 
+### getDom(finder)
+Get container dom.
+- `finder` returns the root container by default, `{ paneId, position }`
+  - `pandId` pane id
+  - `position` optional parameters 'root', 'content' and 'yAxis'
+
+
 ### getWidth()
 Get chart width.
 
@@ -433,6 +440,11 @@ Scroll to data index.
 -`dataIndex` the index of the data
 -`animationDuration` animation time, can be default
 
+### scrollToTimestamp(timestamp, animationDuration)
+Scroll to timestamp.
+-`timestamp` timestamp
+-`animationDuration` animation time, can be default
+
 
 ### zoomAtCoordinate(scale, coordinate, animationDuration)
 Zoom at coordinate.
@@ -448,6 +460,13 @@ Zoom at data index.
 -`animationDuration` animation time, can be defaulted, the default is no animation
 
 
+### zoomAtTimestamp(scale, timestamp, animationDuration)
+Zoom at timestamp.
+-`scale` scaling ratio
+-`timestamp` timestamp
+-`animationDuration` animation time, can be defaulted, the default is no animation
+
+
 ### setPaneOptions(options)
 Set pane options.
 - `options` pane options `{ id, height, dragEnabled }`

diff --git a/docs/en/styles.md b/docs/en/styles.md
@@ -208,6 +208,7 @@
     // 'normal' | 'percentage' | 'log'
     type: 'normal',
     inside: false,
+     reverse: false,
     axisLine: {
       show: true,
       color: '#888888',

diff --git a/docs/zh-CN/changelog.md b/docs/zh-CN/changelog.md
@@ -1,4 +1,10 @@
 # 更新日志
+## 8.5.0
+`2022-05-29`
++ 🆕 图表实例新增方法`getDom`，`scrollToTimestamp`和`zoomAtTimestamp`。
++ 🆕 样式配置新增`yAxis.reverse`。
++ 🐞 修复typescript引用问题。
+
 
 ## 8.3.6
 `2022-03-23`

diff --git a/docs/zh-CN/instance-api.md b/docs/zh-CN/instance-api.md
@@ -1,5 +1,12 @@
 # 实例API
 
+### getDom(finder)
+获取dom容器
+- `finder` 过滤条件，缺省返回根容器，`{ paneId, position }`
+  - `pandId` 窗口id
+  - `position` 位置，可选参数'root'，'content'和'yAxis'
+
+
 ### getWidth()
 获取图表宽度。
 
@@ -428,6 +435,11 @@ chart.createHtml({
 - `dataIndex` 数据的索引
 - `animationDuration` 动画时间，可以缺省，缺省则无动画
 
+### scrollToTimestamp(timestamp, animationDuration)
+滚动到指定时间戳。
+- `timestamp` 时间戳
+- `animationDuration` 动画时间，可以缺省，缺省则无动画
+
 
 ### zoomAtCoordinate(scale, coordinate, animationDuration)
 在某个坐标点缩放。
@@ -443,6 +455,13 @@ chart.createHtml({
 - `animationDuration` 动画时间，可以缺省，缺省则无动画
 
 
+### zoomAtTimestamp(scale, timestamp, animationDuration)
+在指定时间戳上缩放。
+- `scale` 缩放比例
+- `timestamp` 时间戳
+- `animationDuration` 动画时间，可以缺省，缺省则无动画
+
+
 ### setPaneOptions(options)
 设置窗口配置。
 - `options` 窗口配置 `{ id, height, dragEnabled }`

diff --git a/docs/zh-CN/styles.md b/docs/zh-CN/styles.md
@@ -227,6 +227,7 @@
     // 'normal' | 'percentage' | 'log'
     type: 'normal',
     inside: false,
+    reverse: false,
     // y轴线
     axisLine: {
       show: true,