update docs

antvis · Nov 20, 2019 · 38cc198 · 38cc198
1 parent 7036eae
commit 38cc198
Show file tree

Hide file tree

Showing 13 changed files with 289 additions and 21 deletions.
diff --git a/docs/manual/general-config.zh.md b/docs/manual/general-config.zh.md
@@ -107,17 +107,117 @@ htmlContent: (title, items) => {
 `offsetX: number`    图例在 position 的基础上再往 x 方向偏移量，单位 px。/>
 `offsetY: number`    图例在 position 的基础上再往 y 方向偏移量，单位 px。
 
+## axis
+
+**optional**
+
+`visible: boolean`  坐标轴是否可见
+
+### line
+
+坐标轴轴线
+
+`visible: boolean` 坐标轴轴线是否可见
+
+`style: object | function` 坐标轴轴线样式
+- `stroke: string` 坐标轴轴线颜色 
+- `lineWidth: number`  描边宽度<br />
+- `lineDash: number[]`  描边虚线显示<br />
+- `opacity: number`  透明度
+
+### grid
+
+坐标轴网格
+
+`visible: boolean` 坐标轴网格是否可见
+
+`style: object | function` 坐标轴网格样式
+- `stroke: string` 坐标轴轴线颜色 
+- `lineWidth: number`  描边宽度<br />
+- `lineDash: number[]`  描边虚线显示<br />
+- `opacity: number`  透明度
+
+
+### label
+
+坐标轴标签
+
+`visible: boolean` 坐标轴网格是否可见
+
+`formatter: function` 对 label 的显示文本进行格式化
+
+`offsetX: number` 在 label 位置的基础上再往 x 方向的偏移量
+
+`offsetY: number` 在 label 位置的基础上再往 y 方向的偏移量
+
+`style: object` 配置 label 文本样式
+- `fill: string` label颜色
+- `fontSize: number` label文本大小
+- `fontWeight: number` label文本字体粗细
+- `stroke: string` label文本描边颜色
+- `lineWidth: number` label文本描边粗细
+- `opacity: number` label文本透明度
+
+### title
+
+坐标轴标题
+
+`visible: boolean` 坐标轴标题是否可见
+`text: string` 坐标轴标题文字
+`offset: number` 坐标轴标题位置偏移量
+
+`style: object` 配置 title 文本样式
+- `fill: string` title 颜色
+- `fontSize: number` title 文本大小
+- `fontWeight: number` title 文本字体粗细
+- `stroke: string` title 文本描边颜色
+- `lineWidth: number` title 文本描边粗细
+- `opacity: number` title 文本透明度
+
+
+### tickLine
+
+坐标轴刻度线
+
+`visible: boolean` 坐标轴标题是否可见
+
+`style: object | function` 坐标轴网格样式
+- `stroke: string` 坐标轴轴线颜色 
+- `lineWidth: number`  描边宽度<br />
+- `lineDash: number[]`  描边虚线显示<br />
+- `opacity: number`  透明度
+
+
+## linearAxis 
+
+连续型坐标轴，通常用于展示连续型数值映射的坐标轴。常见于表示时间连续性的x轴 (折线图) 和大部分直角坐标系图表的y轴（如折线图、面积图、柱状图等）。
+
+`min: number` 设置坐标轴最小值
+
+`max: number` 设置坐标轴最大值
+
+`tickCount: number` 设置坐标轴刻度数量
+
+`tickInterval: number` 设置坐标轴刻度间隔
+
+
+## categoryAxis
+
+分类型坐标轴，通常用于展示分类型数据的映射关系。常见于柱状图系列的X轴及条形图系列的y轴。
+
+
+
 ## events
 
 **optional**
 
-- 图表区域事件：/>
+- 图表区域事件:
   `onPlotClick: function`     图表区域点击事件<br />
   `onPlotDblClick: function`  图表区域双击事件<br />
   `onPlotMousemove: function`    图表区域鼠标移动事件<br />
   `onPlotContextmenu: function`    图表区域右键事件
 
-- 图例事件：/>
+- 图例事件:
   `onLabelClick: function`     图例点击事件<br />
   `onLabelDblClick: function`  图例双击事件<br />
   `onLabelMouseMove: function`  图例鼠标移动事件<br />

diff --git a/docs/manual/plots/area.zh.md b/docs/manual/plots/area.zh.md
@@ -137,6 +137,15 @@ const data = [
 `size: number`  数据点大小<br />
 `style: object | function`  数据点图形样式，另外该属性还支持回调函数的配置方式，入参为当前图形的对应数据，出参为一个样式配置对象
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#axis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。

diff --git a/docs/manual/plots/bar.zh.md b/docs/manual/plots/bar.zh.md
@@ -115,6 +115,16 @@ const data = [
 
 另外还支持回调函数的配置方式，入参为当前图形的对应数据，出参为一个样式配置对象。
 
+
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#categoryaxis)。
+
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。

diff --git a/docs/manual/plots/column.zh.md b/docs/manual/plots/column.zh.md
@@ -115,6 +115,14 @@ const data = [
 
 另外还支持回调函数的配置方式，入参为当前图形的对应数据，出参为一个样式配置对象。
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#categoryaxis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。

diff --git a/docs/manual/plots/gauge.zh.md b/docs/manual/plots/gauge.zh.md
@@ -79,13 +79,11 @@ order: 12
 
 仪表的色条范围区间，数组的前后两项组成的元组将对应一个颜色区间，例如：[0, 40, 60, 100]。
 
-### label:number
+### statistic:function
 
 **optional**
 
-当 label 为 boolean 值时，为指示文字标签是否显示；
-
-当 label 为一个 function 时，则该函数的两个入参分别是将要显示的数值 value，以及经过了格式化函数后的 formatted，该函数返回 html 字符串。
+配置指标卡。该函数的两个入参分别是将要显示的数值 value，以及经过了格式化函数后的 formatted，该函数返回 html 字符串。
 
 ### formatter:number
 

diff --git a/docs/manual/plots/group-bar.zh.md b/docs/manual/plots/group-bar.zh.md
@@ -82,6 +82,14 @@ const data = [
 
 **optional** 见[通用图表配置](../general-config#theme)。
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#categoryaxis)。
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#theme)。

diff --git a/docs/manual/plots/group-column.zh.md b/docs/manual/plots/group-column.zh.md
@@ -82,6 +82,14 @@ const data = [
 
 **optional** 见[通用图表配置](../general-config#theme)。
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#categoryaxis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。

diff --git a/docs/manual/plots/line.zh.md b/docs/manual/plots/line.zh.md
@@ -151,6 +151,14 @@ const data = [
 `size: number`  数据点大小<br />
 `style: object | function`  数据点样式
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#axis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。

diff --git a/docs/manual/plots/ring.zh.md b/docs/manual/plots/ring.zh.md
@@ -47,35 +47,34 @@ const data = [
 
 配置范围为 [0,1]，0 代表环图被完全填充，变为饼图，没有中心挖空部分，1 代表环图的厚度为 0。默认值为 0.8。
 
-#### annotation
 
-**optional**
+### statistic
 
-图表的辅助标注
+**optional**
 
-##### centralText
+指标卡
 
-中心文本
+`content: string|object`  指标卡内容
 
-`content: string|object`  中心文本内容
+用户可以指定一段文字(此时指标卡单行显示)或一组数据(此时指标卡分两行显示)，指定数据时需采用`{ name:xxx, value:xxx }`的格式。如不配置 content，则默认显示第一行数据。
 
-用户可以指定一段文字(此时中心文本单行显示)或一组数据(此时中心文本分两行显示)，指定数据时需采用`{ name:xxx, value:xxx }`的格式。如不配置 content，则默认显示第一行数据。
+`htmlContent: string` 自定义指标卡
 
-`htmlContent: string` 自定义中心文本
+用户可以根据 htmlContent 方法的 data 参数定义指标卡 dom 节点的构成和显示方式。
 
-用户可以根据 htmlContent 方法的 data 参数定义中心文本 dom 节点的构成和显示方式。
+`triggerOn: string` 响应鼠标交互交互的事件，默认为`mouseenter`，此时 tooltip 默认不再显示。
 
-`onActive: boolean` 是否自动响应鼠标交互
+`triggerOff: string` 关闭鼠标交互交互的事件，默认为`mouseleave`。
 
-当设置为 true 时，鼠标滑过弧形切片时中心文本显示当前弧形切片内容，此时 tooltip 默认不再显示。
 
 用法：
 
 ```
-annotation: [
+statistic: [
   {
-    type: 'centralText',
-    onActive: true,
+    visible: true,
+    triggerOn: 'mouseenter,
+    triggerOff: 'mouseleave'
   },
 ];
 ```

diff --git a/docs/manual/plots/stack-area.zh.md b/docs/manual/plots/stack-area.zh.md
@@ -76,6 +76,14 @@ work in progress
 
 **optional** 见[通用图表配置](../general-config#theme)。
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#axis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。

diff --git a/docs/manual/plots/stack-bar.zh.md b/docs/manual/plots/stack-bar.zh.md
@@ -84,6 +84,14 @@ const data = [
 
 **optional** 见[通用图表配置](../general-config#theme)。
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#categoryaxis)。
+
 ### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。

diff --git a/docs/manual/plots/stack-column.zh.md b/docs/manual/plots/stack-column.zh.md
@@ -84,6 +84,14 @@ const data = [
 
 **optional** 见[通用图表配置](../general-config#theme)。
 
+### xAxis
+
+**optional** 见[通用图表配置](../general-config#categoryaxis)。
+
+### yAxis
+
+**optional** 见[通用图表配置](../general-config#linearaxis)。
+
 #### tooltip
 
 **optional** 见[通用图表配置](../general-config#tooltip)。