docs: v9.1.2 docs

klinecharts · Apr 9, 2023 · c0078f8 · c0078f8
1 parent 2b0ee79
commit c0078f8
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 17 deletions.
diff --git a/docs/en-US/guide/changelog.md b/docs/en-US/guide/changelog.md
@@ -1,4 +1,10 @@
 # 📠 Change Log
+## 9.1.2
+`2023-04-10`
++ 🐞 Fix the issue of inaccurate triggering events for the built-in figure `line`.
++ 🐞 Fix the issue of triggering events for the first time after the `simpleAnnotation` and `simpleTag` built-in overlays are drawn.
++ 💄 Optimize overlay figure to ignore events and support event selection.
+
 ## 9.1.1
 `2023-03-14`
 + 🐞 Fix the invalidity of the built-in figure `arc`.

diff --git a/docs/en-US/guide/chart-api.md b/docs/en-US/guide/chart-api.md
@@ -188,39 +188,39 @@ Get technical indicators for chart support.
       type: string,
       attrs: any | any[],
       styles?: any,
-      ignoreEvent?: boolean
+      ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    } | Array<{
       key?: string,
       type: string,
       attrs: any | any[],
       styles?: any,
-      ignoreEvent?: boolean
+      ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    }>,
    createXAxisFigures?: (params: object) => {
       key?: string,
       type: string,
       attrs: any | any[],
       styles?: any,
-      ignoreEvent?: boolean
+      ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    } | Array<{
       key?: string,
       type: string,
       attrs: any | any[],
       styles?: any,
-      ignoreEvent?: boolean
+      ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    }>,
    createYAxisFigures?: (params: object) => {
       key?: string,
       type: string,
       attrs: any | any[],
       styles?: any,
-      ignoreEvent?: boolean
+      ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    } | Array<{
       key?: string,
       type: string,
       attrs: any | any[],
       styles?: any,
-      ignoreEvent?: boolean
+      ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    }>,
    performEventPressedMove?: (params: object) => void,
    performEventMoveForDrawing?: (params: object) => void,

diff --git a/docs/en-US/guide/overlay.md b/docs/en-US/guide/overlay.md
@@ -101,13 +101,13 @@ Customize an overlay, then add it globally through `klinecharts.registerOverlay`
      // The style of the graphic corresponding to type
      styles?: any,
      // Whether to ignore the event
-     ignoreEvent?: boolean
+     ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    }) | Array<{
      key?: string,
      type: string,
      attrs: any | any[],
      styles?: any,
-     ignoreEvent?: boolean
+     ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
    }>
 
    // Create graphics on the X axis, not required, parameters and return values are consistent with `createPointFigures`

diff --git a/docs/guide/changelog.md b/docs/guide/changelog.md
@@ -1,4 +1,10 @@
 # 📠 更新日志
+## 9.1.2
+`2023-04-10`
++ 🐞 修复内置基础图形`line`触发事件不准确问题。
++ 🐞 修复内置覆盖物`simpleAnnotation`和`simpleTag`绘制完成后第一次触发事件问题。
++ 💄 优化覆盖物图形事件忽略，支持事件选择。
+
 ## 9.1.1
 `2023-03-14`
 + 🐞 修复内置基础图形`arc`不生效问题。

diff --git a/docs/guide/chart-api.md b/docs/guide/chart-api.md
@@ -191,39 +191,39 @@
     type: string
     attrs: any | any[]
     styles?: any
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   } | Array<{
     key?: string
     type: string
     attrs: any | any[]
     styles?: any
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   }>,
   createXAxisFigures?: (params: object) => {
     key?: string
     type: string
     attrs: any | any[]
     styles?: any
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   } | Array<{
     key?: string
     type: string
     attrs: any | any[]
     styles?: any
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   }>,
   createYAxisFigures?: (params: object) => {
     key?: string
     type: string
     attrs: any | any[]
     styles?: any
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   } | Array<{
     key?: string
     type: string
     attrs: any | any[]
     styles?: any
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   }>,
   performEventPressedMove?: (params: object) => void,
   performEventMoveForDrawing?: (params: object) => void,

diff --git a/docs/guide/overlay.md b/docs/guide/overlay.md
@@ -101,13 +101,13 @@
     // type对应的图形的样式
     styles?: any,
     // 是否忽略事件
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   }) | Array<{
     key?: string,
     type: string,
     attrs: any | any[],
     styles?: any,
-    ignoreEvent?: boolean
+    ignoreEvent?: boolean | OverlayFigureIgnoreEventType[]
   }>
 
   // 创建X轴上的图形，非必须，参数和返回值和`createPointFigures`一致

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "klinecharts",
-  "version": "9.1.1",
+  "version": "9.1.2",
   "description": "Lightweight k-line chart built with html5 canvas",
   "main": "./dist/klinecharts.min.js",
   "module": "index.js",