chore: merge master to dev

README.md

@@ -60,42 +60,58 @@ For example,
 ### Global Variables
 
 These global variables can be used in doc:
-+ `${galleryViewPath}`
-+ `${galleryEditorPath}`
-+ `${websitePath}`
++ `${galleryViewPath}`: Use it like `${galleryViewPath}pie-legend`.
++ `${galleryEditorPath}`: Use it like `${galleryEditorPath}pie-legend`.
++ `${optionDocPath}`: Use it like `${optionDocPath}#xAxis.type`.
++ `${apiDocPath}`: Use it like `${apiDocPath}#echarts.init`.
++ `${handbookPath}`: Use it like `${handbookPath}basics/import`.
++ `${websitePath}`: Use it like `${websitePath}/examples/en/index.html#chart-type-custom`.
 
 See samples in "Reference of echarts-examples or other links"
 
-### Reference of echarts-examples or Other Links
+### Reference of Other ECharts Option
 
-Embed an example in doc:
+A `~` can be used to refer to a option item in the same doc. For example:
 ```md
-~[700X300](${galleryEditorPath}pie-legend&edit=1&reset=1)
-~[700x300](${galleryViewPath}doc-example/aria-pie&edit=1&reset=1)
+[xAxis.name](~xAxis.name)
 ```
 
-Provide an example link in doc:
+To reference an anchor in different doc, it can be:
 ```md
-[vertically scrollable legend](${galleryEditorPath}pie-legend&edit=1&reset=1)
-[aria pie](${galleryViewPath}doc-example/aria-pie&edit=1&reset=1)
+[itemStyle](option.html#series.itemStyle)
+[action.highlight](api.html#action.highlight)
+[Custom Series](tutorial.html#Custom%20Series)
+[Use ECharts with bundler and NPM](${handbookPath}basics/import)
 ```
 
-Provide a website link in doc:
+To add references in a code block, we have to:
 ```md
-[Apache ECharts website](${websitePath}/en/download.html)
+// See doc: ${optionDocPath}#series-bar.select
+// See doc: ${apiDocPath}#echarts.init
 ```
 
-### Reference of Other ECharts Option
+### Reference of echarts-examples or Other Links
 
-A `~` can be used to refer to a option item in the same doc. For example:
+Embed an example in doc (display the example directly in doc with an iframe. To avoid performance issues, do not overuse it.):
 ```md
-[xAxis.name](~xAxis.name)
+~[700X300](${galleryViewPath}pie-legend&edit=1&reset=1)
+~[700x300](${galleryViewPath}doc-example/aria-pie&edit=1&reset=1)
 ```
 
-If intending to reference an anchor in different doc, it can be:
+Insert an image:
 ```md
-In api.html, reference
-[itemStyle](option.html#series.itemStyle)
+[600xauto](~axis-align-with-label.png)
+```
+
+Provide an example link in doc:
+```md
+[vertically scrollable legend](${galleryEditorPath}pie-legend&edit=1&reset=1)
+[aria pie](${galleryEditorPath}doc-example/aria-pie&edit=1&reset=1)
+```
+
+Provide a website link in doc:
+```md
+[Apache ECharts website](${websitePath}/en/download.html)
 ```
 
 

build/build-doc.js

@@ -23,7 +23,7 @@ const chalk = require('chalk');
 const argv = require('yargs').argv;
 const path = require('path');
 const chokidar = require('chokidar');
-const {debounce} = require('lodash');
+const {debounce, cloneDeep} = require('lodash');
 const {getDocJSONPVarNname} = require('../src/shared');
 const {readConfigEnvFile} = require('./helper');
 
@@ -63,17 +63,24 @@ for (let key in config) {
 }
 
 async function md2jsonAsync(opt) {
-
     var newOpt = Object.assign({
         path: path.join(opt.language, opt.entry, '**/*.md'),
-        tplEnv: Object.assign({}, config, {
-            galleryViewPath: config.galleryViewPath.replace('${lang}', opt.language),
-            galleryEditorPath: config.galleryEditorPath.replace('${lang}', opt.language),
-            handbookPath: config.handbookPath.replace('${lang}', opt.language)
-        }),
+        tplEnv: replaceLangInConfig(cloneDeep(config)),
         imageRoot: config.imagePath
     }, opt);
 
+    function replaceLangInConfig(config) {
+        for (const [prop, value] of Object.entries(config)) {
+            if (typeof value === 'object' && value) {
+                replaceLangInConfig(value)
+            }
+            else if (typeof value === 'string') {
+                config[prop] = value.replace('${lang}', opt.language)
+            }
+        }
+        return config;
+    }
+
     function run(cb) {
         md2json(newOpt).then(schema => {
             writeSingleSchema(schema, opt.language, opt.entry, false);

config/env.asf.js

@@ -3,6 +3,8 @@ const path = require('path');
 module.exports = {
     galleryViewPath: 'https://echarts.apache.org/examples/${lang}/view.html?c=',
     galleryEditorPath: 'https://echarts.apache.org/examples/${lang}/editor.html?c=',
+    optionDocPath: 'https://echarts.apache.org/${lang}/option.html',
+    apiDocPath: 'https://echarts.apache.org/${lang}/api.html',
     handbookPath: 'https://echarts.apache.org/handbook/${lang}/',
     websitePath: 'https://echarts.apache.org',
 

config/env.dev.js

@@ -3,6 +3,8 @@ const path = require('path');
 module.exports = {
     galleryViewPath: 'http://localhost/echarts-website/examples/${lang}/view.html?c=',
     galleryEditorPath: 'http://localhost/echarts-website/examples/${lang}/editor.html?c=',
+    optionDocPath: 'https://echarts.apache.org/${lang}/option.html',
+    apiDocPath: 'https://echarts.apache.org/${lang}/api.html',
     handbookPath: 'http://localhost/echarts-website/handbook/${lang}/',
     websitePath: 'http://localhost/echarts-website',
 

config/env.localsite.js

@@ -3,6 +3,8 @@ const path = require('path');
 module.exports = {
     galleryViewPath: 'http://localhost/echarts-website/examples/${lang}/view.html?c=',
     galleryEditorPath: 'http://localhost/echarts-website/examples/${lang}/editor.html?c=',
+    optionDocPath: 'https://echarts.apache.org/${lang}/option.html',
+    apiDocPath: 'https://echarts.apache.org/${lang}/api.html',
     handbookPath: 'http://localhost/echarts-website/handbook/${lang}/',
     websitePath: './',
 

en/api/action.md

@@ -28,6 +28,37 @@
     name?: string,{{/target}}
 
 
+{{ target: action-axis-break-expand-collapse-common }}
+Can not be used to create a new axis break.
+```ts
+dispatchAction({
+    type: '${actionType}',
+
+    // The target axis components can be queried by either index, id, or name.
+    xAxisIndex?: 'all' | number;
+    xAxisId?: string | number;
+    xAxisName?: string;
+    yAxisIndex?: 'all' | number;
+    yAxisId?: string | number;
+    yAxisName?: string;
+    singleAxisIndex?: 'all' | number;
+    singleAxisId?: string | number;
+    singleAxisName?: number;
+
+    breaks: {
+        // Use the start/end to identify the target break items.
+        // See more details in doc: ${optionDocPath}#xAxis.breaks.start
+        start: string | number | Date,
+        end: string | number | Date,
+    }
+})
+```
+
+Then event [axisbreakchanged](~events.axisbreakchanged) is triggered.
+
+See also [axis break isExpanded](option.html#xAxis.breaks.isExpanded).
+{{/target}}
+
 
 {{ target: action }}
 # action
@@ -127,6 +158,39 @@ dispatchAction({
 })
 ```
 
+
+## axis
+
+### expandAxisBreak
+
+{{ use: partial-version(version = "6.0.0") }}
+
+Expand one or multiple existing axis break items.
+
+{{ use: action-axis-break-expand-collapse-common(
+    actionType = "expandAxisBreak"
+) }}
+
+### collapseAxisBreak
+
+{{ use: partial-version(version = "6.0.0") }}
+
+Collapse one or multiple existing axis break items.
+
+{{ use: action-axis-break-expand-collapse-common(
+    actionType = "collapseAxisBreak"
+) }}
+
+### toggleAxisBreak
+
+{{ use: partial-version(version = "6.0.0") }}
+
+Toggle (expand/collapse) one or multiple existing axis break items.
+
+{{ use: action-axis-break-expand-collapse-common(
+    actionType = "toggleAxisBreak"
+) }}
+
 ## legend
 
 Actions related to [legend component](option.html#legend), [legend component](option.html#legend) should be imported before use.