docs: v9.8.10 docs

klinecharts · Jun 5, 2024 · 0b7d25a · 0b7d25a
1 parent c568c11
commit 0b7d25a
Show file tree

Hide file tree

Showing 8 changed files with 77 additions and 25 deletions.
diff --git a/docs/en-US/guide/changelog.md b/docs/en-US/guide/changelog.md
@@ -1,5 +1,13 @@
 # 📠 Change Log
 
+## 9.8.10
+`2024-06-06`
++ 🐞 Fix the issue of blurry drawing of basic graphics `rect`, `line`.
++ 🐞 Fix the inaccurate zooming issue of instance methods `zoomAtCoordinate`, `zoomAtDataIndex` and `zoomAtTimestamp`.
++ 🐞 Fix the issue of possible error in x-axis zooming.
++ 💄 Optimize the instance method `subscribeAction`. When `type` is 'onScroll' and 'onZoom', the callback method adds a new parameter.
++ 💄 Optimize the sub-item `attrs` in the indicator attribute `figures`. Add callback parameter `data`.
+
 ## 9.8.9
 `2024-05-28`
 + 🐞 Fix style configuration `yAxis.type: 'percentage'` error.

diff --git a/docs/en-US/guide/chart-api.md b/docs/en-US/guide/chart-api.md
@@ -146,18 +146,19 @@ Get graph class.
          title?: string
          type?: string
          baseValue?: number
+         attrs?: ({
+            data: object
+            coordinate: object
+            bounding: object
+            barSpace: object
+            xAxis: object
+            yAxis: object
+         }) => object
          styles?: (
             data: object,
             indicator: object,
             defaultStyles: object
          ) => object
-         attrs: (
-            coordinate: object
-            bounding: Bounding
-            barSpace: BarSpace
-            xAxis: XAxis
-            yAxis: YAxis
-         ) => object
       }>
       minValue?: number
       maxValue?: number

diff --git a/docs/en-US/guide/indicator.md b/docs/en-US/guide/indicator.md
@@ -53,6 +53,7 @@ To create a custom technical indicator, you only need to generate a technical in
     baseValue?: number
     // is a method
     attrs?: ({
+      data: IndicatorFigureAttrsCallbackData
       coordinate: IndicatorFigureAttrsCallbackCoordinate
       bounding: Bounding
       barSpace: BarSpace

diff --git a/docs/en-US/guide/instance-api.md b/docs/en-US/guide/instance-api.md
@@ -296,15 +296,23 @@ Set auto load data callback
     extendData?: any
     series?: 'normal' | 'price' | 'volume'
     figures?: Array<{
-       key: string
-       title?: string
-       type?: string
-       baseValue?: number
-       styles?: (
-         data: object,
-         indicator: object,
-         defaultStyles: object
-       ) => ({
+      key: string
+      title?: string
+      type?: string
+      baseValue?: number
+      attrs?: ({
+        data: object
+        coordinate: object
+        bounding: object
+        barSpace: object
+        xAxis: object
+        yAxis: object
+      }) => object
+      styles?: (
+        data: object,
+        indicator: object,
+        defaultStyles: object
+      ) => ({
         style?: 'solid' | 'dashed' | 'stroke' | 'fill' | 'stroke_fill'
         color?: string
       })
@@ -413,6 +421,14 @@ chart.createIndicator('MA', false, {
       title?: string
       type?: string
       baseValue?: number
+      attrs?: ({
+        data: object
+        coordinate: object
+        bounding: object
+        barSpace: object
+        xAxis: object
+        yAxis: object
+      }) => object
       styles?: (
         data: object,
         indicator: object,

diff --git a/docs/guide/changelog.md b/docs/guide/changelog.md
@@ -1,5 +1,13 @@
 # 📠 更新日志
 
+## 9.8.10
+`2024-06-06`
++ 🐞 修复基础图形 `rect`, `line` 绘制模糊问题。
++ 🐞 修复实例方法 `zoomAtCoordinate`、`zoomAtDataIndex` 和 `zoomAtTimestamp`，缩放不准确问题。
++ 🐞 修复x轴缩放可能出错问题。
++ 💄 优化实例方法 `subscribeAction`，当 `type` 是 'onScroll' 和 'onZoom' 时，回调方法新增参数。
++ 💄 优化指标属性 `figures` 中的子项 `attrs`，新增回调参数 `data`。
+
 ## 9.8.9
 `2024-05-28`
 + 🐞 修复样式配置 `yAxis.type: 'percentage'` 错误。

diff --git a/docs/guide/chart-api.md b/docs/guide/chart-api.md
@@ -149,18 +149,19 @@
       title?: string
       type?: string
       baseValue?: number
+      attrs?: ({
+        data: object
+        coordinate: object
+        bounding: object
+        barSpace: object
+        xAxis: object
+        yAxis: object
+      }) => object
       styles?: (
         data: object,
         indicator: object,
         defaultStyles: object
       ) => object
-      attrs: (
-        coordinate: object
-        bounding: Bounding
-        barSpace: BarSpace
-        xAxis: XAxis
-        yAxis: YAxis
-      ) => object
     }>
     minValue?: number
     maxValue?: number

diff --git a/docs/guide/indicator.md b/docs/guide/indicator.md
@@ -53,6 +53,7 @@
     baseValue?: number
     // 是一个方法，用于生成自定义图形的属性，
     attrs?: ({
+      data: IndicatorFigureAttrsCallbackData
       coordinate: IndicatorFigureAttrsCallbackCoordinate
       bounding: Bounding
       barSpace: BarSpace

diff --git a/docs/guide/instance-api.md b/docs/guide/instance-api.md
@@ -301,14 +301,22 @@
       title?: string
       type?: string
       baseValue?: number
+      attrs?: ({
+        data: object
+        coordinate: object
+        bounding: object
+        barSpace: object
+        xAxis: object
+        yAxis: object
+      }) => object
       styles?: (
         data: object,
         indicator: object,
         defaultStyles: object
-      ) => {
+      ) => ({
         style?: 'solid' | 'dashed' | 'stroke' | 'fill' | 'stroke_fill'
         color?: string
-      }
+      })
     }>
     minValue?: number
     maxValue?: number
@@ -416,6 +424,14 @@ chart.createIndicator('MA', false, {
       title?: string
       type?: string
       baseValue?: number
+      attrs?: ({
+        data: object
+        coordinate: object
+        bounding: object
+        barSpace: object
+        xAxis: object
+        yAxis: object
+      }) => object
       styles?: (
         data: object,
         indicator: object,