You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@echarts.apache.org by ov...@apache.org on 2020/02/02 15:10:39 UTC
[incubator-echarts-doc] branch master updated: Fix doc types mistakes (#87)

This is an automated email from the ASF dual-hosted git repository.

ovilia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-echarts-doc.git


The following commit(s) were added to refs/heads/master by this push:
     new 31ec1c6  Fix doc types mistakes (#87)
31ec1c6 is described below

commit 31ec1c62dca57b9e283ec6a2d1213661b59a432e
Author: susiwen8 <su...@gmail.com>
AuthorDate: Sun Feb 2 23:10:30 2020 +0800

    Fix doc types mistakes (#87)
---
 en/option/component/axis-common.md           |  6 ++----
 en/option/component/brush.md                 |  2 +-
 en/option/component/data-zoom-inside.md      |  6 +++---
 en/option/component/data-zoom-slider.md      |  4 ++--
 en/option/component/legend.md                |  2 +-
 en/option/component/visual-map-continuous.md |  2 +-
 en/option/component/visual-map-piecewise.md  |  2 +-
 en/option/partial/mark-line.md               |  2 +-
 en/option/partial/text-style.md              | 10 +++++-----
 en/option/partial/tooltip-common.md          |  2 +-
 en/option/series/candlestick.md              |  4 ++--
 en/option/series/funnel.md                   |  6 +++---
 zh/option/component/axis-common.md           |  4 ++--
 zh/option/component/brush.md                 |  2 +-
 zh/option/component/data-zoom-inside.md      |  6 +++---
 zh/option/component/data-zoom-slider.md      |  4 ++--
 zh/option/component/legend.md                |  2 +-
 zh/option/component/visual-map-continuous.md |  2 +-
 zh/option/component/visual-map-piecewise.md  |  2 +-
 zh/option/partial/animation.md               |  2 +-
 zh/option/partial/mark-line.md               |  2 +-
 zh/option/partial/text-style.md              | 10 +++++-----
 zh/option/partial/tooltip-common.md          |  4 ++--
 zh/option/series/candlestick.md              |  4 ++--
 zh/option/series/funnel.md                   |  6 +++---
 25 files changed, 48 insertions(+), 50 deletions(-)

diff --git a/en/option/component/axis-common.md b/en/option/component/axis-common.md
index 0832c29..98b8c97 100644
--- a/en/option/component/axis-common.md
+++ b/en/option/component/axis-common.md
@@ -372,7 +372,7 @@ For non-category axis, including time, numerical value, and log axes, `boundaryG
 boundaryGap: ['20%', '20%']
 ```
 
-#${prefix} min(number|string|function) = null
+#${prefix} min(number|string|Function) = null
 
 The minimun value of axis.
 
@@ -389,8 +389,7 @@ min: function (value) {
 }
 ```
 
-
-#${prefix} max(number|string) = null
+#${prefix} max(number|string|Function) = null
 
 The maximum value of axis.
 
@@ -407,7 +406,6 @@ max: function (value) {
 }
 ```
 
-
 #${prefix} scale(boolean) = false
 
 It is available only in numerical axis, i.e., [type](~${componentType}.type): 'value'.
diff --git a/en/option/component/brush.md b/en/option/component/brush.md
index 5dbb2f6..6939744 100644
--- a/en/option/component/brush.md
+++ b/en/option/component/brush.md
@@ -182,7 +182,7 @@ Defailt brush style, whose value is:
 
 {{use: partial-brush-throttle (galleryViewPath=${galleryViewPath})}}
 
-## removeOnClick(number) = true
+## removeOnClick(boolean) = true
 
 Defined whether *clearing all select-boxes on click* is enabled when [brush.brushMode](~brush.brushMode) is `'single'`.
 
diff --git a/en/option/component/data-zoom-inside.md b/en/option/component/data-zoom-inside.md
index 2bc95cd..f62aab2 100644
--- a/en/option/component/data-zoom-inside.md
+++ b/en/option/component/data-zoom-inside.md
@@ -34,7 +34,7 @@ Whether disable inside zoom.
 ) }}
 
 
-## zoomOnMouseWheel(boolean) = true
+## zoomOnMouseWheel(boolean|string) = true
 
 How to trigger zoom. Optional values:
 
@@ -44,7 +44,7 @@ How to trigger zoom. Optional values:
 + `'ctrl'`：Holding `ctrl` and mouse wheel triggers zoom.
 + `'alt'`：Holding `alt` and mouse wheel triggers zoom.
 
-## moveOnMouseMove(boolean) = true
+## moveOnMouseMove(boolean|string) = true
 
 How to trigger data window move. Optional values:
 
@@ -54,7 +54,7 @@ How to trigger data window move. Optional values:
 + `'ctrl'`：Holding `ctrl` and mouse move triggers data window move.
 + `'alt'`：Holding `alt` and mouse move triggers data window move.
 
-## moveOnMouseWheel(boolean) = false
+## moveOnMouseWheel(boolean|string) = false
 
 How to trigger data window move. Optional values:
 
diff --git a/en/option/component/data-zoom-slider.md b/en/option/component/data-zoom-slider.md
index 6588cff..c045527 100644
--- a/en/option/component/data-zoom-slider.md
+++ b/en/option/component/data-zoom-slider.md
@@ -69,7 +69,7 @@ Icon shape of handle, which supports path string. Its default value is:
 Refer to [area-simple example](${galleryEditorPath}area-simple) for customized icon.
 
 
-## handleSize(number) = '100%'
+## handleSize(number|string) = '100%'
 
 The size of control handle. It can be in pixels, or in percentage relative to the width of dataZoom component. By default, it's the same as the width of dataZoom component.
 
@@ -82,7 +82,7 @@ Style of handle. Please refer to [area-simple example](${galleryEditorPath}area-
     defaultColor="#a7b7cc"
 )}}
 
-## labelPrecision(number) = 'auto'
+## labelPrecision(number|string) = 'auto'
 
 Precision of label if in number form. By default, it is decided based on the number of data.
 
diff --git a/en/option/component/legend.md b/en/option/component/legend.md
index d291ce0..9147bde 100644
--- a/en/option/component/legend.md
+++ b/en/option/component/legend.md
@@ -60,7 +60,7 @@ Option:
 + 'left'
 + 'right'
 
-## padding(number) = 5
+## padding(number|Array) = 5
 
 {{ use: partial-padding(componentName="legend")}}
 
diff --git a/en/option/component/visual-map-continuous.md b/en/option/component/visual-map-continuous.md
index c08f908..591b0f6 100644
--- a/en/option/component/visual-map-continuous.md
+++ b/en/option/component/visual-map-continuous.md
@@ -142,7 +142,7 @@ The label text on both ends, such as `['High', 'Low']`. [sample](${galleryEditor
 You can understand the order of items in `text` array just by a simple trial. See [visualMap.inverse](~visualMap.inverse).
 
 
-## textGap(Array) = 10
+## textGap(number) = 10
 
 The distance between the ends of the main bar and the label, with unit px. See [visualMap-continuous.text](~visualMap-continuous.text)
 
diff --git a/en/option/component/visual-map-piecewise.md b/en/option/component/visual-map-piecewise.md
index 09c2782..a25ea79 100644
--- a/en/option/component/visual-map-piecewise.md
+++ b/en/option/component/visual-map-piecewise.md
@@ -180,7 +180,7 @@ You can understand the order of items in `text` array just by a simple trial. Se
 The rule, that labels will not show when `text` is use, is retained for compatibility with ECharts2.
 
 
-## textGap(Array) = 10
+## textGap(number) = 10
 
 The distance between the ends of the graphical elements for pieces and the labels, with unit px. See [visualMap-piecewise.text](~visualMap-piecewise.text)
 
diff --git a/en/option/partial/mark-line.md b/en/option/partial/mark-line.md
index 1de972d..4ded112 100644
--- a/en/option/partial/mark-line.md
+++ b/en/option/partial/mark-line.md
@@ -1,6 +1,6 @@
 {{ target: partial-mark-line }}
 
-#${prefix} markLine
+#${prefix} markLine(Object)
 Use a line in the chart to illustrate.
 
 {{ use: partial-silent(prefix="#" + ${prefix}) }}
diff --git a/en/option/partial/text-style.md b/en/option/partial/text-style.md
index e9f3304..0b9320d 100644
--- a/en/option/partial/text-style.md
+++ b/en/option/partial/text-style.md
@@ -114,7 +114,7 @@ Options are:
 + `'oblique'`
 
 
-#${prefix} fontWeight(string)=${defaultFontWeight|default('\'normal\'')}
+#${prefix} fontWeight(string|number)=${defaultFontWeight|default('normal')}
 
 ${name} font thick weight
 
@@ -214,7 +214,7 @@ auto adapted by default.
 {{ use: partial-text-style-auto-color-desc }}
 {{/if}}
 
-#${prefix} borderColor(string)='transparent'
+#${prefix} borderColor(Color)='transparent'
 
 Border color of the text fragment.
 
@@ -240,7 +240,7 @@ Padding of the text fragment, for example:
 
 Notice, `width` and `height` specifies the width and height of the content, without `padding`.
 
-#${prefix} shadowColor(string)='transparent'
+#${prefix} shadowColor(Color)='transparent'
 
 Shadow color of the text block.
 
@@ -279,7 +279,7 @@ Notice, `width` and `height` specifies the width and height of the content, with
 Notice, `width` and `height` only work when `rich` specified.
 
 
-#${prefix} textBorderColor(string)='transparent'
+#${prefix} textBorderColor(Color)='transparent'
 
 Storke color of the text.
 
@@ -292,7 +292,7 @@ Storke color of the text.
 
 Storke line width of the text.
 
-#${prefix} textShadowColor(string)='transparent'
+#${prefix} textShadowColor(Color)='transparent'
 
 Shadow color of the text itself.
 
diff --git a/en/option/partial/tooltip-common.md b/en/option/partial/tooltip-common.md
index 2cc0598..238daf8 100644
--- a/en/option/partial/tooltip-common.md
+++ b/en/option/partial/tooltip-common.md
@@ -26,7 +26,7 @@ tooltip can be configured on different places:
 
 {{target: partial-tooltip-in-coords}}
 
-## tooltip
+## tooltip(Object)
 
 tooltip settings in the coordinate system component.
 
diff --git a/en/option/series/candlestick.md b/en/option/series/candlestick.md
index 40dd045..cdbfd24 100644
--- a/en/option/series/candlestick.md
+++ b/en/option/series/candlestick.md
@@ -67,11 +67,11 @@ The default value is decided by:
 
 Specify bar width. Absolute value (like `10`) or percentage (like `'20%'`, according to band width) can be used. Auto adapt by default.
 
-## barMinWidth(number)
+## barMinWidth(number|string)
 
 Specify bar min width. Absolute value (like `10`) or percentage (like `'20%'`, according to band width) can be used. Auto adapt by default.
 
-## barMaxWidth(number)
+## barMaxWidth(number|string)
 
 Specify bar max width. Absolute value (like `10`) or percentage (like `'20%'`, according to band width) can be used. Auto adapt by default.
 
diff --git a/en/option/series/funnel.md b/en/option/series/funnel.md
index 8f0eedd..d1dc317 100644
--- a/en/option/series/funnel.md
+++ b/en/option/series/funnel.md
@@ -20,17 +20,17 @@ The specified minimum value.
 ## max(number) = 100
 The specified maximum value.
 
-## minSize(string) = '0%'
+## minSize(number|string) = '0%'
 The mapped width from minimum data value [min](~series-funnel.min).
 
 It can be absolute pixel and also the percentage of [layout width](~series-funnel.width). If you don't want the graph of minimum value to be a triangle, you can set up this property larger than 0.
 
-## maxSize(string) = '100%'
+## maxSize(number|string) = '100%'
 The mapped width from maximum data value [max](~series-funnel.max).
 
 It can be absolute pixel and also the percentage of [layout width](~series-funnel.width).
 
-## sort(string) = 'descending'
+## sort(string|Function) = 'descending'
 Data sorting, which can be whether `'ascending'`, `'descending'`, `'none'`(in data order) or a function, which is the same as `Array.prototype.sort(function (a, b) { ... })`;
 
 ## gap(number) = 0
diff --git a/zh/option/component/axis-common.md b/zh/option/component/axis-common.md
index 0db9619..422ae1e 100644
--- a/zh/option/component/axis-common.md
+++ b/zh/option/component/axis-common.md
@@ -350,7 +350,7 @@ splitLine: {
 boundaryGap: ['20%', '20%']
 ```
 
-#${prefix} min(number|string|function) = null
+#${prefix} min(number|string|Function) = null
 
 坐标轴刻度最小值。
 
@@ -370,7 +370,7 @@ min: function (value) {
 
 其中 `value` 是一个包含 `min` 和 `max` 的对象，分别表示数据的最大最小值，这个函数应该返回坐标轴的最小值。
 
-#${prefix} max(number|string) = null
+#${prefix} max(number|string|Function) = null
 
 坐标轴刻度最大值。
 
diff --git a/zh/option/component/brush.md b/zh/option/component/brush.md
index 14b7445..118c844 100644
--- a/zh/option/component/brush.md
+++ b/zh/option/component/brush.md
@@ -187,7 +187,7 @@ myChart.dispatchAction({
 
 {{use: partial-brush-throttle (galleryViewPath=${galleryViewPath})}}
 
-## removeOnClick(number) = true
+## removeOnClick(boolean) = true
 
 在 [brush.brushMode](~brush.brushMode) 为 `'single'` 的情况下，是否支持『单击清除所有选框』。
 
diff --git a/zh/option/component/data-zoom-inside.md b/zh/option/component/data-zoom-inside.md
index b3e64b1..adffbb0 100644
--- a/zh/option/component/data-zoom-inside.md
+++ b/zh/option/component/data-zoom-inside.md
@@ -32,7 +32,7 @@
     galleryViewPath=${galleryViewPath}
 ) }}
 
-## zoomOnMouseWheel(boolean) = true
+## zoomOnMouseWheel(boolean|string) = true
 
 如何触发缩放。可选值为：
 
@@ -42,7 +42,7 @@
 + `'ctrl'`：表示按住 `ctrl` 和鼠标滚轮能触发缩放。
 + `'alt'`：表示按住 `alt` 和鼠标滚轮能触发缩放。
 
-## moveOnMouseMove(boolean) = true
+## moveOnMouseMove(boolean|string) = true
 
 如何触发数据窗口平移。可选值为：
 
@@ -52,7 +52,7 @@
 + `'ctrl'`：表示按住 `ctrl` 和鼠标移动能触发数据窗口平移。
 + `'alt'`：表示按住 `alt` 和鼠标移动能触发数据窗口平移。
 
-## moveOnMouseWheel(boolean) = true
+## moveOnMouseWheel(boolean|string) = true
 
 如何触发数据窗口平移。可选值为：
 
diff --git a/zh/option/component/data-zoom-slider.md b/zh/option/component/data-zoom-slider.md
index 0e4ae61..2c5b2a2 100644
--- a/zh/option/component/data-zoom-slider.md
+++ b/zh/option/component/data-zoom-slider.md
@@ -71,7 +71,7 @@
 
 自定义 icon 见 [示例 area-simple](${galleryEditorPath}area-simple)
 
-## handleSize(number) = '100%'
+## handleSize(number|string) = '100%'
 
 控制手柄的尺寸，可以是像素大小，也可以是相对于 dataZoom 组件宽度的百分比，默认跟 dataZoom 宽度相同。
 
@@ -85,7 +85,7 @@
 )}}
 
 
-## labelPrecision(number) = 'auto'
+## labelPrecision(number|string) = 'auto'
 
 显示label的小数精度。默认根据数据自动决定。
 
diff --git a/zh/option/component/legend.md b/zh/option/component/legend.md
index d315895..13683d5 100644
--- a/zh/option/component/legend.md
+++ b/zh/option/component/legend.md
@@ -59,7 +59,7 @@ ECharts 3 中单个 echarts 实例中可以存在多个图例组件，会方便
 + `'left'`
 + `'right'`
 
-## padding(number) = 5
+## padding(number|Array) = 5
 
 {{ use: partial-padding(componentName="图例")}}
 
diff --git a/zh/option/component/visual-map-continuous.md b/zh/option/component/visual-map-continuous.md
index a4fae02..3620d4c 100644
--- a/zh/option/component/visual-map-continuous.md
+++ b/zh/option/component/visual-map-continuous.md
@@ -136,7 +136,7 @@ chart.setOption({visualMap: {range: null}}); // 再把 range 设为 null。
 `text` 中的顺序，其实试试就知道。若要看详细的规则，参见 [visualMap.inverse](~visualMap.inverse)。
 
 
-## textGap(Array) = 10
+## textGap(number) = 10
 
 两端文字主体之间的距离，单位为px。参见 [visualMap-continuous.text](~visualMap-continuous.text)
 
diff --git a/zh/option/component/visual-map-piecewise.md b/zh/option/component/visual-map-piecewise.md
index 908c26b..743f58f 100644
--- a/zh/option/component/visual-map-piecewise.md
+++ b/zh/option/component/visual-map-piecewise.md
@@ -183,7 +183,7 @@ series.data 的 `dataMin` 和 `dataMax`）。
 
 兼容 ECharts2，当有 `text` 时，label不显示。
 
-## textGap(Array) = 10
+## textGap(number) = 10
 
 两端文字主体之间的距离，单位为px。参见 [visualMap-piecewise.text](~visualMap-piecewise.text)
 
diff --git a/zh/option/partial/animation.md b/zh/option/partial/animation.md
index 88a6669..088eb39 100644
--- a/zh/option/partial/animation.md
+++ b/zh/option/partial/animation.md
@@ -54,7 +54,7 @@ animationDelayUpdate: function (idx) {
 
 {{ target: partial-animation-init}}
 
-#${prefix} animationDuration(number) = ${defaultAnimationDuration|default(1000)}
+#${prefix} animationDuration(number|Function) = ${defaultAnimationDuration|default(1000)}
 
 初始动画的时长，支持回调函数，可以通过每个数据返回不同的时长实现更戏剧的初始动画效果：
 
diff --git a/zh/option/partial/mark-line.md b/zh/option/partial/mark-line.md
index 8774c3b..f72e02e 100644
--- a/zh/option/partial/mark-line.md
+++ b/zh/option/partial/mark-line.md
@@ -1,6 +1,6 @@
 {{ target: partial-mark-line }}
 
-#${prefix} markLine
+#${prefix} markLine(Object)
 图表标线。
 
 {{ use: partial-silent(prefix="#" + ${prefix}) }}
diff --git a/zh/option/partial/text-style.md b/zh/option/partial/text-style.md
index 839a2f9..9220cc0 100644
--- a/zh/option/partial/text-style.md
+++ b/zh/option/partial/text-style.md
@@ -114,7 +114,7 @@ ${name}文字字体的风格
 + `'oblique'`
 
 
-#${prefix} fontWeight(string)=${defaultFontWeight|default('\'normal\'')}
+#${prefix} fontWeight(string|number)=${defaultFontWeight|default('normal')}
 
 ${name}文字字体的粗细
 
@@ -208,7 +208,7 @@ backgroundColor: {
 {{ use: partial-text-style-auto-color-desc }}
 {{/if}}
 
-#${prefix} borderColor(string)='transparent'
+#${prefix} borderColor(Color)='transparent'
 
 文字块边框颜色。
 
@@ -234,7 +234,7 @@ backgroundColor: {
 
 注意，文字块的 `width` 和 `height` 指定的是内容高宽，不包含 `padding`。
 
-#${prefix} shadowColor(string)='transparent'
+#${prefix} shadowColor(Color)='transparent'
 
 文字块的背景阴影颜色。
 
@@ -271,7 +271,7 @@ backgroundColor: {
 
 注意，如果不定义 `rich` 属性，则不能指定 `width` 和 `height`。
 
-#${prefix} textBorderColor(string)='transparent'
+#${prefix} textBorderColor(Color)='transparent'
 
 文字本身的描边颜色。
 
@@ -283,7 +283,7 @@ backgroundColor: {
 
 文字本身的描边宽度。
 
-#${prefix} textShadowColor(string)='transparent'
+#${prefix} textShadowColor(Color)='transparent'
 
 文字本身的阴影颜色。
 
diff --git a/zh/option/partial/tooltip-common.md b/zh/option/partial/tooltip-common.md
index 0d1d09c..0cb03f8 100644
--- a/zh/option/partial/tooltip-common.md
+++ b/zh/option/partial/tooltip-common.md
@@ -24,7 +24,7 @@
 
 {{target: partial-tooltip-in-coords}}
 
-## tooltip
+## tooltip(Object)
 
 本坐标系特定的 tooltip 设定。
 
@@ -53,7 +53,7 @@
 
 {{target: partial-tooltip-in-series}}
 
-## tooltip
+## tooltip(Object)
 
 本系列特定的 tooltip 设定。
 
diff --git a/zh/option/series/candlestick.md b/zh/option/series/candlestick.md
index 2f6915f..e63544e 100644
--- a/zh/option/series/candlestick.md
+++ b/zh/option/series/candlestick.md
@@ -63,11 +63,11 @@
 
 指定柱宽度。可以使用绝对数值（如 `10`）或百分比（如 `'20%'`，表示 band width 的百分之多少）。默认自适应。
 
-## barMinWidth(number)
+## barMinWidth(number|string)
 
 指定柱最小宽度。可以使用绝对数值（如 `10`）或百分比（如 `'20%'`，表示 band width 的百分之多少）。默认自适应。
 
-## barMaxWidth(number)
+## barMaxWidth(number|string)
 
 指定柱最大宽度。可以使用绝对数值（如 `10`）或百分比（如 `'20%'`，表示 band width 的百分之多少）。默认自适应。
 
diff --git a/zh/option/series/funnel.md b/zh/option/series/funnel.md
index 7adb6d2..1220bdd 100644
--- a/zh/option/series/funnel.md
+++ b/zh/option/series/funnel.md
@@ -20,17 +20,17 @@
 ## max(number) = 100
 指定的数据最大值。
 
-## minSize(string) = '0%'
+## minSize(number|string) = '0%'
 数据最小值 [min](~series-funnel.min) 映射的宽度。
 
 可以是绝对的像素大小，也可以是相对[布局宽度](~series-funnel.width)的百分比，如果需要最小值的图形并不是尖端三角，可通过设置该属性实现。
 
-## maxSize(string) = '100%'
+## maxSize(number|string) = '100%'
 数据最大值 [max](~series-funnel.max) 映射的宽度。
 
 可以是绝对的像素大小，也可以是相对[布局宽度](~series-funnel.width)的百分比。
 
-## sort(string) = 'descending'
+## sort(string|Function) = 'descending'
 数据排序， 可以取 `'ascending'`，`'descending'`，`'none'`（表示按 data 顺序），或者一个函数（即 `Array.prototype.sort(function (a, b) { ... })`）。
 
 ## gap(number) = 0


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@echarts.apache.org
For additional commands, e-mail: commits-help@echarts.apache.org