docs: add comment for separate hover highlight config in docs and demos

antvis · Jun 2, 2023 · 7f3a44a · 7f3a44a
1 parent 869095e
commit 7f3a44a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/s2-site/docs/manual/advanced/interaction/basic.zh.md b/s2-site/docs/manual/advanced/interaction/basic.zh.md
@@ -174,6 +174,13 @@ const s2Options = {
 const s2Options = {
   interaction: {
     hoverHighlight: false // 默认 true
+    // 等同于
+    // hoverHighlight: {
+    //   rowHeader = false, // 高亮悬停格子所在行头
+    //   colHeader = false, // 高亮悬停格子所在列头
+    //   currentRow = false, // 高亮悬停格子所在行
+    //   currentCol = false, // 高亮悬停格子所在列
+    // },
   }
 };
 ```

diff --git a/s2-site/examples/interaction/basic/demo/hover.ts b/s2-site/examples/interaction/basic/demo/hover.ts
@@ -13,6 +13,13 @@ fetch(
       interaction: {
         // 悬停高亮
         hoverHighlight: true,
+        // 等同于
+        // hoverHighlight: {
+        //   rowHeader = true, // 高亮悬停格子所在行头
+        //   colHeader = true, // 高亮悬停格子所在列头
+        //   currentRow = true, // 高亮悬停格子所在行
+        //   currentCol = true, // 高亮悬停格子所在列
+        // },
       },
       tooltip: {
         showTooltip: true,