Merge pull request #409 from apache/master

Merge master branch into dev

en/api/action.md

@@ -494,6 +494,38 @@ api.dispatchAction({
 });
 ```
 
+## treemap
+
+Actions related to [treemap series](option.html#series-treemap).
+
+### treemapZoomToNode(Action)
+Zoom to the target node.
+
+```ts
+dispatchAction({
+    type: 'treemapZoomToNode',
+
+    {{ use: action-series-query }}
+
+    // target node id or name (`name` is invalid if the target node has `id`)
+    targetNodeId: string
+})
+```
+
+### treemapRootToNode(Action)
+Zoom to and enter the target node.
+
+```ts
+dispatchAction({
+    type: 'treemapRootToNode',
+
+    {{ use: action-series-query }}
+
+    // target node `id` or `name` (`name` is invalid if the target node has `id`)
+    targetNodeId: string
+})
+```
+
 
 
 {{ target: action-select }}

en/option/component/aria.md

@@ -48,15 +48,15 @@ option = {
 
 ~[700x300](${galleryViewPath}doc-example/aria-pie&edit=1&reset=1)
 
-On the generated chart DOM, there is an `aria-label` attribute that allows the blind to understand the chart with the help of a reading device. Its value is.
+On the generated chart DOM, there is an `aria-label` attribute that allows the blind to understand the chart with the help of a reading device. Its value is:
 
 > This is a chart of "Source of user access to a site." The chart type is a pie chart that indicates the source of the visit. The data is - direct access data is 335, mail marketing data is 310, union ad data is 234, video ad data is 135, search engine data is 1548.
 
 The basic process for generating the description is that if [aria.enabled](~aria.enabled) is set to `true` (not the default) and [aria.label.enabled](~aria.label.enabled) is set to `true` (the default), then the accessibility description is generated. Otherwise it is not generated. If [aria.label.description](~aria.label.description) is defined, it is used as the full description of the chart, otherwise the description is generated according to the template stitching. We provide a default algorithm for generating descriptions, and only if the generated descriptions are not quite right, you need to modify these templates, or even override them completely with `aria.label.description`.
 
-When using the template, whether [title.text](~title.text) is used along with [aria.label.general.withTitle](option.html#aria.label.general.withTitle) while [aria.label.general.withoutTitle](option.html#aria.label.general.withoutTitle) is used if there is no title text. `aria.general.withTitle` supports a template `'{title}'`, which will be replaced with chart title. This means, if `aria.general.withTitle` is set to be `'The chart title is {title}.'` and the chart title is `Price Distribution`, it will be interpreted into `'The chart title is Price Distribution.'`
+When using the template, if [title.text](~title.text)is set, it is used in [aria.label.general.withTitle](option.html#aria.label.general.withTitle). If [title.text](~title.text) has no value, [aria.label.general.withoutTitle](option.html#aria.label.general.withoutTitle) is used instead. `aria.general.withTitle` supports a template `'{title}'`, which will be replaced with the chart title. This means, if `aria.general.withTitle` is set to be `'The chart title is {title}.'` and the chart title is `Price Distribution`, it will be interpreted into `'The chart title is Price Distribution.'`
 
-After generating the title, the description of the series ([aria.label.series](option.html#aria.label.series)) and the description of the data for each series ([aria.label.data](option.html#aria.label.data)) are generated in turn. The following is an example of a template. Likewise, each template may include template variables to replace actual values.
+After generating the title, the description of the series ([aria.label.series](option.html#aria.label.series)) and the description of the data for each series ([aria.label.data](option.html#aria.label.data)) are generated in turn.
 
 The complete description generation process is:
 

en/option/partial/barGrid.md

@@ -47,9 +47,11 @@ The minimum angle of bar. It could be used to avoid the following situation: the
 
 <ExampleUIControlNumber min="0" />
 
-## barGap(string) = ${barGapDefault|default('30%')}
+## barGap(string) = ${barGapDefault|default('20%')}
 
-The gap between bars between different series, is a percent value like `'30%'`, which means `30%` of the bar width.
+<ExampleUIControlPercent default="${barGapDefault|default('20%')}"/>
+
+The gap between bars between different series, is a percent value like `'20%'`, which means `20%` of the bar width.
 
 Set barGap as `'-100%'` can overlap bars that belong to different series, which is useful when making a series of bar be background.
 
@@ -60,9 +62,9 @@ Set barGap as `'-100%'` can overlap bars that belong to different series, which
 For example:
 ~[600x400](${galleryViewPath}doc-example/barGrid-barGap&reset=1&edit=1)
 
-## barCategoryGap(string) = '20%'
+## barCategoryGap(number|string)
 
-The bar gap of a single series, defaults to be `20%` of the category gap, can be set as a fixed value.
+The bar gap of a single series, by default, a suitable spacing is calculated based on the number of series in the bar chart. When there are more series, the spacing will be appropriately reduced, can be set as a fixed value.
 
 {{ use: partial-barGrid-share-desc(
     seriesType = ${seriesType}

en/option/partial/emphasis-common.md

@@ -17,7 +17,7 @@ When emphasis state is disabled. There will be no highlight effect when the mous
 
 {{ target: partial-focus-blur-scope }}
 
-### focus(string) = 'none'
+###${prefix} focus(string) = 'none'
 
 {{ if: ${isGeoCoordSys} }}
 {{ use: partial-version(
@@ -74,7 +74,7 @@ emphasis: {
 {{ /if }}
 
 {{ if: !${isGeoCoordSys} }}
-### blurScope(string) = 'coordinateSystem'
+###${prefix} blurScope(string) = 'coordinateSystem'
 
 {{ use: partial-version(
     version = "5.0.0"

en/option/partial/mark-area.md

@@ -14,7 +14,10 @@ Used to mark an area in chart. For example, mark a time interval.
 Label in mark area.
 
 {{ use: partial-label(
-    prefix = ${prefix} + '##'
+    prefix = ${prefix} + '##',
+    defaultShowLabel = true,
+    defaultPosition = "'top'",
+    formatter = true
 ) }}
 
 ##${prefix} itemStyle(Object)
@@ -36,7 +39,10 @@ Emphasis status of mark area.
 ###${prefix} label(Object)
 
 {{ use: partial-label(
-    prefix = ${prefix} + '###'
+    prefix = ${prefix} + '###',
+    defaultShowLabel = true,
+    defaultPosition = "'top'",
+    formatter = true
 ) }}
 
 ###${prefix} itemStyle(*)
@@ -56,7 +62,10 @@ Configurations of blur state. Whether to blur follows the series.
 ###${prefix} label(Object)
 
 {{ use: partial-label(
-    prefix = ${prefix} + '###'
+    prefix = ${prefix} + '###',
+    defaultShowLabel = true,
+    defaultPosition = "'top'",
+    formatter = true
 ) }}
 
 ###${prefix} itemStyle(*)
@@ -141,8 +150,7 @@ data: [
 Specify the left-top point.
 
 {{ use: mark-area-data-item-item(
-    name = "start",
-    prefix = "###"+${prefix},
+    prefix = "###" + ${prefix},
     seriesType = ${seriesType},
     hasCoord = ${hasCoord},
     hasType = ${hasType},
@@ -154,8 +162,7 @@ Specify the left-top point.
 Specify the right-bottom point.
 
 {{ use: mark-area-data-item-item(
-    name = "end",
-    prefix = "###"+${prefix},
+    prefix = "###" + ${prefix},
     seriesType = ${seriesType},
     hasCoord = ${hasCoord},
     hasType = ${hasType},
@@ -207,7 +214,7 @@ The format is [start coordinate, end coordinate], where the coordinate system ca
 
 #${prefix} name(string) = '${name}'
 
-Name of the marker, which will display as a label.
+Name of the marker, which will display as a label. Can be used as a template variable **data name** `{b}` in [label formatter](~series-${seriesType}.markArea.data.label.formatter).
 
 #${prefix} x(number)
 
@@ -240,7 +247,10 @@ Label style of the item.
 Label style of start point and end point will be merged together.
 
 {{ use: partial-label(
-    prefix = '#'+${prefix}
+    prefix = '#'+${prefix},
+    defaultShowLabel = true,
+    defaultPosition = "'top'",
+    formatter = true
 ) }}
 
 #${prefix} emphasis(Object)
@@ -258,7 +268,10 @@ Label style of start point and end point will be merged together.
 ##${prefix} label(Object)
 
 {{ use: partial-label(
-    prefix = '##'+${prefix}
+    prefix = '##'+${prefix},
+    defaultShowLabel = true,
+    defaultPosition = "'top'",
+    formatter = true
 ) }}
 
 #${prefix} blur(Object)
@@ -276,6 +289,9 @@ Label style of start point and end point will be merged together.
 ##${prefix} label(Object)
 
 {{ use: partial-label(
-    prefix = '##'+${prefix}
+    prefix = '##'+${prefix},
+    defaultShowLabel = true,
+    defaultPosition = "'top'",
+    formatter = true
 ) }}
 

en/option/partial/mark-line.md

@@ -158,8 +158,7 @@ data: [
 Data of the starting point.
 
 {{ use: mark-line-data-item-item(
-    name = "starting point",
-    prefix = "###"+${prefix},
+    prefix = "###" + ${prefix},
     seriesType = ${seriesType},
     hasCoord = ${hasCoord},
     hasType = ${hasType},
@@ -171,8 +170,7 @@ Data of the starting point.
 Data of the ending point.
 
 {{ use: mark-line-data-item-item(
-    name = "ending point",
-    prefix = "###"+${prefix},
+    prefix = "###" + ${prefix},
     seriesType = ${seriesType},
     hasCoord = ${hasCoord},
     hasType = ${hasType},
@@ -261,7 +259,7 @@ Coordinates of the starting point or ending point, whose format depends on the c
 
 #${prefix} name(string) = '${name}'
 
-Name of the marker, which will display as a label.
+Name of the marker. Can be used as a template variable **data name** `{b}` in [label formatter](~series-${seriesType}.markLine.data.label.formatter).
 
 #${prefix} x(number)
 

en/option/partial/mark-point.md

@@ -49,6 +49,8 @@ Emphasis status of mark point.
 
 {{ use: partial-label(
     prefix = "###" + ${prefix},
+    defaultShowLabel = true,
+    defaultPosition = "'inside'",
     formatter = true
 ) }}
 
@@ -70,6 +72,8 @@ Configurations of blur state. Whether to blur follows the series.
 
 {{ use: partial-label(
     prefix = "###" + ${prefix},
+    defaultShowLabel = true,
+    defaultPosition = "'inside'",
     formatter = true
 ) }}
 
@@ -116,9 +120,9 @@ data: [{{ if: ${hasType} }}
 ]
 ```
 
-###${prefix} name(string) = ''
+###${prefix} name(string)
 
-Mark point name.
+Mark point name. Can be used as a template variable **data name** `{b}` in [label formatter](~series-${seriesType}.markPoint.data.label.formatter).
 
 {{ if: ${hasType} }}
 ###${prefix} type(string)
@@ -183,7 +187,10 @@ Mark point style.
 ###${prefix} label(Object)
 
 {{ use: partial-label(
-    prefix = ${prefix} + '###'
+    prefix = ${prefix} + '###',
+    defaultShowLabel = true,
+    defaultPosition = "'inside'",
+    formatter = true
 ) }}
 
 ###${prefix} emphasis(Object)
@@ -195,7 +202,10 @@ Mark point style.
 ####${prefix} label(Object)
 
 {{ use: partial-label(
-    prefix = ${prefix} + '####'
+    prefix = ${prefix} + '####',
+    defaultShowLabel = true,
+    defaultPosition = "'inside'",
+    formatter = true
 ) }}
 
 ####${prefix} itemStyle(Object)
@@ -213,7 +223,10 @@ Mark point style.
 ####${prefix} label(Object)
 
 {{ use: partial-label(
-    prefix = ${prefix} + '####'
+    prefix = ${prefix} + '####',
+    defaultShowLabel = true,
+    defaultPosition = "'inside'",
+    formatter = true
 ) }}
 
 ####${prefix} itemStyle(Object)

en/option/partial/selected-mode.md

@@ -11,7 +11,7 @@
 
 <ExampleUIControlEnum options="false,true,single,multiple,series" />
 
-Selected mode. It is enabled by default, and you may set it to be `false` to disable it.
+Selected mode. It is disabled by default, and you may set it to be `true` to enable it.
 
 Besides, it can be set to `'single'`, `'multiple'` or `'series'`, for single selection, multiple selections and whole series selection.
 

en/option/series/boxplot.md

@@ -33,10 +33,6 @@ Multiple `series` can be displayed in the same coordinate system. Please refer t
 
 {{ use: partial-legend-hover-link() }}
 
-## hoverAnimation(boolean) = true
-
-Whether to enable the animation when hovering on box.
-
 ## layout(string) = null
 
 Layout methods, whose optional values are:

en/option/series/candlestick.md

@@ -47,10 +47,6 @@ We use red to represent increasing and blue decreasing by default. If you want t
 
 {{ use: partial-legend-hover-link() }}
 
-## hoverAnimation(boolean) = true
-
-Whether to enable animation when hovering on box.
-
 ## layout(string) = null
 
 Layout method, whose values may be:
@@ -86,10 +82,10 @@ Item style of candlestick.
 
 {{ use: partial-candlestick-item-style-detail(
     prefix = "##",
-    defaultColor = "#c23531",
-    defaultColor0 = "#314656",
-    defaultBorderColor = "#c23531",
-    defaultBorderColor0 = "#314656",
+    defaultColor = "#eb5454",
+    defaultColor0 = "#47b262",
+    defaultBorderColor = "#eb5454",
+    defaultBorderColor0 = "#47b262",
     defaultBorderWidth = 1
 ) }}
 

en/option/series/graph.md

@@ -360,9 +360,9 @@ Select state of nodes in this category.
 
 For the situation where there are multiple links between nodes, the curveness of each link is automatically calculated, not enabled by default.
 
-When set `true` to enable automatic curvature calculation, the default edge curvenness array length is `20`, if the number of edges between two nodes is more than `20`, please use `number` or `Array` to set the edge curvenness array.
+When set to `true`, it enables automatic curvature calculation. The default edge curveness array length is `20`, if the number of edges between two nodes is more than `20`, please use `number` or `Array` to set the edge curveness array.
 
-When set to `number`, it indicates the length of the edge curvenness array between two nodes, and the calculation result is given by the internal algorithm.
+When set to `number`, it indicates the length of the edge curveness array between two nodes, and the calculation result is given by the internal algorithm.
 
 When set to `Array`, it means that the curveness array is directly specified, and the multilateral curveness is directly selected from the array.