docs: supplement optional parameters of insight mark

antvis · Nov 20, 2023 · f895846 · f895846
1 parent 7023561
commit f895846
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 3 deletions.
diff --git a/site/examples/intelligent/insight/demo/insight.ts b/site/examples/intelligent/insight/demo/insight.ts
@@ -21,9 +21,35 @@ chart
   .encode('y', 'close');
 
 chart.line();
-// 指定洞察类型为趋势
+
+// Add insight marks
 chart.insight({
+  // Specify to add marks of type 'trend'
   insightType: 'trend',
+  // If the value of dimensions or measures is not specified, it will be obtained from the encode information by default.
+  dimensions: [{ fieldName: 'date' }],
+  measures: [{ fieldName: 'close', method: 'SUM' }],
+  options: {
+    // Filter out not significant insights
+    filterInsight: true,
+    // Verify whether the input meets the algorithm requirements
+    dataValidation: true,
+    // Adjust the significance test threshold
+    algorithmParameter: {
+      // Parameter for trend mark
+      trend: {
+        threshold: 0.05,
+      },
+      // Only if insightType is 'change_point', the content of parameter changePoint will take effect.
+      changePoint: {
+        threshold: 0.1,
+      },
+    },
+    // Generate Chinese spec
+    visualizationOptions: {
+      lang: 'zh-CN',
+    },
+  },
 });
 
 chart.render();
diff --git a/site/examples/intelligent/insight/demo/meta.json b/site/examples/intelligent/insight/demo/meta.json
@@ -7,8 +7,8 @@
     {
       "filename": "insight.ts",
       "title": {
-        "zh": "洞察标注",
-        "en": "Insight marks"
+        "zh": "洞察标注算法的详细参数",
+        "en": "Detailed Parameters of Insight Mark"
       },
       "screenshot": "https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*DweUTbVAaIEAAAAAAAAAAAAADmJ7AQ/original"
     },