From 79dc60ba9cd5045a1a07051b1e93dadeee74d54c Mon Sep 17 00:00:00 2001 From: Kasmine <736929286@qq.com> Date: Tue, 5 Jan 2021 09:37:59 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=BF=81=E7=A7=BB=E5=92=8C=E5=BC=A6?= =?UTF-8?q?=E5=9B=BE=E6=96=87=E6=A1=A3=E5=9C=B0=E5=9D=80=20&=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E6=A0=B7=E5=BC=8F=E4=BC=98=E5=8C=96=20&=20=E4=BF=AE?= =?UTF-8?q?=E5=A4=8D=20=E7=BB=98=E5=9B=BE=E5=B1=9E=E6=80=A7=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E9=93=BE=E6=8E=A5=20404=20(#2172)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(chord): 迁移和弦图文档地址 * docs: 文档优化 * docs: 修复 绘图属性文档链接 404 * docs: 删除无用文档 & 修改文档链接 * docs: 修改文档错别字 * docs: 文档锚点大小写问题 --- docs/api/components/legend.zh.md | 4 +-- docs/api/plots/gauge.zh.md | 2 +- docs/common/annotations.en.md | 6 ++-- docs/common/annotations.zh.md | 7 +++-- docs/{manual/plots => common}/chord.en.md | 0 docs/{manual/plots => common}/chord.zh.md | 0 docs/common/conversion-tag.en.md | 2 +- docs/common/conversion-tag.zh.md | 2 +- docs/common/legend-cfg.zh.md | 14 ++++----- docs/common/shape-style.en.md | 2 +- docs/common/shape-style.zh.md | 2 +- docs/common/slider.en.md | 36 +++++++++++------------ docs/common/slider.zh.md | 36 +++++++++++------------ docs/manual/upgrade.en.md | 2 +- docs/manual/upgrade.zh.md | 2 +- 15 files changed, 59 insertions(+), 58 deletions(-) rename docs/{manual/plots => common}/chord.en.md (100%) rename docs/{manual/plots => common}/chord.zh.md (100%) diff --git a/docs/api/components/legend.zh.md b/docs/api/components/legend.zh.md index 152a7a6dee..f4dd1c4bc1 100644 --- a/docs/api/components/legend.zh.md +++ b/docs/api/components/legend.zh.md @@ -38,8 +38,8 @@ legend: { | flipPage | _boolean_ | false | 当图例项过多时是否进行分页。 | 分类图例 | | itemWidth | _number\|null_ | null | 图例项的宽度, 默认为 null（自动计算）。 | 分类图例 | | itemHeight | _number\|null_ | null | 图例的高度, 默认为 null。 | 分类图例 | -| itemName | _object_ | - | 图例项 name 文本的配置。详见 [itemName 配置](#itemName) | 分类图例 | -| itemValue | _object_ | - | 图例项 value 附加值的配置项。详见 [itemValue 配置](#itemValue)。 | 分类图例 | +| itemName | _object_ | - | 图例项 name 文本的配置。详见 [itemName 配置](#itemname) | 分类图例 | +| itemValue | _object_ | - | 图例项 value 附加值的配置项。详见 [itemValue 配置](#itemvalue)。 | 分类图例 | | itemSpacing | _number_ | - | 控制图例项水平方向的间距 | 分类图例 | | animate | _boolean_ | - | 是否开启动画开关。 | | | animateOption | _object_ | - | 动画参数配置，当且仅当 animate 属性为 true，即动画开启时生效，详见 [animateOption 配置](#animateOption) | | diff --git a/docs/api/plots/gauge.zh.md b/docs/api/plots/gauge.zh.md index cd96d8ecba..cd5558d64c 100644 --- a/docs/api/plots/gauge.zh.md +++ b/docs/api/plots/gauge.zh.md @@ -50,7 +50,7 @@ order: 22 | 配置项 | 类型 | 描述 | | ------ | -------- | ------------------------------------ | | ticks | _number[]_ | 辅助圆弧显示数字数组 | -| color | _string/|string[]_ | 辅助圆弧的颜色色板，按照色板顺序取值; 当设置 ticks 时，color 无法使用回调的方式 | +| color | _string \|string[]_ | 辅助圆弧的颜色色板，按照色板顺序取值; 当设置 ticks 时，color 无法使用回调的方式 | diff --git a/docs/common/annotations.en.md b/docs/common/annotations.en.md index e53cd7f428..b370ec14ba 100644 --- a/docs/common/annotations.en.md +++ b/docs/common/annotations.en.md @@ -131,10 +131,10 @@ y 方向的偏移量。 文字包围盒样式设置。 -| 参数名 | 类型 | 是否必选 | 默认值 | 描述 | +| 参数名 | 类型 | 默认值 | 描述 | | ------- | ------------------- | -------- | ------ | ------------------ | -| style | object 参考绘图属性 | | - | 文本背景的样式 | -| padding | number \| number[] | | - | 文本背景周围的留白 | +| style | _object_ | - | 文本背景的样式, 参考[绘图属性](/en/docs/api/graphic-style) | +| padding | _number \| number[]_ | - | 文本背景周围的留白 | ##### color diff --git a/docs/common/annotations.zh.md b/docs/common/annotations.zh.md index e53cd7f428..0412317f25 100644 --- a/docs/common/annotations.zh.md +++ b/docs/common/annotations.zh.md @@ -131,10 +131,11 @@ y 方向的偏移量。 文字包围盒样式设置。 -| 参数名 | 类型 | 是否必选 | 默认值 | 描述 | +| 参数名 | 类型 | 默认值 | 描述 | | ------- | ------------------- | -------- | ------ | ------------------ | -| style | object 参考绘图属性 | | - | 文本背景的样式 | -| padding | number \| number[] | | - | 文本背景周围的留白 | +| style | _object_ | - | 文本背景的样式, 参考[绘图属性](/en/docs/api/graphic-style) | +| padding | _number \| number[]_ | - | 文本背景周围的留白 | + ##### color diff --git a/docs/manual/plots/chord.en.md b/docs/common/chord.en.md similarity index 100% rename from docs/manual/plots/chord.en.md rename to docs/common/chord.en.md diff --git a/docs/manual/plots/chord.zh.md b/docs/common/chord.zh.md similarity index 100% rename from docs/manual/plots/chord.zh.md rename to docs/common/chord.zh.md diff --git a/docs/common/conversion-tag.en.md b/docs/common/conversion-tag.en.md index 1a12e17933..7d11acf669 100644 --- a/docs/common/conversion-tag.en.md +++ b/docs/common/conversion-tag.en.md @@ -25,4 +25,4 @@ TextCfg 配置如下 | style | object | 否 | - | 箭头样式 | | formatter | (prev:number, next:number) => string | 否 | - | 自定义转化率计算 | -样式配置类型请参考[绘图属性](../../manual/graphic-style) +样式配置类型请参考[ShapeAttrs](/en/docs/api/graphic-style) diff --git a/docs/common/conversion-tag.zh.md b/docs/common/conversion-tag.zh.md index 1a12e17933..a788486b97 100644 --- a/docs/common/conversion-tag.zh.md +++ b/docs/common/conversion-tag.zh.md @@ -25,4 +25,4 @@ TextCfg 配置如下 | style | object | 否 | - | 箭头样式 | | formatter | (prev:number, next:number) => string | 否 | - | 自定义转化率计算 | -样式配置类型请参考[绘图属性](../../manual/graphic-style) +样式配置类型请参考[绘图属性](/zh/docs/api/graphic-style) diff --git a/docs/common/legend-cfg.zh.md b/docs/common/legend-cfg.zh.md index 85e4808fda..9e7da131f8 100644 --- a/docs/common/legend-cfg.zh.md +++ b/docs/common/legend-cfg.zh.md @@ -49,7 +49,7 @@ | 参数名 | 类型 | 默认值 | 描述 | | --- | --- | --- | --- | | size | _number_ | - | 滑块的大小 | -| style | _object_ | - | 滑块的样式设置，参考 [绘图属性](../graphic-style) | +| style | _object_ | - | 滑块的样式设置，参考 [绘图属性](/zh/docs/api/graphic-style) | ##### itemHeight @@ -71,7 +71,7 @@ | 参数名 | 类型 | 默认值 | 描述 | | --- | --- | --- | --- | -| style | _object_ | - | 文本样式配置项，参考 [绘图属性](../graphic-style) | +| style | _object_ | - | 文本样式配置项，参考 [绘图属性](/zh/docs/api/graphic-style) | | spacing | _number_ | `false` | 图例项 marker 同后面 name 的间距 | | formatter | _function_ | - | 格式化函数, `(text: string, item: ListItem, index: number) => any;` | @@ -89,7 +89,7 @@ | 参数名 | 类型 | 默认值 | 描述 | | --- | --- | --- | --- | -| style | _object_ | - | 文本样式配置项，详见 [绘图属性](../graphic-style) | +| style | _object_ | - | 文本样式配置项，详见 [绘图属性](/zh/docs/api/graphic-style) | | alignRight | _boolean_ | `false` | 是否右对齐，默认为 false，仅当设置图例项宽度时生效 | | formatter | _function_ | - | 格式化函数, `(text: string, item: ListItem, index: number) => any;` | @@ -116,7 +116,7 @@ | 参数名 | 类型 | 默认值 | 描述 | | --- | --- | --- | --- | | align | _string_ | - | 文本同滑轨的对齐方式
- rail ： 同滑轨对齐，在滑轨的两端
- top, bottom: 图例水平布局时有效
- left, right: 图例垂直布局时有效 | -| style | _object_ | - | 文本样式配置项，详见 [绘图属性](../graphic-style) | +| style | _object_ | - | 文本样式配置项，详见 [绘图属性](/zh/docs/api/graphic-style) | | spacing | _number_ | - | 文本同滑轨的距离 | ##### marker @@ -173,7 +173,7 @@ | type | _string_ | - | rail 的类型，color, size | | size | _number_ | - | 滑轨的宽度 | | defaultLength | _number_ | - | 滑轨的默认长度，，当限制了 maxWidth,maxHeight 时，不会使用这个属性会自动计算长度 | -| style | _object_ | - | 滑轨的样式，参考 [绘图属性](../graphic-style) | +| style | _object_ | - | 滑轨的样式，参考 [绘图属性](/zh/docs/api/graphic-style) | ##### reversed **optional** _boolean_ @@ -193,7 +193,7 @@ | 参数名 | 类型 | 默认值 | 描述 | | --- | --- | --- | --- | | spacing | _number_ | - | 标题同图例项的间距 | -| style | _object_ | - | 文本样式配置项，参考 [绘图属性](../graphic-style) | +| style | _object_ | - | 文本样式配置项，参考 [绘图属性](/zh/docs/api/graphic-style) | ##### track @@ -202,7 +202,7 @@ | 参数名 | 类型 | 默认值 | 描述 | | --- | --- | --- | --- | -| style | _object_ | - | 选定范围的样式，参考 [绘图属性](../graphic-style) | +| style | _object_ | - | 选定范围的样式，参考 [绘图属性](/zh/docs/api/graphic-style) | ##### values diff --git a/docs/common/shape-style.en.md b/docs/common/shape-style.en.md index 6e2645e227..fa0a6df1f9 100644 --- a/docs/common/shape-style.en.md +++ b/docs/common/shape-style.en.md @@ -36,4 +36,4 @@ Example： } ``` -More documents about `ShapeStyle`, see [Graphic Style](../graphic-style). \ No newline at end of file +More documents about `ShapeStyle`, see [Graphic Style](/en/docs/api/graphic-style). \ No newline at end of file diff --git a/docs/common/shape-style.zh.md b/docs/common/shape-style.zh.md index 0f3f6e2887..42802a5f0e 100644 --- a/docs/common/shape-style.zh.md +++ b/docs/common/shape-style.zh.md @@ -36,4 +36,4 @@ } ``` -关于 ShapeStyle 更加详细的文档参考 [绘图属性](../graphic-style)。 +关于 ShapeStyle 更加详细的文档参考 [绘图属性](/zh/docs/api/graphic-style)。 diff --git a/docs/common/slider.en.md b/docs/common/slider.en.md index b7e7f399ab..6035bb21e0 100644 --- a/docs/common/slider.en.md +++ b/docs/common/slider.en.md @@ -1,26 +1,26 @@ -object 类型的请参考[绘图属性](../../manual/graphic-style) +object 类型的请参考[ShapeAttrs](/en/docs/api/graphic-style) | 配置项 | 类型 | 功能描述 | | --------------- | -------- | ------------------ | -| start | number | 默认起始位置 | -| end | number | 默认结束位置 | -| height | number | 缩略轴高度 | -| trendCfg | trendCfg | 背景趋势的配置 | -| backgroundStyle | object | 背景配置 | -| foregroundStyle | object | 背景配置 | -| handlerStyle | object | handle 配置 | -| textStyle | object | 文本配置 | -| minLimit | number | 允许滑动位置下限 | -| maxLimit | number | 允许滑动位置上限 | -| formatter | Function | 滑块文本格式化函数 | +| start | _number_ | 默认起始位置 | +| end | _number_ | 默认结束位置 | +| height | _number_ | 缩略轴高度 | +| trendCfg | _trendCfg_ | 背景趋势的配置 | +| backgroundStyle | _object_ | 背景配置 | +| foregroundStyle | _object_ | 背景配置 | +| handlerStyle | _object_ | handle 配置 | +| textStyle | _object_ | 文本配置 | +| minLimit | _number_ | 允许滑动位置下限 | +| maxLimit | _number_ | 允许滑动位置上限 | +| formatter | _Function_ | 滑块文本格式化函数 | trendCfg | 配置项 | 类型 | 功能描述 | | --------------- | -------- | -------------- | -| data | number[] | 统计文本的样式 | -| smooth | boolean | 是否平滑 | -| isArea | boolean | 是否面积图 | -| backgroundStyle | object | 背景样式配置 | -| lineStyle | object | line 样式配置 | -| areaStyle | object | area 样式配置 | +| data | _number[]_ | 统计文本的样式 | +| smooth | _boolean_ | 是否平滑 | +| isArea | _boolean_ | 是否面积图 | +| backgroundStyle | _object_ | 背景样式配置 | +| lineStyle | _object_ | line 样式配置 | +| areaStyle | _object_ | area 样式配置 | diff --git a/docs/common/slider.zh.md b/docs/common/slider.zh.md index b7e7f399ab..f3c53de23f 100644 --- a/docs/common/slider.zh.md +++ b/docs/common/slider.zh.md @@ -1,26 +1,26 @@ -object 类型的请参考[绘图属性](../../manual/graphic-style) +object 类型的请参考[绘图属性](/zh/docs/api/graphic-style) | 配置项 | 类型 | 功能描述 | | --------------- | -------- | ------------------ | -| start | number | 默认起始位置 | -| end | number | 默认结束位置 | -| height | number | 缩略轴高度 | -| trendCfg | trendCfg | 背景趋势的配置 | -| backgroundStyle | object | 背景配置 | -| foregroundStyle | object | 背景配置 | -| handlerStyle | object | handle 配置 | -| textStyle | object | 文本配置 | -| minLimit | number | 允许滑动位置下限 | -| maxLimit | number | 允许滑动位置上限 | -| formatter | Function | 滑块文本格式化函数 | +| start | _number_ | 默认起始位置 | +| end | _number_ | 默认结束位置 | +| height | _number_ | 缩略轴高度 | +| trendCfg | _trendCfg_ | 背景趋势的配置 | +| backgroundStyle | _object_ | 背景配置 | +| foregroundStyle | _object_ | 背景配置 | +| handlerStyle | _object_ | handle 配置 | +| textStyle | _object_ | 文本配置 | +| minLimit | _number_ | 允许滑动位置下限 | +| maxLimit | _number_ | 允许滑动位置上限 | +| formatter | _Function_ | 滑块文本格式化函数 | trendCfg | 配置项 | 类型 | 功能描述 | | --------------- | -------- | -------------- | -| data | number[] | 统计文本的样式 | -| smooth | boolean | 是否平滑 | -| isArea | boolean | 是否面积图 | -| backgroundStyle | object | 背景样式配置 | -| lineStyle | object | line 样式配置 | -| areaStyle | object | area 样式配置 | +| data | _number[]_ | 统计文本的样式 | +| smooth | _boolean_ | 是否平滑 | +| isArea | _boolean_ | 是否面积图 | +| backgroundStyle | _object_ | 背景样式配置 | +| lineStyle | _object_ | line 样式配置 | +| areaStyle | _object_ | area 样式配置 | diff --git a/docs/manual/upgrade.en.md b/docs/manual/upgrade.en.md index e4f2216a77..f671b3bbd3 100644 --- a/docs/manual/upgrade.en.md +++ b/docs/manual/upgrade.en.md @@ -40,7 +40,7 @@ G2Plot 2.0 is compatible with most of the chart functions and configuration item | description | 不再支持 | - | | forceFit | 不再支持，改用 autoFit | - | | responsive | 不再支持，内置 | - | -| guideLine | 不再支持，改用 [anniotations](../../examples/general/annotation) 实现。 | - | +| guideLine | 不再支持，改用 [annotations](../../examples/general/annotation) 实现。 | - | | label | label.type 会有兼容性问题，如果报错修改 type 配置或者去掉 | - | | slider | 写法变更 | 示例 | | scrollbar | 写法变更 | 示例 | diff --git a/docs/manual/upgrade.zh.md b/docs/manual/upgrade.zh.md index 72556bd027..c09b8921d2 100644 --- a/docs/manual/upgrade.zh.md +++ b/docs/manual/upgrade.zh.md @@ -40,7 +40,7 @@ G2Plot 2.0 兼容大部分的 1.x 版本图表功能和配置项，详情如下 | description | 不再支持 | - | | forceFit | 不再支持，改用 autoFit | - | | responsive | 不再支持，内置 | - | -| guideLine | 不再支持，改用 [anniotations](../../examples/general/annotation) 实现。 | - | +| guideLine | 不再支持，改用 [annotations](../../examples/general/annotation) 实现。 | - | | label | label.type 会有兼容性问题，如果报错修改 type 配置或者去掉 | - | | slider | 写法变更 | 示例 | | scrollbar | 写法变更 | 示例 |