[Docs]: 改造文档「核心概念 - 交互（Interaction）- chartIndex」

[interstellarmt]

任务介绍

此 ISSUE 为 AntV 开源共建计划（AntV Open Source Contribution Plan，简称 AntV OSCP）Phase3 - 文档季的任务 ISSUE，欢迎社区开发者参与共建~

• 更多任务，可查看 GitHub Project - 2025 AntV OSCP Season of Docs。

This ISSUE is one of the tasks of the AntV Open Source Contribution Plan (referred to as AntV OSCP) Pharse3 - Season of Docs . Welcome to join us in building it together!

• For more tasks, you can check the GitHub Project - 2025 AntV OSCP Season of Docs.

改造文档「核心概念 - 交互（Interaction）- chartIndex」

任务介绍

• 任务名称：改造 核心概念 - 交互（Interaction）- chartIndex 文档
• 技术方向：g2 / docs
• 任务难度：进阶 🌟🌟
• 可获得积分：30分

详细要求

• 文档规范：
  • 参考示例：
    • 核心概念 - 交互（Interaction） - brushHighligt
    • 图表组件 - 图例（Legend）
  • 文档结构：「标记」部分的文档至少应该包括 概述、使用方式、配置层级、配置项、事件、示例 几个部分，如果没有特殊事件可以不写。
  • 代码规范：示例代码统一使用 spec 语法。即 chart.options({})，可以在图表示例页面完成切换。
  • 内容规范：
    • 属性表格需要包含【属性】【描述】【类型】【默认值】【必选】列，所有的配置项包括绘图属性需要罗列完整。
    • 复杂类型单独解释说明
    • 必要时可配上示意图

能力要求

- 对 G2 有一定了解，能阅读 G2 源码，编写示例。

执行路径

1. 认领任务

选择感兴趣的且没有 Assignee 的任务，按格式回复，该任务 assign 给你后即为成功认领~

• 认领回复格式：【@github ID + Give it to me】
• eg：【@interstellarmt Give it to me】

2. 做任务

1. clone g2 代码

git clone https://github.com/antvis/G2.git

2. 拉取所有线上分支

git fetch

3. 切换到 v5 分支

git checkout v5

4. 安装依赖

pnpm install

5. 进入 site 包

cd site

6. 安装 site 依赖

pnpm install

7. 本地启动 site 站点

pnpm run start

8. 优化文档并预览效果

• 对应文件位于 site/docs/manual/core/interaction
• 功能实现位于 src/interaction
• 图表示例位于：site/examples/interaction
• 图表示例预览： https://g2.antv.antgroup.com/examples#interaction-element

3. 提交 PR

请保证文档语意通顺、格式正确、代码示例完整且能够正确编译，否则该 PR 将不会被 review 和 merge，此 issue 将被重新释放。

1. 提交 Pull Request，等待 Code Review

• PR 标题参考 docs: 任务名称 ，如 docs: 改造「核心概念 - 标记（Mark）-wordCloud」文档 ，并关联 OSCP 标签，以便快速进入 PR review 阶段。
• PR 与对应任务 ISSUE 进行关联，方式：在 PR 正文中，通过 - Fixed: #任务 ISSUE 号 即可实现关联，eg：

2. 根据（多次） Code Review 建议修改

3 等待合并入 v5 分支后，积分生效

[foolvip]

@foolvip Give it to me

[interstellarmt]

👋 @foolvip , just a friendly reminder to submit your contributions within 7 days! If no updates are made within this timeframe, the issue will be reassigned to others. Let us know if you have any questions! 😄

你好 @foolvip ，恭喜你成功认领任务！请在 7 天内完成贡献哦～如果超时未提交，任务将会被重新分配。如有任何疑问，欢迎随时联系我们！😄

[interstellarmt]

优秀的首次贡献！额外奖励 20 积分~ 期待您的更多参与！🎁

---

Excellent first contribution! Extra 20 points bonus~ Looking forward to your future work! 🎁