docs: g2官网api文档跳转以及文案错误订正 (#6566)

antvis · Dec 27, 2024 · dc8cf7e · dc8cf7e
1 parent 21efda5
commit dc8cf7e
Show file tree

Hide file tree

Showing 10 changed files with 184 additions and 90 deletions.
diff --git a/site/docs/api/chart.zh.md b/site/docs/api/chart.zh.md
@@ -113,7 +113,7 @@ chart.render();
 
 <!-- 暂缺 -->
 
-添加 connector 图形，具体见 [mark](/spec/mark/connector)。
+添加 connector 图形。
 
 ### `chart.sankey`
 
@@ -137,7 +137,7 @@ chart.render();
 
 ### `chart.shape`
 
-添加 shape 图形，具体见 [mark](/spec/mark/shape)。
+添加自定义图形，具体见 [mark](/spec/mark/shape)。
 
 ### `chart.pack`
 
@@ -153,7 +153,7 @@ chart.render();
 
 ### `chart.wordCloud`
 
-添加 wordCloud 图形，具体见 [mark](/spec/mark/word-cloud)。
+添加 wordCloud 图形，具体见 [mark](/spec/mark/wordcloud)。
 
 ### `chart.gauge`
 
@@ -211,15 +211,15 @@ chart.render();
 
 ### `chart.width`
 
-设置或获取图表的 width。
+设置或获取图表的宽度。
 
 ### `chart.height`
 
-设置或获取图表的 height。
+设置或获取图表的高度。
 
 ### `chart.title`
 
-设置或获取图表的 title。
+设置或获取图表的标题。
 
 ### `chart.options`
 
@@ -231,9 +231,7 @@ chart.render();
 
 ### `chart.encode`
 
-<!-- 暂缺 -->
-
-设置图形每个通道的字段名称，具体见 [encode](/api/encode/overview)。
+设置图形每个通道的字段名称，具体见 [encode](/manual/core/encode)。
 
 ### `chart.scale`
 
@@ -247,15 +245,15 @@ chart.render();
 
 ### `chart.tooltip`
 
-设置图形的 Tooltip，具体见 [tooltip](/spec/component/tooltip)。
+设置图形的提示，具体见 [tooltip](/spec/component/tooltip)。
 
 ### `chart.axis`
 
 设置图形的坐标轴，具体见 [axis](/spec/component/axis)。
 
 ### `chart.slider`
 
-设置图形的坐标轴，具体见 [slider](/spec/component/slider)。
+设置图形的缩略轴，具体见 [slider](/spec/component/slider)。
 
 ### `chart.label`
 
@@ -269,13 +267,13 @@ chart.render();
 
 ### `chart.theme`
 
-设置图形的主题，具体见 [theme](/spec/theme/academy)。
+设置图形的主题，具体见 [theme](/spec/overview#theme)。
 
 ### `chart.labelTransform`
 
 <!-- 缺失 -->
 
-设置图形的 labelTransform，具体见 [label](/spec/label/overview)
+设置图形的 labelTransform，具体见 [label](/spec/label/overview)里的transform配置。
 
 ## 渲染图表
 
@@ -359,7 +357,7 @@ chart.render();
 
 ### `chart.off`
 
-写在 chart 上的监听事件。
+卸载 chart 上的监听事件。
 
 ### `chart.getNodesByType`
 

diff --git a/site/docs/api/facetCircle.zh.md b/site/docs/api/facetCircle.zh.md
@@ -112,7 +112,7 @@ chart.render();
 
 ### `facetCircle.connector`
 
-添加 connector 图形，具体见 [mark](/spec/mark/connector)。
+添加 connector 图形。
 
 ### `facetCircle.sankey`
 
@@ -128,7 +128,7 @@ chart.render();
 
 ### `facetCircle.shape`
 
-添加 shape 图形，具体见 [mark](/spec/mark/shape)。
+添加自定义图形，具体见 [mark](/spec/mark/shape)。
 
 ### `facetCircle.pack`
 
@@ -144,7 +144,7 @@ chart.render();
 
 ### `facetCircle.wordCloud`
 
-添加 wordCloud 图形，具体见 [mark](/spec/mark/word-cloud)。
+添加 wordCloud 图形，具体见 [mark](/spec/mark/wordcloud)。
 
 ### `facetCircle.gauge`
 
@@ -178,4 +178,4 @@ chart.render();
 
 ### `facetCircle.theme`
 
-设置图形的主题，具体见 [theme](/spec/theme/overview)。
+设置图形的主题，具体见 [theme](/spec/overview#theme)。
diff --git a/site/docs/api/facetRect.zh.md b/site/docs/api/facetRect.zh.md
@@ -36,36 +36,132 @@ chart.render();
 
 ## 创建可视化
 
-## `facetRect.[mark]`
+### `facetRect.interval`
 
-设置图表的 Mark 标记，具体见 [mark](/api/mark/area)。
+添加 interval 图形，具体见 [mark](/spec/mark/interval)。
+
+### `facetRect.rect`
+
+添加 rect 图形，具体见 [mark](/spec/mark/rect)。
+
+### `facetRect.point`
+
+添加 point 图形，具体见 [mark](/spec/mark/point)。
+
+### `facetRect.area`
+
+添加 area 图形，具体见 [mark](/spec/mark/area)。
+
+### `facetRect.line`
+
+添加 line 图形，具体见 [mark](/spec/mark/line)。
+
+### `facetRect.vector`
+
+添加 vector 图形，具体见 [mark](/spec/mark/vector)。
+
+### `facetRect.link`
+
+添加 link 图形，具体见 [mark](/spec/mark/link)。
+
+### `facetRect.polygon`
+
+添加 polygon 图形，具体见 [mark](/spec/mark/polygon)。
+
+### `facetRect.image`
+
+添加 image 图形，具体见 [mark](/spec/mark/image)。
+
+### `facetRect.text`
+
+添加 text 图形，具体见 [mark](/spec/mark/text)。
+
+### `facetRect.lineX`
+
+添加 lineX 图形，具体见 [mark](/spec/mark/line-x)。
+
+### `facetRect.lineY`
+
+添加 lineY 图形，具体见 [mark](/spec/mark/line-y)。
+
+### `facetRect.range`
+
+添加 range 图形，具体见 [mark](/spec/mark/range)。
+
+### `facetRect.rangeX`
+
+添加 rangeX 图形，具体见 [mark](/spec/mark/range-x)。
+
+### `facetRect.rangeY`
+
+添加 rangeY 图形，具体见 [mark](/spec/mark/range-y)。
+
+### `facetRect.connector`
+
+添加 connector 图形。
+
+### `facetRect.sankey`
+
+添加 sankey 图形，具体见 [graph](/spec/graph/sankey)。
+
+### `facetRect.treemap`
+
+添加 treemap 图形，具体见 [graph](/spec/graph/treemap)。
+
+### `facetRect.boxplot`
+
+添加 boxplot 图形，具体见 [mark](/spec/mark/boxplot)。
+
+### `facetRect.shape`
+
+添加自定义图形，具体见 [mark](/spec/mark/shape)。
+
+### `facetRect.pack`
+
+添加 pack 图形，具体见 [graph](/spec/graph/pack)。
+
+### `facetRect.forceGraph`
+
+添加 forceGraph 图形，具体见 [graph](/spec/graph/force-graph)。
+
+### `facetRect.tree`
+
+添加 tree 图形，具体见 [graph](/spec/graph/tree)。
+
+### `facetRect.wordCloud`
+
+添加 wordCloud 图形，具体见 [mark](/spec/mark/wordcloud)。
+
+### `facetRect.gauge`
+
+添加 gauge 图形，具体见 [mark](/spec/mark/gauge)。
 
 ## 设置属性
 
-## `facetRect.attr`
+### `facetRect.attr`
 
 获取或设置图表的配置项。
 
-## `facetRect.data`
+### `facetRect.data`
 
 设置图形的数据，支持多种数据来源和数据变换，具体见 [data](/spec/data/overview)。
 
-## `facetRect.scale`
+### `facetRect.scale`
 
 设置图形每个通道的比例尺，具体见 [scale](/spec/overview#scale)。
 
-## `facetRect.legend`
+### `facetRect.legend`
 
 设置图形的图例，具体见 [legend](/spec/component/legend)。
 
-## `facetRect.axis`
+### `facetRect.axis`
 
 设置图形的坐标轴，具体见 [axis](/spec/component/axis)。
 
-## `facetRect.style`
+### `facetRect.style`
 
 设置图形的样式，具体见 [style](/spec/common/style)。
 
-## `facetRect.theme`
+### `facetRect.theme`
 
-设置图形的主题，具体见 [theme](/spec/theme/overview)。
+设置图形的主题，具体见 [theme](/spec/overview#theme)。
diff --git a/site/docs/api/geoView.zh.md b/site/docs/api/geoView.zh.md
@@ -109,11 +109,11 @@ fetch('https://assets.antv.antgroup.com/g2/countries-50m.json')
 
 ### `geoView.connector`
 
-添加 connector 图形，具体见 [mark](/spec/mark/connector)。
+添加 connector 图形。
 
 ### `geoView.sankey`
 
-添加 sankey 图形，具体见 [mark](/spec/mark/sankey)。
+添加 sankey 图形，具体见 [graph](/spec/graph/sankey)。
 
 ### `geoView.treemap`
 
@@ -125,7 +125,7 @@ fetch('https://assets.antv.antgroup.com/g2/countries-50m.json')
 
 ### `geoView.shape`
 
-添加 shape 图形，具体见 [mark](/spec/mark/shape)。
+添加自定义图形，具体见 [mark](/spec/mark/shape)。
 
 ### `geoView.pack`
 
@@ -141,7 +141,7 @@ fetch('https://assets.antv.antgroup.com/g2/countries-50m.json')
 
 ### `geoView.wordCloud`
 
-添加 wordCloud 图形，具体见 [mark](/spec/mark/word-cloud)。
+添加 wordCloud 图形，具体见 [mark](/spec/mark/wordcloud)。
 
 ### `geoView.gauge`
 
@@ -159,7 +159,7 @@ fetch('https://assets.antv.antgroup.com/g2/countries-50m.json')
 
 ### `geoView.encode`
 
-设置图形每个通道的字段名称，具体见 [encode](/api/encode/overview)。
+设置图形每个通道的字段名称，具体见 [encode](/manual/core/encode)。
 
 ### `geoView.scale`
 
@@ -171,7 +171,7 @@ fetch('https://assets.antv.antgroup.com/g2/countries-50m.json')
 
 ### `geoView.tooltip`
 
-设置图形的 Tooltip，具体见 [tooltip](/spec/component/tooltip)。
+设置图形的提示，具体见 [tooltip](/spec/component/tooltip)。
 
 ### `geoView.axis`
 
@@ -187,4 +187,4 @@ fetch('https://assets.antv.antgroup.com/g2/countries-50m.json')
 
 ### `geoView.theme`
 
-设置图形的主题，具体见 [theme](/spec/theme/overview)。
+设置图形的主题，具体见 [theme](/spec/overview#theme)。