Docs structure improve #2159
Docs structure improve #2159
Conversation
为 markerBackgroundStyle 参数添加了使用场景说明，明确指出其主要用于柱状图，尤其是分组柱状图。 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Line: 添加 endView 属性，修正 size callback 类型签名为 (value, record) => string - Interval: 添加 sizeZoom/showLabel/labelCfg 属性，修正 size callback 类型，补充 labelCfg 适用范围说明（仅 pyramid/funnel） - Point: 修正 size callback 类型，修正 shape 属性为实际支持的 3 种形状（circle/hollowCircle/rect） - Area: 修正 size callback 类型 - Candlestick: 修正 color 属性为仅支持对象形式，删除不支持的数组形式说明 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Summary of ChangesHello @huaxiabuluo, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! 此拉取请求旨在全面提升 F2 图表库的中文文档质量和结构。通过将几何标记的通用属性说明从基类文档中分离，并为每个具体的几何标记组件（如 Area, Line, Interval 等）提供详尽的独立属性、样式和动画配置指南，极大地增强了文档的清晰度和易用性。同时，Tooltip 组件的文档也得到了大幅扩充，包含了类型定义和丰富的示例，确保开发者能更高效地理解和使用 F2 的各项功能。 Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request significantly refactors and expands the documentation for various chart components, including Area, Candlestick, Interval, Line, and Point. The geometry.zh.md file was transformed from a detailed list of common properties into an overview and navigation document, directing users to individual component pages for comprehensive property details. Each component's documentation (area.zh.md, candlestick.zh.md, interval.zh.md, line.zh.md, point.zh.md) now features a detailed Props section, including a property overview table, and expanded sub-sections for color, size, style, adjust, and animation properties, complete with usage examples and type definitions. The candlestick.zh.md and interval.zh.md files also received specific updates for their unique properties like sizeRatio and selection respectively. Additionally, a minor typo (innnerRadius to innerRadius) was corrected in chart.zh.md, and marign was corrected to margin in scroll-bar.zh.md. The tooltip.zh.md file was substantially rewritten to include TypeScript type definitions, a comprehensive Props table with default values and explanations, and numerous usage examples for various configurations, while also correcting a JSX syntax for Tooltip component. Finally, event.zh.md updated the type of event handlers from funtion to function. The review comments suggest improving the consistency of animation property descriptions across all stages in interval.zh.md by adding cross-references, and re-adding example links for selection property in interval.zh.md to enhance user guidance.
| | cancelable | `boolean` | 否 | `true` | 是否可取消选择 | | ||
|
|
||
| 大小比例，范围 `[0, 1]`, 比如柱状图默认为 `0.5`, 表示柱子和空白处各占 `50%` | ||
| > 设置 `triggerOn` 为 `press` 时，需要将 `cancelable` 设置为 `false`，否则会有明显闪动 |
There was a problem hiding this comment.
selection 的文档很清晰，但旧文档中包含的示例链接（柱状图选中、饼图选中）被移除了。这些在线示例对用户非常有帮助，建议在此处下方重新加入这些链接，以便用户查看实际效果。例如：
### 示例链接
- [柱状图选中](/zh/examples/column/column#selection)
- [饼图选中](/zh/examples/pie/pie#selection)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…to docs-structure-improve
- 新增 selectedStyle/unSelectedStyle 详细格式说明 - 补充 record 参数结构文档 - 新增函数形式示例 - 添加常用样式属性表格 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- 新增 TypeScript 类型定义（AxisProps、StyleProps、Tick、TickLineProps、MarkerStyleProps） - 添加 JSDoc 格式注释 - Props 表格化，按功能分组，补充默认值 - 新增用法示例（格式化、回调函数、symbol 配置、旋转标签等） - 修正 LabelCallback/GirdCallback 参数签名（与源码一致） - 补充默认样式值章节及源码链接 - 精简 Tick 接口为开发者实际使用的属性 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
主要变更： - 修复 TypeScript 类型定义：style 函数签名从 (record?) 改为 (points: Point[], chart: Chart) - 新增 TypeScript 类型定义章节，提供准确的类型签名 - 新增 records 特殊值说明（min/max/median/百分比） - 优化 textAlign 和 textBaseline 描述，使用标准术语"文本对齐"和"文本基线对齐" - 修正默认值标注：textAlign 默认为 'start'，textBaseline 默认为 'middle' - 新增典型组合示例和多个实用场景示例 - 新增折线图数据点标注、使用偏移量等场景示例 - 恢复完整动画配置示例 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- 新增 TypeScript 类型定义 - Props 表格化，补充默认值 - 新增 records 特殊值说明（min/max/median/%） - 新增 style 属性说明（对象/函数形式） - 新增数组偏移特性说明 - 新增 7 个用法示例 - 完善动画属性说明 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 participant
Checklist
npm testpassesDescription of change