Closed
Description
任务介绍
此 ISSUE 为 AntV 开源共建计划（AntV Open Source Contribution Plan，简称 AntV OSCP）Phase3 - 文档季的任务 ISSUE，欢迎社区开发者参与共建~
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.
改造文档「核心概念 - 比例尺（Scale）-band」
任务介绍
- 任务名称：改造 核心概念 - 比例尺（Scale）-band 文档
- 技术方向：g2 / docs
- 任务难度：进阶 🌟🌟
- 可获得积分： 30分
详细要求
- 文档规范：
- 参考示例：
- 核心概念 - 标记（Mark） - interval
- 图表组件 - 图例（Legend）
- 比例尺的概念可以先参考 4.0 文档，5.0的内置比例尺、实现和语法稍有不同。
- 文档结构：「比例尺」部分的文档至少应该包括 概述、配置项，示例 几个部分，需要在概述部分尽量详细地介绍，说明比例尺属于连续比例尺、分类比例尺还是常量比例尺，如有需要举例说明映射效果，例如
log: log 度量连续非线性的 Log 数据 将 [1, 10, 100, 1000] 转换成 [0, 1, 2, 3]。 - 代码规范：示例代码统一使用
spec语法。即chart.options({})，可以在图表示例页面完成切换。 - 内容规范：
- 属性表格需要包含【属性】【描述】【类型】【默认值】【必选】列，所有的配置项包括绘图属性需要罗列完整。
- 默认值除了功能实现部分，还可能配置在主题里
src/theme/create.ts - 复杂类型单独解释说明
- 必要时可配上示意图
- 参考示例：
能力要求
- 对 G2 有一定了解，能阅读 G2 源码，编写示例。
执行路径
1. 认领任务
选择感兴趣的且没有 Assignee 的任务，按格式回复，该任务 assign 给你后即为成功认领~
- 认领回复格式：【@github ID + Give it to me】
- eg：【@interstellarmt Give it to me】
2. 做任务
- clone g2 代码
git clone https://github.com/antvis/G2.git- 拉取所有线上分支
git fetch- 切换到 v5 分支
git checkout v5- 安装依赖
pnpm install- 进入 site 包
cd site- 安装 site 依赖
pnpm install- 本地启动 site 站点
pnpm run start- 优化文档并预览效果
- 对应文件位于
site/docs/manual/core/scale/band.zh.md - 功能实现位于
src/scale/band.ts、https://github.com/antvis/scale/blob/master/src/scales/band.ts - 图表示例位于：
site/examples/xxx/xxx/demo，可以在该文件夹下搜索 - 默认情况下不需要进行 scale 的配置，因为 G2 代码内部已经根据数据的形式进行了预设
3. 提交 PR
请保证文档语意通顺、格式正确、代码示例完整且能够正确编译，否则该 PR 将不会被 review 和 merge，此 issue 将被重新释放。
- 提交 Pull Request，等待 Code Review
- PR 标题参考
docs: 任务名称，如docs: 改造「核心概念 - 标记（Mark）-wordCloud」文档，并关联OSCP标签，以便快速进入 PR review 阶段。 - PR 与对应任务 ISSUE 进行关联，方式：在 PR 正文中，通过
- Fixed: #任务 ISSUE 号即可实现关联，eg：
- 根据（多次） Code Review 建议修改
3 等待合并入 v5 分支后，积分生效
Metadata
Metadata
Assignees
Type
Projects
Status
Done