docs: v10.0.0-alpha5 docs

liihuu · liihuu · commit 9c5814af8b31 · 2025-03-10T00:38:33.000+08:00
diff --git a/docs/@views/api/references/chart/registerIndicator.md b/docs/@views/api/references/chart/registerIndicator.md
@@ -35,16 +35,32 @@
     createTooltipDataSource?: (params: object) => ({
       name?: string
       calcParamsText?: string
-      icons?: Array<{
-        id?: string
-        position?: 'left' | 'middle' | 'right'
-        color?: string
-        activeColor?: string
-        size?: number
-        fontFamily?: string
-        icon?: string
-        backgroundColor?: string
-        activeBackgroundColor?: string
+      features?: Array<{
+         id?: string
+         position?: 'left' | 'middle' | 'right'
+         marginLeft?: number
+         marginTop?: number
+         marginRight?: number
+         marginBottom?: number
+         paddingLeft?: number
+         paddingTop?: number
+         paddingRight?: number
+         paddingBottom?: number
+         size?: number
+         color?: string
+         activeColor?: string
+         backgroundColor?: string
+         activeBackgroundColor?: string
+         type?: 'path' | 'iconFont'
+         path?: {
+           style?: 'stroke' | 'fill'
+           path?: string
+           lineWidth?: number
+         }
+         iconFont?: {
+           content?: string
+           family?: string
+         }
       }>
       legends?: Array<{
         title: string |
@@ -60,6 +76,7 @@
       }>
     })
     draw?: (params: object) => boolean
+    onClick?: (params: object) => void
     onDataStateChange?: (params: object) => void
   }
 ) => void
diff --git a/docs/@views/api/references/instance/createIndicator.md b/docs/@views/api/references/instance/createIndicator.md
@@ -36,16 +36,32 @@
     createTooltipDataSource?: (params: object) => ({
       name?: string
       calcParamsText?: string
-      icons?: Array<{
+      features?: Array<{
         id?: string
         position?: 'left' | 'middle' | 'right'
+        marginLeft?: number
+        marginTop?: number
+        marginRight?: number
+        marginBottom?: number
+        paddingLeft?: number
+        paddingTop?: number
+        paddingRight?: number
+        paddingBottom?: number
+        size?: number
         color?: string
         activeColor?: string
-        size?: number
-        fontFamily?: string
-        icon?: string
         backgroundColor?: string
         activeBackgroundColor?: string
+        type?: 'path' | 'iconFont'
+        path?: {
+          style?: 'stroke' | 'fill'
+          path?: string
+          lineWidth?: number
+        }
+        iconFont?: {
+          content?: string
+          family?: string
+        }
       }>
       legends?: Array<{
         title: string |
@@ -61,6 +77,7 @@
       }>
     })
     draw?: (params: object) => boolean
+    onClick?: (params: object) => void
     onDataStateChange?: (params: object) => void
   },
   isStack?: boolean,
diff --git a/docs/@views/api/references/instance/overrideIndicator.md b/docs/@views/api/references/instance/overrideIndicator.md
@@ -37,16 +37,32 @@
     createTooltipDataSource?: (params: object) => ({
       name?: string
       calcParamsText?: string
-      icons?: Array<{
+      features?: Array<{
         id?: string
         position?: 'left' | 'middle' | 'right'
+        marginLeft?: number
+        marginTop?: number
+        marginRight?: number
+        marginBottom?: number
+        paddingLeft?: number
+        paddingTop?: number
+        paddingRight?: number
+        paddingBottom?: number
+        size?: number
         color?: string
         activeColor?: string
-        size?: number
-        fontFamily?: string
-        icon?: string
         backgroundColor?: string
         activeBackgroundColor?: string
+        type?: 'path' | 'iconFont'
+        path?: {
+          style?: 'stroke' | 'fill'
+          path?: string
+          lineWidth?: number
+        }
+        iconFont?: {
+          content?: string
+          family?: string
+        }
       }>
       legends?: Array<{
         title: string |
@@ -62,6 +78,7 @@
       }>
     })
     draw?: (params: object) => boolean
+    onClick?: (params: object) => void
     onDataStateChange?: (params: object) => void
   }
 ) => void
diff --git a/docs/@views/api/references/instance/subscribeAction.md b/docs/@views/api/references/instance/subscribeAction.md
@@ -3,7 +3,7 @@
   type: 'onZoom' |
     'onScroll' |
     'onVisibleRangeChange' |
-    'onTooltipIconClick' |
+    'onCandleTooltipFeatureClick' |
     'onCrosshairChange' |
     'onCandleBarClick' |
     'onPaneDrag',
diff --git a/docs/@views/api/references/instance/unsubscribeAction.md b/docs/@views/api/references/instance/unsubscribeAction.md
@@ -3,7 +3,7 @@
   type: 'onZoom' |
     'onScroll' |
     'onVisibleRangeChange' |
-    'onTooltipIconClick' |
+    'onCandleTooltipFeatureClick' |
     'onCrosshairChange' |
     'onCandleBarClick' |
     'onPaneDrag',
diff --git a/docs/@views/styles/config.md b/docs/@views/styles/config.md
@@ -157,24 +157,33 @@ const styles = {
       },
       // e.g.
       // [{
-      //   id: 'icon_id',
-      //   position: 'left', // 'left', 'middle', 'right'
-      //   marginLeft: 8,
-      //   marginTop: 6,
-      //   marginRight: 0,
-      //   marginBottom: 0,
-      //   paddingLeft: 1,
-      //   paddingTop: 1,
-      //   paddingRight: 1,
-      //   paddingBottom: 1,
-      //   icon: '\ue900',
-      //   fontFamily: 'iconfont',
-      //   size: 12,
-      //   color: '#76808F',
-      //   backgroundColor: 'rgba(33, 150, 243, 0.2)',
-      //   activeBackgroundColor: 'rgba(33, 150, 243, 0.4)'
+      //    id: 'icon_id',
+      //    position: 'left', // 'left', 'middle', 'right'
+      //    marginLeft: 8,
+      //    marginTop: 6,
+      //    marginRight: 0,
+      //    marginBottom: 0,
+      //    paddingLeft: 1,
+      //    paddingTop: 1,
+      //    paddingRight: 1,
+      //    paddingBottom: 1,
+      //    size: 12,
+      //    color: '#76808F',
+      //    activeColor: '#76808F',
+      //    backgroundColor: 'rgba(33, 150, 243, 0.2)',
+      //    activeBackgroundColor: 'rgba(33, 150, 243, 0.4)',
+      //    type: 'path', // 'path', 'iconFont'
+      //    path: {
+      //      style: 'stroke', // 'stroke', 'fill'
+      //      path: 'M6.81029,6.02908L11.7878,1.02746C12.0193,0.79483,12.0193,0.445881,11.7878,0.213247C11.5563,-0.019386,11.209,-0.019386,10.9775,0.213247L6,5.21486L1.02251,0.174475C0.790997,-0.0581583,0.44373,-0.0581583,0.212219,0.174475C-0.0192925,0.407108,-0.0192925,0.756058,0.212219,0.988691L5.18971,6.02908L0.173633,11.0307C-0.0578778,11.2633,-0.0578778,11.6123,0.173633,11.8449C0.289389,11.9612,0.44373,12,0.598071,12C0.752411,12,0.906752,11.9612,1.02251,11.8449L6,6.8433L10.9775,11.8449C11.0932,11.9612,11.2476,12,11.4019,12C11.5563,12,11.7106,11.9612,11.8264,11.8449C12.0579,11.6123,12.0579,11.2633,11.8264,11.0307L6.81029,6.02908Z',
+      //      lineWidth: 1,
+      //    },
+      //    iconFont: {
+      //      content: '\ue900',
+      //      family: 'iconfont'
+      //    }
       // }]
-      icons: []
+      features: []
     }
   },
   indicator: {
@@ -286,24 +295,33 @@ const styles = {
       },
       // e.g.
       // [{
-      //   id: 'icon_id',
-      //   position: 'left', // 'left', 'middle', 'right'
-      //   marginLeft: 8,
-      //   marginTop: 6,
-      //   marginRight: 0,
-      //   marginBottom: 0,
-      //   paddingLeft: 1,
-      //   paddingTop: 1,
-      //   paddingRight: 1,
-      //   paddingBottom: 1,
-      //   icon: '\ue900',
-      //   fontFamily: 'iconfont',
-      //   size: 12,
-      //   color: '#76808F',
-      //   backgroundColor: 'rgba(33, 150, 243, 0.2)',
-      //   activeBackgroundColor: 'rgba(33, 150, 243, 0.4)'
+      //    id: 'icon_id',
+      //    position: 'left', // 'left', 'middle', 'right'
+      //    marginLeft: 8,
+      //    marginTop: 6,
+      //    marginRight: 0,
+      //    marginBottom: 0,
+      //    paddingLeft: 1,
+      //    paddingTop: 1,
+      //    paddingRight: 1,
+      //    paddingBottom: 1,
+      //    size: 12,
+      //    color: '#76808F',
+      //    activeColor: '#76808F',
+      //    backgroundColor: 'rgba(33, 150, 243, 0.2)',
+      //    activeBackgroundColor: 'rgba(33, 150, 243, 0.4)',
+      //    type: 'path', // 'path', 'iconFont'
+      //    path: {
+      //      style: 'stroke', // 'stroke', 'fill'
+      //      path: 'M6.81029,6.02908L11.7878,1.02746C12.0193,0.79483,12.0193,0.445881,11.7878,0.213247C11.5563,-0.019386,11.209,-0.019386,10.9775,0.213247L6,5.21486L1.02251,0.174475C0.790997,-0.0581583,0.44373,-0.0581583,0.212219,0.174475C-0.0192925,0.407108,-0.0192925,0.756058,0.212219,0.988691L5.18971,6.02908L0.173633,11.0307C-0.0578778,11.2633,-0.0578778,11.6123,0.173633,11.8449C0.289389,11.9612,0.44373,12,0.598071,12C0.752411,12,0.906752,11.9612,1.02251,11.8449L6,6.8433L10.9775,11.8449C11.0932,11.9612,11.2476,12,11.4019,12C11.5563,12,11.7106,11.9612,11.8264,11.8449C12.0579,11.6123,12.0579,11.2633,11.8264,11.0307L6.81029,6.02908Z',
+      //      lineWidth: 1,
+      //    },
+      //    iconFont: {
+      //      content: '\ue900',
+      //      family: 'iconfont'
+      //    }
       // }]
-      icons: []
+      features: []
     }
   },
   xAxis: {
diff --git a/docs/api/chart/registerIndicator.md b/docs/api/chart/registerIndicator.md
@@ -34,6 +34,7 @@ outline: deep
   - `regenerateFigures` 重新生成基础图形配置，当 `calcParams` 变化时触发，返回值类型同 `figures` 。
   - `createTooltipDataSource` 创建自定义的提示信息。
   - `draw` 自定义绘制方法，如果返回值是 `true` ，则会覆盖默认的绘制。
+  - `onClick` 点击事件。
   - `onDataStateChange` 数据变化回调通知。
 
 ### 返回值 {#returns}
diff --git a/docs/api/instance/createIndicator.md b/docs/api/instance/createIndicator.md
@@ -35,6 +35,7 @@ outline: deep
   - `regenerateFigures` 重新生成基础图形配置，当 `calcParams` 变化时触发，返回值类型同 `figures` 。
   - `createTooltipDataSource` 创建自定义的提示信息。
   - `draw` 自定义绘制方法，如果返回值是 `true` ，则会覆盖默认的绘制。
+  - `onClick` 点击事件。
   - `onDataStateChange` 数据变化回调通知。
 - `isStack` 是否叠加。
 - `paneOptions` 窗口配置。
diff --git a/docs/api/instance/overrideIndicator.md b/docs/api/instance/overrideIndicator.md
@@ -36,6 +36,7 @@ outline: deep
   - `regenerateFigures` 重新生成基础图形配置，当 `calcParams` 变化时触发，返回值类型同 `figures` 。
   - `createTooltipDataSource` 创建自定义的提示信息。
   - `draw` 自定义绘制方法，如果返回值是 `true` ，则会覆盖默认的绘制。
+  - `onClick` 点击事件。
   - `onDataStateChange` 数据变化回调通知。
 
 ::: tip 提示
diff --git a/docs/api/instance/subscribeAction.md b/docs/api/instance/subscribeAction.md
@@ -9,7 +9,7 @@ outline: deep
 <!-- @include: @/@views/api/references/instance/subscribeAction.md -->
 
 ### 参数 {#parameters}
-- `type` 类型，支持 `onZoom` ， `onScroll` ， `onVisibleRangeChange` ， `onTooltipIconClick` ， `onCrosshairChange` ， `onCandleBarClick` 和 `onPaneDrag` 。
+- `type` 类型，支持 `onZoom` ， `onScroll` ， `onVisibleRangeChange` ， `onCandleTooltipFeatureClick` ， `onCrosshairChange` ， `onCandleBarClick` 和 `onPaneDrag` 。
 - `cb` 回调方法。
 
 ### 返回值 {#returns}
diff --git a/docs/api/instance/unsubscribeAction.md b/docs/api/instance/unsubscribeAction.md
@@ -9,7 +9,7 @@ outline: deep
 <!-- @include: @/@views/api/references/instance/unsubscribeAction.md -->
 
 ### 参数 {#parameters}
-- `type` 类型，支持 `onZoom` ， `onScroll` ， `onVisibleRangeChange` ， `onTooltipIconClick` ， `onCrosshairChange` ， `onCandleBarClick` 和 `onPaneDrag` 。
+- `type` 类型，支持 `onZoom` ， `onScroll` ， `onVisibleRangeChange` ， `onCandleTooltipFeatureClick` ， `onCrosshairChange` ， `onCandleBarClick` 和 `onPaneDrag` 。
 - `cb` 订阅时的回调方法，缺省则取消当前类型所有。
 
 ### 返回值 {#returns}
diff --git a/docs/en-US/api/chart/registerIndicator.md b/docs/en-US/api/chart/registerIndicator.md
@@ -34,6 +34,7 @@ outline: deep
   - `regenerateFigures` Regenerates the basic graphics configuration. This is triggered when `calcParams` changes. The return value type is the same as `figures` .
   - `createTooltipDataSource` Create custom prompts.
   - `draw` Custom drawing method, if the return value is `true`, it will override the default drawing.
+  - `onClick` Click event.
   - `onDataStateChange` Data change callback notification.
 
 ### Returns {#returns}
diff --git a/docs/en-US/api/instance/createIndicator.md b/docs/en-US/api/instance/createIndicator.md
@@ -35,6 +35,7 @@ outline: deep
   - `regenerateFigures` Regenerates the basic graphics configuration. This is triggered when `calcParams` changes. The return value type is the same as `figures` .
   - `createTooltipDataSource` Create custom prompts.
   - `draw` Custom drawing method, if the return value is `true`, it will override the default drawing.
+  - `onClick` Click event.
   - `onDataStateChange` Data change callback notification.
 - `isStack` Whether to stack.
 - `paneOptions` Pane configuration.
diff --git a/docs/en-US/api/instance/overrideIndicator.md b/docs/en-US/api/instance/overrideIndicator.md
@@ -36,6 +36,7 @@ outline: deep
   - `regenerateFigures` Regenerates the basic graphics configuration. This is triggered when `calcParams` changes. The return value type is the same as `figures` .
   - `createTooltipDataSource` Create custom prompts.
   - `draw` Custom drawing method, if the return value is `true`, it will override the default drawing.
+  - `onClick` Click event.
   - `onDataStateChange` Data change callback notification.
   
 ::: tip Tip
diff --git a/docs/en-US/api/instance/subscribeAction.md b/docs/en-US/api/instance/subscribeAction.md
@@ -9,7 +9,7 @@ outline: deep
 <!-- @include: @/@views/api/references/instance/subscribeAction.md -->
 
 ### Parameters {#parameters}
-- `type` Type, supports `onZoom`, `onScroll`, `onVisibleRangeChange`, `onTooltipIconClick`, `onCrosshairChange`, `onCandleBarClick` and `onPaneDrag` .
+- `type` Type, supports `onZoom`, `onScroll`, `onVisibleRangeChange`, `onCandleTooltipFeatureClick`, `onCrosshairChange`, `onCandleBarClick` and `onPaneDrag` .
 - `cb` Callback.
 
 ### Returns {#returns}
diff --git a/docs/en-US/api/instance/unsubscribeAction.md b/docs/en-US/api/instance/unsubscribeAction.md
@@ -9,7 +9,7 @@ outline: deep
 <!-- @include: @/@views/api/references/instance/unsubscribeAction.md -->
 
 ### Parameters {#parameters}
-- `type` Type, supports `onZoom`, `onScroll`, `onVisibleRangeChange`, `onTooltipIconClick`, `onCrosshairChange`, `onCandleBarClick` and `onPaneDrag` .
+- `type` Type, supports `onZoom`, `onScroll`, `onVisibleRangeChange`, `onCandleTooltipFeatureClick`, `onCrosshairChange`, `onCandleBarClick` and `onPaneDrag` .
 - `cb` The callback method when subscribing. By default, all subscriptions of the current type are canceled.
 
 ### Returns {#returns}
diff --git a/docs/en-US/guide/changelog.md b/docs/en-US/guide/changelog.md
@@ -1,5 +1,13 @@
 # 📠 Change Log
 
+## 10.0.0-alpha5
+`2025-03-09`
++ 👉 Style configuration `candle.tooltip.icons` changed to `candle.tooltip.features`, `indicator.tooltip.icons` changed to `indicator.tooltip.features`.
++ 👉 `icons` in the return value of the `createTooltipDataSource` method in the indicator changed to `features`.
++ 👉 The instance api `subscribeAction` and `unsubscribeAction` input parameter `onTooltipIconClick` changed to `onCandleTooltipFeatureClick`, and the indicator event is replaced by `indicator.onClick`.
++ 🐞 Fixed the problem that scrolling cannot be performed in certain situations on mobile terminals.
++ 💄 Optimize the display of overlay event response.
+
 ## 10.0.0-alpha4
 `2025-02-23`
 + 🐞 Fix the issue that the parameter `more.backward` of `applyNewData` instance method is incorrect.
diff --git a/docs/guide/changelog.md b/docs/guide/changelog.md
@@ -1,5 +1,13 @@
 # 📠 更新日志
 
+## 10.0.0-alpha5
+`2025-03-09`
++ 👉 样式配置 `candle.tooltip.icons` 变更为 `candle.tooltip.features` ， `indicator.tooltip.icons` 变更为 `indicator.tooltip.features` 。
++ 👉 指标中的 `createTooltipDataSource` 方法返回值中的 `icons` 变更为 `features` 。
++ 👉 实例api `subscribeAction` 和 `unsubscribeAction` 入参 `onTooltipIconClick` 变更为 `onCandleTooltipFeatureClick` ，指标的事件用 `indicator.onClick` 代替。
++ 🐞 修复移动端特定情况下无法滚动问题。
++ 💄 优化覆盖物事件响应显示。
+
 ## 10.0.0-alpha4
 `2025-02-23`
 + 🐞 修复实例方法 `applyNewData` 入参 `more.backward` 不对问题。
diff --git a/docs/guide/v9-to-v10.md b/docs/guide/v9-to-v10.md
@@ -4,6 +4,7 @@
 ## 样式配置调整
 + 删除 `yAxis.position` ， `yAxis.type` ， `yAxis.inside` 和 `yAxis.inside` ，请使用窗口配置 `axis` 中的属性代替。详情参阅图表API [init(dcs, options)](/api/chart/init#parameters) ，实例API [createIndicator(value, isStack, paneOptions)](/api/instance/createIndicator#parameters) 和 [setPaneOptions(options)](/api/instance/setPaneOptions#parameters) 。
 + 删除 `overlay.rectText` 。
++ `candle.tooltip.icons` 变更为 `candle.tooltip.features` ， `indicator.tooltip.icons` 变更为 `indicator.tooltip.features` 。
 
 ## API调整
 
@@ -16,10 +17,12 @@
 + 删除 `applyMoreData(dataList, more, callback)` ， `setLoadDataCallback(cb)` 和 `loadMore(cb)` ，请使用 `setLoadMoreDataCallback(cb)` 代替。
 + 删除 `getIndicatorByPaneId(paneId, name)` ，请使用 `getIndicators(filter)` 代替。
 + 删除 `getOverlayById(id)` ，请使用 `getOverlays(filter)` 代替。
++ 删除 `subscribeAction` 和 `unsubscribeAction` 中的 `onTooltipIconClick` ，请使用 `onCandleTooltipFeatureClick` 和指标中的 `onClick` 代替。
 + `applyNewData(dataList, more, callback)` 变更为 `applyNewData(dataList, more)` 。
 + `updateData(data, callback)` 变更为 `updateData(data)` 。
 + `getBarSpace()` 返回值变更为对象。
++ `createIndicator` 返回值变更为返回指标id。
 
 ## 自定义扩展调整
-+ 指标 `createTooltipDataSource` 方法返回值 `values` 变更为 `legends` 。
++ 指标 `createTooltipDataSource` 方法返回值 `values` 变更为 `legends` ， `icons` 变更为 `features`。
 + 删除内置的基础图形 `rectText` ，请使用 `text` 代替。
diff --git a/package.json b/package.json
