Commit ebbad36
docs: structure improve (#2160)
* fix: 单词拼写错误
* docs: geometry 组件参数表格化
* docs: tooltip 文档优化
* docs: 补充 tooltip markerBackgroundStyle 参数说明
为 markerBackgroundStyle 参数添加了使用场景说明,明确指出其主要用于柱状图,尤其是分组柱状图。
* docs: 修正 geometry 组件文档问题
- 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 属性为仅支持对象形式,删除不支持的数组形式说明
* Update site/docs/api/chart/candlestick.zh.md
* docs: 补充 Interval selection 参数说明
- 新增 selectedStyle/unSelectedStyle 详细格式说明
- 补充 record 参数结构文档
- 新增函数形式示例
- 添加常用样式属性表格
* docs: 优化 Axis 组件文档
- 新增 TypeScript 类型定义(AxisProps、StyleProps、Tick、TickLineProps、MarkerStyleProps)
- 添加 JSDoc 格式注释
- Props 表格化,按功能分组,补充默认值
- 新增用法示例(格式化、回调函数、symbol 配置、旋转标签等)
- 修正 LabelCallback/GirdCallback 参数签名(与源码一致)
- 补充默认样式值章节及源码链接
- 精简 Tick 接口为开发者实际使用的属性
* docs(text-guide): 优化 TextGuide 组件文档结构和术语准确性
主要变更:
- 修复 TypeScript 类型定义:style 函数签名从 (record?) 改为 (points: Point[], chart: Chart)
- 新增 TypeScript 类型定义章节,提供准确的类型签名
- 新增 records 特殊值说明(min/max/median/百分比)
- 优化 textAlign 和 textBaseline 描述,使用标准术语"文本对齐"和"文本基线对齐"
- 修正默认值标注:textAlign 默认为 'start',textBaseline 默认为 'middle'
- 新增典型组合示例和多个实用场景示例
- 新增折线图数据点标注、使用偏移量等场景示例
- 恢复完整动画配置示例
* docs(line-guide): 完善 LineGuide 组件文档
- 新增 TypeScript 类型定义
- Props 表格化,补充默认值
- 新增 records 特殊值说明(min/max/median/%)
- 新增 style 属性说明(对象/函数形式)
- 新增数组偏移特性说明
- 新增 7 个用法示例
- 完善动画属性说明
* docs(tag-guide): 完善 TagGuide 组件文档
- 新增 TypeScript 类型定义和 Props 表格
- 新增 precise、visible、onClick 属性说明
- 新增 background 属性独立章节
- 新增分组柱状图精确定位示例(支持负数动态方向)
- 新增点击事件、条件控制显示示例
- 移除代码内联注释,符合主流文档规范
* docs(image-guide): 完善 ImageGuide 组件文档
- 新增 TypeScript 类型定义
- 完善 Props 表格,补充默认值和类型
- 新增 attrs vs style 说明
- 新增 records 特殊值说明
- 新增 style 属性说明(对象/函数形式)
- 新增 6 个用法示例(基础用法、偏移量、特殊值、style 函数、onClick、多图片组合、动画)
* docs(point-guide): 完善文档内容
主要改进:
- 新增 onClick、visible、precise 属性文档
- 补充 TypeScript 类型定义(Point、RecordItem)
- 新增默认样式值说明
- style 函数参数说明更详细
- 优化用法示例结构
* docs(rect-guide): 完善文档内容
主要改进:
- 新增 onClick、visible、precise 属性文档
- 补充 TypeScript 类型定义(Point 接口)
- 新增 records 特殊值说明和示例
- style 属性章节补充函数签名详细说明
- 新增多个用法示例(点击事件、条件显示、chart 实例)
* docs(chart): 完善 Chart 组件文档
- 新增 TypeScript 类型定义和泛型说明
- 新增 scale 属性详细说明(通用属性、linear/cat/timeCat 度量)
- 新增 coord 属性详细说明(rect/polar 坐标系)
- 新增 style 和 theme 属性说明
- 修正文档链接格式为相对 docs 目录
- 精简代码示例,移除冗余注释
- 补充默认值和已弃用属性说明
* docs: 优化文档内容
- API 文档优化 (Canvas, Legend, Magnifier, PieLabel, ScrollBar, Tooltip 等)
- 教程文档优化 (getting-started, grammar, understanding, coordinate, data, scale 等)
- 组件文档优化
- 框架集成教程优化
* docs(interval): 优化动画配置注释说明
- 将动画配置注释中的 y0 改为 baseline,更清晰表达其含义
- 添加说明:baseline 为 y 轴基线位置,柱子从底部向上展开
* docs(tutorial): 更新数据文档和 CDN 引入路径
- 修正 Candlestick 组件数组格式说明
- 将 changeData API 更新为 update 方法
- 修正 CDN 路径为 index.min.js
---------
Co-authored-by: ian.lxl <[email protected]>1 parent fb62d55 commit ebbad36
File tree
55 files changed
+14166
-2030
lines changed- site/docs
- api
- chart
- guide
- tutorial
- advanced
- framework
- question
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
55 files changed
+14166
-2030
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
9 | 34 | | |
10 | 35 | | |
11 | 36 | | |
12 | 37 | | |
13 | | - | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
14 | 64 | | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
15 | 82 | | |
16 | | - | |
17 | | - | |
18 | | - | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
19 | 87 | | |
20 | 88 | | |
21 | | - | |
| 89 | + | |
22 | 90 | | |
23 | | - | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
24 | 98 | | |
25 | | - | |
| 99 | + | |
26 | 100 | | |
27 | | - | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
28 | 108 | | |
29 | | - | |
| 109 | + | |
30 | 110 | | |
31 | | - | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
32 | 118 | | |
33 | | - | |
| 119 | + | |
34 | 120 | | |
35 | | - | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
36 | 138 | | |
37 | | - | |
| 139 | + | |
38 | 140 | | |
39 | | - | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
40 | 147 | | |
41 | | - | |
| 148 | + | |
42 | 149 | | |
43 | | - | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
44 | 153 | | |
45 | | - | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
0 commit comments