From 1d8367492b2fe27f799889cccdaa80cd39f742cb Mon Sep 17 00:00:00 2001 From: plainheart <yhen@all-my-life.cn> Date: Tue, 2 Jul 2024 13:47:41 +0800 Subject: [PATCH 01/13] fix candlestick doc for apache/echarts#20105 --- en/option/partial/emphasis-common.md | 6 ++--- en/option/partial/select-common.md | 6 ++--- en/option/series/candlestick.md | 35 ++++++++++++++++++++++++---- zh/option/partial/emphasis-common.md | 6 ++--- zh/option/partial/select-common.md | 8 +++---- zh/option/series/candlestick.md | 35 ++++++++++++++++++++++++---- 6 files changed, 75 insertions(+), 21 deletions(-) diff --git a/en/option/partial/emphasis-common.md b/en/option/partial/emphasis-common.md index cd695648..93497a36 100644 --- a/en/option/partial/emphasis-common.md +++ b/en/option/partial/emphasis-common.md @@ -1,12 +1,12 @@ {{ target: partial-emphasis-disabled }} -#${prefix} disabled(boolean) +#${prefix} disabled(boolean) = ${defaultValue|default(false)} -<ExampleUIControlBoolean default="false" /> +<ExampleUIControlBoolean default="${defaultValue|default(false)}" /> {{ use: partial-version( - version = "5.3.0" + version = ${version|default('5.3.0')} ) }} Whether to disable the emphasis state. diff --git a/en/option/partial/select-common.md b/en/option/partial/select-common.md index f911bc09..33d9e779 100644 --- a/en/option/partial/select-common.md +++ b/en/option/partial/select-common.md @@ -1,12 +1,12 @@ {{ target: partial-select-disabled }} -#${prefix} disabled(boolean) +#${prefix} disabled(boolean) = ${defaultValue|default(false)} -<ExampleUIControlBoolean default="false" /> +<ExampleUIControlBoolean default="${defaultValue|default(false)}" /> {{ use: partial-version( - version = "5.3.0" + version = ${version|default('5.3.0')} ) }} If data can be selected. Available when `selectedMode` is used. Can be used to disable selection for part of the data. diff --git a/en/option/series/candlestick.md b/en/option/series/candlestick.md index 5a799447..ce6f5e41 100644 --- a/en/option/series/candlestick.md +++ b/en/option/series/candlestick.md @@ -91,12 +91,26 @@ Item style of candlestick. ## emphasis(Object) +{{ use: partial-version( + version = "5.5.2" +) }} + Emphasis style of candlestick. {{ use: partial-emphasis-disabled( - prefix = "##" + prefix = "##", + defaultValue = true ) }} +**Note:** The emphasis state is disabled in the candlestick series by default for historical reasons and needs to be explicitly enabled as follows. + +```js +emphasis: { + // enable the emphasis state + disabled: false +} +``` + {{ use: partial-focus-blur-scope() }} ### itemStyle(Object) @@ -109,7 +123,7 @@ Emphasis style of candlestick. ## blur(Object) {{ use: partial-version( - version = "5.0.0" + version = "5.5.2" ) }} Configurations of blur state. Available when [emphasis.focus](~series-candlestick.emphasis.focus) is set. @@ -137,7 +151,8 @@ Configurations of select state. Available when [selectedMode](~series-candlestic {{ use: partial-candlestick-item-style-detail( prefix = "###", - defaultBorderWidth = 2 + defaultBorderWidth = 2, + option0Version = "5.5.2" ) }} {{ use: partial-selected-mode( @@ -315,6 +330,12 @@ Fill color of bullish candle stick. <ExampleUIControlColor /> +{{ if: ${option0Version} }} +{{ use: partial-version( + version = ${option0Version} +) }} +{{ /if }} + Fill color of bearish candle stick. {{ use: partial-color-desc() }} @@ -331,6 +352,12 @@ Border color of bullish candle stick. <ExampleUIControlColor /> +{{ if: ${option0Version} }} +{{ use: partial-version( + version = ${option0Version} +) }} +{{ /if }} + Border color of bearish candle stick. {{ use: partial-color-desc() }} @@ -340,7 +367,7 @@ Border color of bearish candle stick. <ExampleUIControlColor /> {{ use: partial-version( - version = "5.4.1" + version = ${option0Version|default("5.4.1")} ) }} Border color of doji (when the open price is the same as the close price). diff --git a/zh/option/partial/emphasis-common.md b/zh/option/partial/emphasis-common.md index a712dfcb..836ec155 100644 --- a/zh/option/partial/emphasis-common.md +++ b/zh/option/partial/emphasis-common.md @@ -1,12 +1,12 @@ {{ target: partial-emphasis-disabled }} -#${prefix} disabled(boolean) +#${prefix} disabled(boolean) = ${defaultValue|default(false)} -<ExampleUIControlBoolean default="false" /> +<ExampleUIControlBoolean default="${defaultValue|default(false)}" /> {{ use: partial-version( - version = "5.3.0" + version = ${version|default('5.3.0')} ) }} 是否关闭高亮状态。 diff --git a/zh/option/partial/select-common.md b/zh/option/partial/select-common.md index 779fb8c5..ff3b9e51 100644 --- a/zh/option/partial/select-common.md +++ b/zh/option/partial/select-common.md @@ -1,13 +1,13 @@ {{ target: partial-select-disabled }} -#${prefix} disabled(boolean) +#${prefix} disabled(boolean) = ${defaultValue|default(false)} -<ExampleUIControlBoolean default="false" /> +<ExampleUIControlBoolean default="${defaultValue|default(false)}" /> {{ use: partial-version( - version = "5.3.0" + version = ${version|default('5.3.0')} ) }} -是否可以被选中。在开启`selectedMode`的时候有效,可以用于关闭部分数据。 +是否可以被选中。在开启 `selectedMode` 的时候有效,可以用于关闭部分数据。 diff --git a/zh/option/series/candlestick.md b/zh/option/series/candlestick.md index 053be3a1..132fbed2 100644 --- a/zh/option/series/candlestick.md +++ b/zh/option/series/candlestick.md @@ -277,12 +277,26 @@ K 线图的图形样式。 ## emphasis(Object) +{{ use: partial-version( + version = "5.5.2" +) }} + K 线图的高亮状态。 {{ use: partial-emphasis-disabled( - prefix = "##" + prefix = "##", + defaultValue = true ) }} +**注意:** K 线图由于历史遗留原因,默认关闭,需要如下显式启用。 + +```js +emphasis: { + // 启用高亮状态 + disabled: false +} +``` + {{ use: partial-focus-blur-scope() }} ### itemStyle(Object) @@ -295,7 +309,7 @@ K 线图的高亮状态。 ## blur(Object) {{ use: partial-version( - version = "5.0.0" + version = "5.5.2" ) }} K 线图的淡出状态。开启 [emphasis.focus](~series-candlestick.emphasis.focus) 后有效 @@ -323,7 +337,8 @@ K 线图的选中状态。开启 [selectedMode](~series-candlestick.selectedMode {{ use: partial-candlestick-item-style-detail( prefix = "###", - defaultBorderWidth = 2 + defaultBorderWidth = 2, + option0Version = "5.5.2" ) }} {{ use: partial-selected-mode( @@ -502,6 +517,12 @@ K 线图的选中状态。开启 [selectedMode](~series-candlestick.selectedMode <ExampleUIControlColor /> +{{ if: ${option0Version} }} +{{ use: partial-version( + version = ${option0Version} +) }} +{{ /if }} + `阴线` 图形的颜色。 {{ use: partial-color-desc() }} @@ -520,6 +541,12 @@ K 线图的选中状态。开启 [selectedMode](~series-candlestick.selectedMode `阴线` 图形的描边颜色。 +{{ if: ${option0Version} }} +{{ use: partial-version( + version = ${option0Version} +) }} +{{ /if }} + {{ use: partial-color-desc() }} #${prefix} borderColorDoji(Color) = null @@ -527,7 +554,7 @@ K 线图的选中状态。开启 [selectedMode](~series-candlestick.selectedMode <ExampleUIControlColor /> {{ use: partial-version( - version = "5.4.1" + version = ${option0Version|default("5.4.1")} ) }} 十字星(开盘价等于收盘价)的描边颜色。 From f46838023bea3190937eef08aff89968a91d4dc7 Mon Sep 17 00:00:00 2001 From: plainheart <yhen@all-my-life.cn> Date: Tue, 16 Jul 2024 11:11:33 +0800 Subject: [PATCH 02/13] still enable emphasis state for candlestick series by default --- en/option/series/candlestick.md | 12 +----------- zh/option/series/candlestick.md | 12 +----------- 2 files changed, 2 insertions(+), 22 deletions(-) diff --git a/en/option/series/candlestick.md b/en/option/series/candlestick.md index ce6f5e41..d70ff07f 100644 --- a/en/option/series/candlestick.md +++ b/en/option/series/candlestick.md @@ -98,19 +98,9 @@ Item style of candlestick. Emphasis style of candlestick. {{ use: partial-emphasis-disabled( - prefix = "##", - defaultValue = true + prefix = "##" ) }} -**Note:** The emphasis state is disabled in the candlestick series by default for historical reasons and needs to be explicitly enabled as follows. - -```js -emphasis: { - // enable the emphasis state - disabled: false -} -``` - {{ use: partial-focus-blur-scope() }} ### itemStyle(Object) diff --git a/zh/option/series/candlestick.md b/zh/option/series/candlestick.md index 132fbed2..d0a9c6b6 100644 --- a/zh/option/series/candlestick.md +++ b/zh/option/series/candlestick.md @@ -284,19 +284,9 @@ K 线图的图形样式。 K 线图的高亮状态。 {{ use: partial-emphasis-disabled( - prefix = "##", - defaultValue = true + prefix = "##" ) }} -**注意:** K 线图由于历史遗留原因,默认关闭,需要如下显式启用。 - -```js -emphasis: { - // 启用高亮状态 - disabled: false -} -``` - {{ use: partial-focus-blur-scope() }} ### itemStyle(Object) From 9bb5fd3071d953d15271627844c1317b459d09f8 Mon Sep 17 00:00:00 2001 From: adaelixir <huanxiqiao@qq.com> Date: Tue, 23 Jul 2024 00:51:59 +0800 Subject: [PATCH 03/13] feature(axis): Add showMinLine and showMaxLine to splitLine --- en/option/component/axis-common.md | 12 ++++++++++++ zh/option/component/axis-common.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/en/option/component/axis-common.md b/en/option/component/axis-common.md index b95c9e57..cea35d3f 100644 --- a/en/option/component/axis-common.md +++ b/en/option/component/axis-common.md @@ -415,6 +415,18 @@ Split line of axis in [grid](~grid) area. Set this to `false` to prevent the splitLine from showing. `value` type axes are shown by default, while `category` type axes are hidden. +##${prefix} showMinLine(boolean) = null + +<ExampleUIControlBoolean /> + +Whether to show the line of the min tick. Optional values: `true`, `false`. Default is true. + +##${prefix} showMaxLabel(boolean) = null + +<ExampleUIControlBoolean /> + +Whether to show the line of the max tick. Optional values: `true`, `false`. Default is true. + {{ if: ${hasLabelInterval|default(true)} }} ##${prefix} interval(number|Function) = 'auto' diff --git a/zh/option/component/axis-common.md b/zh/option/component/axis-common.md index 6c61a8d0..9c976bbf 100644 --- a/zh/option/component/axis-common.md +++ b/zh/option/component/axis-common.md @@ -412,6 +412,18 @@ axisTick: { 是否显示分隔线。默认数值轴显示,类目轴不显示。 +##${prefix} showMinLine(boolean) + +<ExampleUIControlBoolean /> + +是否显示最小 tick 的 分隔线。可取值 `true`, `false`。默认为 true。 + +##${prefix} showMaxLine(boolean) + +<ExampleUIControlBoolean /> + +是否显示最大 tick 的 分隔线。可取值 `true`, `false`。默认为 true。 + {{ if: ${hasLabelInterval|default(true)} }} ##${prefix} interval(number|Function) = 'auto' From f47d90aa2724f3b46ac3867beaf396ce7cf75152 Mon Sep 17 00:00:00 2001 From: plainheart <yhen@all-my-life.cn> Date: Tue, 23 Jul 2024 18:28:53 +0800 Subject: [PATCH 04/13] tweak doc for #411 & add version tip --- en/option/component/axis-common.md | 16 ++++++++++++---- zh/option/component/axis-common.md | 16 ++++++++++++---- 2 files changed, 24 insertions(+), 8 deletions(-) diff --git a/en/option/component/axis-common.md b/en/option/component/axis-common.md index cea35d3f..6c78f5e8 100644 --- a/en/option/component/axis-common.md +++ b/en/option/component/axis-common.md @@ -415,17 +415,25 @@ Split line of axis in [grid](~grid) area. Set this to `false` to prevent the splitLine from showing. `value` type axes are shown by default, while `category` type axes are hidden. -##${prefix} showMinLine(boolean) = null +##${prefix} showMinLine(boolean) = true <ExampleUIControlBoolean /> -Whether to show the line of the min tick. Optional values: `true`, `false`. Default is true. +{{ use: partial-version( + version = "5.5.2" +) }} -##${prefix} showMaxLabel(boolean) = null +Whether to show the splitLine of the min tick. Defaults to `true`. + +##${prefix} showMaxLabel(boolean) = true <ExampleUIControlBoolean /> -Whether to show the line of the max tick. Optional values: `true`, `false`. Default is true. +{{ use: partial-version( + version = "5.5.2" +) }} + +Whether to show the splitLine of the max tick. Defaults to `true`. {{ if: ${hasLabelInterval|default(true)} }} ##${prefix} interval(number|Function) = 'auto' diff --git a/zh/option/component/axis-common.md b/zh/option/component/axis-common.md index 9c976bbf..87d52c61 100644 --- a/zh/option/component/axis-common.md +++ b/zh/option/component/axis-common.md @@ -412,17 +412,25 @@ axisTick: { 是否显示分隔线。默认数值轴显示,类目轴不显示。 -##${prefix} showMinLine(boolean) +##${prefix} showMinLine(boolean) = true <ExampleUIControlBoolean /> -是否显示最小 tick 的 分隔线。可取值 `true`, `false`。默认为 true。 +{{ use: partial-version( + version = "5.5.2" +) }} + +是否显示最小 tick 的分隔线。默认为 `true`。 -##${prefix} showMaxLine(boolean) +##${prefix} showMaxLine(boolean) = true <ExampleUIControlBoolean /> -是否显示最大 tick 的 分隔线。可取值 `true`, `false`。默认为 true。 +{{ use: partial-version( + version = "5.5.2" +) }} + +是否显示最大 tick 的分隔线。默认为 `true`。 {{ if: ${hasLabelInterval|default(true)} }} ##${prefix} interval(number|Function) = 'auto' From 1b055061330a39762a865d33437118f5d4f70b42 Mon Sep 17 00:00:00 2001 From: semla <semla.dev@gmail.com> Date: Sat, 3 Aug 2024 11:58:06 +0200 Subject: [PATCH 05/13] docs: exclude column indexes from aria-label pr: https://github.com/apache/echarts/pull/20218 --- en/option/component/aria.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/en/option/component/aria.md b/en/option/component/aria.md index f90c0408..7a538927 100644 --- a/en/option/component/aria.md +++ b/en/option/component/aria.md @@ -183,6 +183,10 @@ This description is used if the data does not have the `name` attribute. This in - `{value}`: the value that will be replaced with the data. +#### excludeDimensionId(Array) + +The specified column indexes are excluded in the data in [aria.label](~aria.label) + #### separator(Object) The separator between data and data description. From 40a89754abf2644888ab835c83518b0e9b172d92 Mon Sep 17 00:00:00 2001 From: semla <semla.dev@gmail.com> Date: Mon, 5 Aug 2024 15:43:29 +0200 Subject: [PATCH 06/13] docs: sync to zh --- zh/option/component/aria.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/zh/option/component/aria.md b/zh/option/component/aria.md index 464994e2..c92ce3a3 100644 --- a/zh/option/component/aria.md +++ b/zh/option/component/aria.md @@ -183,6 +183,10 @@ option = { - `{value}`:将被替换为数据的值。 +#### excludeDimensionId(Array) + +The specified column indexes are excluded in the data in [aria.label](~aria.label) + #### separator(Object) 数据与数据之间描述的分隔符。 From 43eda89478d5eee49a53dc231e3532468805d5f7 Mon Sep 17 00:00:00 2001 From: Ovilia <zwl.sjtu@gmail.com> Date: Thu, 7 Nov 2024 17:02:36 +0800 Subject: [PATCH 07/13] doc(dataZoom): dataZoom.handleLabel apache/echarts#20082 --- en/option/component/data-zoom-slider.md | 32 +++++++++++++++++++++++++ zh/option/component/data-zoom-slider.md | 32 +++++++++++++++++++++++++ 2 files changed, 64 insertions(+) diff --git a/en/option/component/data-zoom-slider.md b/en/option/component/data-zoom-slider.md index 20edd329..37bd4df8 100644 --- a/en/option/component/data-zoom-slider.md +++ b/en/option/component/data-zoom-slider.md @@ -123,6 +123,22 @@ Style of handle. Please refer to [area-simple example](${galleryEditorPath}area- defaultBorderColor = "#ACB8D1" ) }} +## handleLabel(Object) + +{{ use: partial-version( + version = "5.5.2" +) }} + +Style settings for the text near the handle. + +### show(boolean) = false + +{{ use: partial-version( + version = "5.5.2" +) }} + +Whether to show the label. + ## moveHandleIcon(string) <ExampleUIControlIcon /> @@ -274,6 +290,22 @@ Style when highlighted. prefix = "###" ) }} +### handleLabel(Object) + +{{ use: partial-version( + version = "5.5.2" +) }} + +Style settings for the text near the handle. + +#### show(boolean) = false + +{{ use: partial-version( + version = "5.5.2" +) }} + +Whether to show the label. + ### moveHandleStyle(Object) {{ use: partial-item-style( diff --git a/zh/option/component/data-zoom-slider.md b/zh/option/component/data-zoom-slider.md index 1dd383e9..8990061c 100644 --- a/zh/option/component/data-zoom-slider.md +++ b/zh/option/component/data-zoom-slider.md @@ -153,6 +153,22 @@ const option = { defaultBorderColor = "#ACB8D1" ) }} +## handleLabel(Object) + +{{ use: partial-version( + version = "5.5.2" +) }} + +手柄附近文字的样式设置。 + +### show(boolean) = false + +{{ use: partial-version( + version = "5.5.2" +) }} + +是否显示文字。 + ## moveHandleIcon(string) <ExampleUIControlIcon /> @@ -306,6 +322,22 @@ dataZoom-slider 组件的高度。水平布局默认 30,竖直布局默认自 prefix = "###" ) }} +### handleLabel(Object) + +{{ use: partial-version( + version = "5.5.2" +) }} + +手柄附近文字的样式设置。 + +#### show(boolean) = false + +{{ use: partial-version( + version = "5.5.2" +) }} + +是否显示文字。 + ### moveHandleStyle(Object) {{ use: partial-item-style( From ef2dc2beeb5e2a7ca8e08bd0cfd956e3fbe85e1d Mon Sep 17 00:00:00 2001 From: Ovilia <zwl.sjtu@gmail.com> Date: Thu, 7 Nov 2024 17:28:00 +0800 Subject: [PATCH 08/13] doc(aria): update doc for apache/echarts#20218 --- en/option/component/aria.md | 6 +++++- zh/option/component/aria.md | 8 ++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/en/option/component/aria.md b/en/option/component/aria.md index 7a538927..87592dac 100644 --- a/en/option/component/aria.md +++ b/en/option/component/aria.md @@ -185,7 +185,11 @@ This description is used if the data does not have the `name` attribute. This in #### excludeDimensionId(Array) -The specified column indexes are excluded in the data in [aria.label](~aria.label) +{{ use: partial-version( + version = "5.5.2" +) }} + +The specified column indexes are excluded in the data in [aria.label](~aria.label). #### separator(Object) diff --git a/zh/option/component/aria.md b/zh/option/component/aria.md index c92ce3a3..abaf0d3e 100644 --- a/zh/option/component/aria.md +++ b/zh/option/component/aria.md @@ -68,7 +68,7 @@ option = { ### description(string) = null -默认采用算法自动生成图表描述,如果用户需要完全自定义,可以将这个值设为描述。如将其设置为 `'这是一个展示了价格走势的图表'`,则图表 DOM 元素的 `aria-label` 属性值即为该字符串。 +默认采用算法自动生成图表描述,如果用户需要完全自定义,可以将这个值设为描���。如将其设置为 `'这是一个展示了价格走势的图表'`,则图表 DOM 元素的 `aria-label` 属性值即为该字符串。 这一配置项常用于展示单个的数据并不能展示图表内容时,用户显示指定概括性描述图表的文字。例如图表是一个包含大量散点图的地图,默认的算法只能显示数据点的位置,不能从整体上传达作者的意图。这时候,可以将 `description` 指定为作者想表达的内容即可。 @@ -185,7 +185,11 @@ option = { #### excludeDimensionId(Array) -The specified column indexes are excluded in the data in [aria.label](~aria.label) +{{ use: partial-version( + version = "5.5.2" +) }} + +忽略 [aria.label](~aria.label) 下数据相应的维度。 #### separator(Object) From 4e56d57f738277caf3863b9a26d0d0965c273eb0 Mon Sep 17 00:00:00 2001 From: Ovilia <zwl.sjtu@gmail.com> Date: Thu, 7 Nov 2024 17:43:37 +0800 Subject: [PATCH 09/13] doc(treemap): treemap.cursor apache/echarts#20113 --- en/option/partial/cursor.md | 8 ++++++++ en/option/series/treemap.md | 4 ++++ zh/option/partial/cursor.md | 8 ++++++++ zh/option/series/treemap.md | 4 ++++ 4 files changed, 24 insertions(+) diff --git a/en/option/partial/cursor.md b/en/option/partial/cursor.md index e79cf5d4..1defb973 100644 --- a/en/option/partial/cursor.md +++ b/en/option/partial/cursor.md @@ -5,5 +5,13 @@ <ExampleUIControlEnum options="auto,pointer,move" default="pointer" /> +{{ if: ${version} }} + +{{ use: partial-version( + version = ${version} +) }} + +{{ /if }} + The mouse style when mouse hovers on an element, the same as `cursor` property in `CSS`. diff --git a/en/option/series/treemap.md b/en/option/series/treemap.md index 8ca384b0..68a28005 100644 --- a/en/option/series/treemap.md +++ b/en/option/series/treemap.md @@ -67,6 +67,10 @@ The expected square ratio. Layout would approach the ratio as close as possible. It defaults to be the golden ratio: `0.5 * (1 + Math.sqrt(5))`. +{{ use: partial-cursor( + version = "5.5.2" +) }} + ## leafDepth(number) = null <ExampleUIControlNumber min="1" step="1" /> diff --git a/zh/option/partial/cursor.md b/zh/option/partial/cursor.md index 109f366d..30ea7310 100644 --- a/zh/option/partial/cursor.md +++ b/zh/option/partial/cursor.md @@ -5,5 +5,13 @@ <ExampleUIControlEnum options="auto,pointer,move" default="pointer" /> +{{ if: ${version} }} + +{{ use: partial-version( + version = ${version} +) }} + +{{ /if }} + 鼠标悬浮时在图形元素上时鼠标的样式是什么。同 CSS 的 `cursor`。 diff --git a/zh/option/series/treemap.md b/zh/option/series/treemap.md index 8780440b..8525eb2b 100644 --- a/zh/option/series/treemap.md +++ b/zh/option/series/treemap.md @@ -220,6 +220,10 @@ const option = { 默认为黄金比:`0.5 * (1 + Math.sqrt(5))`。 +{{ use: partial-cursor( + version = "5.5.2" +) }} + ## leafDepth(number) = null <ExampleUIControlNumber min="1" step="1" /> From 2c0783375711772366b750971992c5b55584f804 Mon Sep 17 00:00:00 2001 From: Ovilia <zwl.sjtu@gmail.com> Date: Thu, 7 Nov 2024 17:50:41 +0800 Subject: [PATCH 10/13] doc: fix typo --- zh/option/component/aria.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh/option/component/aria.md b/zh/option/component/aria.md index abaf0d3e..a3654567 100644 --- a/zh/option/component/aria.md +++ b/zh/option/component/aria.md @@ -68,7 +68,7 @@ option = { ### description(string) = null -默认采用算法自动生成图表描述,如果用户需要完全自定义,可以将这个值设为描���。如将其设置为 `'这是一个展示了价格走势的图表'`,则图表 DOM 元素的 `aria-label` 属性值即为该字符串。 +默认采用算法自动生成图表描述,如果用户需要完全自定义,可以将这个值设为描述。如将其设置为 `'这是一个展示了价格走势的图表'`,则图表 DOM 元素的 `aria-label` 属性值即为该字符串。 这一配置项常用于展示单个的数据并不能展示图表内容时,用户显示指定概括性描述图表的文字。例如图表是一个包含大量散点图的地图,默认的算法只能显示数据点的位置,不能从整体上传达作者的意图。这时候,可以将 `description` 指定为作者想表达的内容即可。 From 5bf6a6c147f1e3c4d10a6453d5cadb9a3bc96102 Mon Sep 17 00:00:00 2001 From: sz-p <sz_p@outlook.com> Date: Mon, 11 Nov 2024 19:41:33 +0800 Subject: [PATCH 11/13] docs(sunburst): add new emphasis focus strategy 'relative' for highlighting ancestor and descendant nodes --- en/option/series/sunburst.md | 4 +++- zh/option/series/sunburst.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/en/option/series/sunburst.md b/en/option/series/sunburst.md index 6927ec23..867ca29a 100644 --- a/en/option/series/sunburst.md +++ b/en/option/series/sunburst.md @@ -314,7 +314,9 @@ The start angle, which range is [0, 360]. Configurations of emphasis state. {{ use: partial-focus-blur-scope( - isTree = true + isTree = true, + hasRelative = true, + relativeVersion = '5.5.2' ) }} {{ use: partial-sunburst-state( diff --git a/zh/option/series/sunburst.md b/zh/option/series/sunburst.md index 5b0958bf..1dad6837 100644 --- a/zh/option/series/sunburst.md +++ b/zh/option/series/sunburst.md @@ -463,7 +463,9 @@ function(nodeA, nodeB) { 高亮状态配置。 {{ use: partial-focus-blur-scope( - isTree = true + isTree = true, + hasRelative = true, + relativeVersion = '5.5.2' ) }} {{ use: partial-sunburst-state( From e631b2ff7d6e76dafa1c92f8e154acc914be79e2 Mon Sep 17 00:00:00 2001 From: plainheart <yhen@all-my-life.cn> Date: Sat, 21 Dec 2024 15:40:57 +0800 Subject: [PATCH 12/13] add en changelog for v5.6.0 --- en/changelog.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/en/changelog.md b/en/changelog.md index d49abe93..783ec60f 100644 --- a/en/changelog.md +++ b/en/changelog.md @@ -1,3 +1,46 @@ +## v5.6.0 +<div class="time"></div> + ++ [Feature] [geo] [map] Support styling region in original GeoJSON data. [#20564](https://github.com/apache/echarts/issues/20564) ([plainheart](https://github.com/plainheart)) ++ [Feature] [geo] [map] Support `regions[].silent` option. [#20566](https://github.com/apache/echarts/issues/20566) ([Ovilia](https://github.com/Ovilia)) ++ [Feature] [axis] Support tooltip for axis label. [#16315](https://github.com/apache/echarts/issues/16315) ([plainheart](https://github.com/plainheart)) ++ [Feature] [text] Add `isTruncated` state property for `Text` element. [#1101](https://github.com/ecomfe/zrender/pull/1101) ([100pah](https://github.com/100Pah)) ++ [Feature] [sunburst] Add new emphasis focus strategy `'relative'` for highlighting ancestor and descendant nodes. [#20399](https://github.com/apache/echarts/issues/20399) ([sz-p](https://github.com/sz-p)) ++ [Feature] [axis] Add `showMinLine` / `showMaxLine` option for `splitLine`. [#20114](https://github.com/apache/echarts/issues/20114) ([adaelixir](https://github.com/adaelixir)) ++ [Feature] [dataZoom] Add `handleLabel.show` option. [#20082](https://github.com/apache/echarts/issues/20082) ([Ovilia](https://github.com/Ovilia)) ++ [Feature] [calendar] Add `silent` option for `dayLabel`/`monthLabel`/`yearLabel`. [#20492](https://github.com/apache/echarts/issues/20492) ([plainheart](https://github.com/plainheart)) ++ [Feature] [treemap] Add `cursor` option. [#20113](https://github.com/apache/echarts/issues/20113) ([adaelixir](https://github.com/adaelixir)) ++ [Feature] [aria] Add `aria.data.excludeDimensionId` to exclude specific dimensions in aria-label. [#20218](https://github.com/apache/echarts/issues/20218) ([semla](https://github.com/semla)) ++ [Feature] [aria] Add `role="img"` to chart container element. [#20050](https://github.com/apache/echarts/issues/20050) ([ViniciusCestarii](https://github.com/ViniciusCestarii)) ++ [Feature] [i18n] Add Swedish(SV) translation [#20227](https://github.com/apache/echarts/issues/20227) ([NajamShehzad](https://github.com/NajamShehzad)) ++ [Feature] [i18n] Add Persian(FA) translation. [#20312](https://github.com/apache/echarts/issues/20312) ([Ayazadeh](https://github.com/Ayazadeh)) ++ [Feature] [i18n] Improve pt-BR translation. [#20348](https://github.com/apache/echarts/issues/20348) ([ViniciusCestarii](https://github.com/ViniciusCestarii)) ++ [Fix] [line] Reduce runtime memory cost. [#20161](https://github.com/apache/echarts/issues/20161) ([plainheart](https://github.com/plainheart)) ++ [Fix] [line] Fix `areaStyle` skewing in stepped line series and incorrect `connectNull` behavior [#20092](https://github.com/apache/echarts/issues/20092) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [candlestick] Add back missing support for non-normal states since v5.0.0. [#20105](https://github.com/apache/echarts/issues/20105) ([plainheart](https://github.com/plainheart)) ++ [Fix] [legend] Fix legend action is not isolated from other legend components. [#20129](https://github.com/apache/echarts/issues/20129) ([plainheart](https://github.com/plainheart)) ++ [Fix] [bar] Fix borderColor hides bar color with large data. [#20465](https://github.com/apache/echarts/issues/20465) ([DevitX](https://github.com/DevitX)) ++ [Fix] [pictorial] Fix zero value flipping for different axes. [#20557](https://github.com/apache/echarts/issues/20557) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [visualMap] Fix cursor is still pointer when `selectedMode` is disabled. [#20551](https://github.com/apache/echarts/issues/20551) ([sz-p](https://github.com/sz-p)) ++ [Fix] [visualMap] Fix label collides with horizontal visualMap. [#20249](https://github.com/apache/echarts/issues/20249) ([WojciechKrakowiak](https://github.com/WojciechKrakowiak)) ++ [Fix] [tooltip] Fix potential NPE when setting option with `notMerge` strategy. [#20435](https://github.com/apache/echarts/issues/20435) ([ktx-abhay](https://github.com/ktx-abhay)) ++ [Fix] [tooltip] Fix tooltip `textStyle.lineHeight` does not work. [#20398](https://github.com/apache/echarts/issues/20398) ([sz-p](https://github.com/sz-p)) ++ [Fix] [sankey] Avoid throwing errors when the `links` / `nodes` / `levels` option is undefined. [#20380](https://github.com/apache/echarts/issues/20380) ([sz-p](https://github.com/sz-p)) ++ [Fix] [polar] Fix unexpected clipping in polar coordinate. [#20370](https://github.com/apache/echarts/issues/20370) ([sz-p](https://github.com/sz-p)) ++ [Fix] [boxplot] Correctly handle `series.encode` with category axis. [#20324](https://github.com/apache/echarts/issues/20324) ([jonoshearman](https://github.com/jonoshearman)) ++ [Fix] [sampling] Fix `minmax` sampling behavior. [#20315](https://github.com/apache/echarts/issues/20315) ([ribeirompl](https://github.com/ribeirompl)) ++ [Fix] [gauge] Fix progress bar may be beneath the axis line. [#20276](https://github.com/apache/echarts/issues/20276) ([kingyue737](https://github.com/kingyue737)) ++ [Fix] [axis] Fix axis ticks overflowing grid area with dataZoom. [#20194](https://github.com/apache/echarts/issues/20194) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [axis] [time] Fix bar bandWidth with inversed time axis. [#20246](https://github.com/apache/echarts/issues/20246) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [theme] Fix legend page text color in dark mode. [#20396](https://github.com/apache/echarts/issues/20396) ([plainheart](https://github.com/plainheart)) ++ [Fix] [pie] Fix some labels may not show. [#20074](https://github.com/apache/echarts/issues/20074) ([liuyunzidian](https://github.com/liuyunzidian)) ++ [Fix] [grid] Fix clipping in custom series off by pixel. [#20043](https://github.com/apache/echarts/issues/20043) ([fandi-1205](https://github.com/fandi-1205)) ++ [Fix] [svg] Fix SVG element may be not interactable in SSR mode and fix invalid `transparent` color issue. [#1076](https://github.com/ecomfe/zrender/issues/1076) ([plainheart](https://github.com/plainheart)) ++ [Fix] [data] Fix potential NPE in the `SeriesData#rawIndexOf` function. [#20534](https://github.com/apache/echarts/issues/20534) ([plainheart](https://github.com/plainheart)) ++ [Fix] [text] Fix text bounding rectangle is incorrect when `overflow` is `'truncate'`. [#1091](https://github.com/ecomfe/zrender/pull/1091) ([linghaoSu](https://github.com/linghaoSu)) [#1100](https://github.com/ecomfe/zrender/pull/1100) ([100Pah](https://github.com/100Pah)) ++ [Fix] [env] Fix detection for node environment. [#1037](https://github.com/ecomfe/zrender/pull/1037) ([Uzlopak](https://github.com/Uzlopak)) [#1071](https://github.com/ecomfe/zrender/pull/1071) ([xg-qd](https://github.com/xg-qd)) [#1086](https://github.com/ecomfe/zrender/pull/1086) ([plainheart](https://github.com/plainheart)) ++ [Fix] [type] MarkLine `symbolOffset` can be a 2d array for both symbols. [#20491](https://github.com/apache/echarts/issues/20491) ([plainheart](https://github.com/plainheart)) + ## v5.5.1 <div class="time">2024-06-27</div> From 1d08a199f794359a6ebd2691ebb99cc826180990 Mon Sep 17 00:00:00 2001 From: plainheart <yhen@all-my-life.cn> Date: Sat, 21 Dec 2024 16:33:48 +0800 Subject: [PATCH 13/13] add zh changelog for v5.6.0 --- zh/changelog.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/zh/changelog.md b/zh/changelog.md index e3a629cd..ab1b19dc 100644 --- a/zh/changelog.md +++ b/zh/changelog.md @@ -1,3 +1,46 @@ +## v5.6.0 +<div class="time"></div> + ++ [Feature] [geo] [map] 支持在原始 GeoJSON 数据中定义区域样式。[#20564](https://github.com/apache/echarts/issues/20564) ([plainheart](https://github.com/plainheart)) ++ [Feature] [geo] [map] 新增 `regions[].silent` 选项以支持禁用部分区域的交互。[#20566](https://github.com/apache/echarts/issues/20566) ([Ovilia](https://github.com/Ovilia)) ++ [Feature] [axis] 为轴标签 `axisLabel` 添加 `tooltip` 支持。[#16315](https://github.com/apache/echarts/issues/16315) ([plainheart](https://github.com/plainheart)) ++ [Feature] [text] `Text` 元素新增 `isTruncated` 属性用以判断当前文本是否溢出隐藏。[#1101](https://github.com/ecomfe/zrender/pull/1101) ([100pah](https://github.com/100Pah)) ++ [Feature] [sunburst] 新增 `'relative'` 高亮聚焦策略用以聚焦所有子孙和祖先节点。[#20399](https://github.com/apache/echarts/issues/20399) ([sz-p](https://github.com/sz-p)) ++ [Feature] [axis] 坐标轴分隔线 `splitLine` 新增 `showMinLine` / `showMaxLine` 选项。[#20114](https://github.com/apache/echarts/issues/20114) ([adaelixir](https://github.com/adaelixir)) ++ [Feature] [dataZoom] 新增 `handleLabel.show` 选项以控制 `dataZoom` 滑块标签是否显示。[#20082](https://github.com/apache/echarts/issues/20082) ([Ovilia](https://github.com/Ovilia)) ++ [Feature] [calendar] 日历坐标系年月日标签新增 `silent` 选项以禁用交互。[#20492](https://github.com/apache/echarts/issues/20492) ([plainheart](https://github.com/plainheart)) ++ [Feature] [treemap] 矩形树图新增 `cursor` 选项以设置鼠标样式。[#20113](https://github.com/apache/echarts/issues/20113) ([adaelixir](https://github.com/adaelixir)) ++ [Feature] [aria] 新增 `aria.data.excludeDimensionId` 选项以支持从 `aria-label` 中排除指定数据维度。[#20218](https://github.com/apache/echarts/issues/20218) ([semla](https://github.com/semla)) ++ [Feature] [aria] 为图表容器元素添加 `role="img"` 属性。[#20050](https://github.com/apache/echarts/issues/20050) ([ViniciusCestarii](https://github.com/ViniciusCestarii)) ++ [Feature] [i18n] 新增瑞典语翻译。[#20227](https://github.com/apache/echarts/issues/20227) ([NajamShehzad](https://github.com/NajamShehzad)) ++ [Feature] [i18n] 新增波斯语翻译。[#20312](https://github.com/apache/echarts/issues/20312) ([Ayazadeh](https://github.com/Ayazadeh)) ++ [Feature] [i18n] 改进波兰语翻译。[#20348](https://github.com/apache/echarts/issues/20348) ([ViniciusCestarii](https://github.com/ViniciusCestarii)) ++ [Fix] [line] 减少运行时内存消耗。[#20161](https://github.com/apache/echarts/issues/20161) ([plainheart](https://github.com/plainheart)) ++ [Fix] [line] 修复阶梯线图中区域样式 `areaStyle` 倾斜问题及错误的 `connectNull` 行为。[#20092](https://github.com/apache/echarts/issues/20092) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [candlestick] 修复自 v5.0.0 起 K 线图高亮、选中、失焦等状态配置不起作用的问题。[#20105](https://github.com/apache/echarts/issues/20105) ([plainheart](https://github.com/plainheart)) ++ [Fix] [legend] 修复当存在多个图例组件时,`action` 行为没有彼此隔离的问题。[#20129](https://github.com/apache/echarts/issues/20129) ([plainheart](https://github.com/plainheart)) ++ [Fix] [bar] 修复柱状图在大数据量时边框颜色遮挡柱条颜色的问题。[#20465](https://github.com/apache/echarts/issues/20465) ([DevitX](https://github.com/DevitX)) ++ [Fix] [pictorial] 修复象形柱图图形元素可能意外反转的问题。[#20557](https://github.com/apache/echarts/issues/20557) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [visualMap] 修复当 `selectedMode` 禁用时光标仍然显示为 `cursor` 的问题。[#20551](https://github.com/apache/echarts/issues/20551) ([sz-p](https://github.com/sz-p)) ++ [Fix] [visualMap] 修复水平布局下标签可能重叠的问题。[#20249](https://github.com/apache/echarts/issues/20249) ([WojciechKrakowiak](https://github.com/WojciechKrakowiak)) ++ [Fix] [tooltip] 修复 tooltip 在 `notMerge` 选项合并策略下可能报错的问题。[#20435](https://github.com/apache/echarts/issues/20435) ([ktx-abhay](https://github.com/ktx-abhay)) ++ [Fix] [tooltip] 修复 tooltip `textStyle.lineHeight` 行高样式不生效的问题。[#20398](https://github.com/apache/echarts/issues/20398) ([sz-p](https://github.com/sz-p)) ++ [Fix] [sankey] 修复桑基图在没有定义 `links` / `nodes` / `levels` 选项时报错的问题。[#20380](https://github.com/apache/echarts/issues/20380) ([sz-p](https://github.com/sz-p)) ++ [Fix] [polar] 修复极坐标系下的裁剪问题。[#20370](https://github.com/apache/echarts/issues/20370) ([sz-p](https://github.com/sz-p)) ++ [Fix] [boxplot] 修复箱形图在类目轴下的 `encode` 编码映射问题。[#20324](https://github.com/apache/echarts/issues/20324) ([jonoshearman](https://github.com/jonoshearman)) ++ [Fix] [sampling] 修正 `minmax` 采样算法。[#20315](https://github.com/apache/echarts/issues/20315) ([ribeirompl](https://github.com/ribeirompl)) ++ [Fix] [gauge] 修复进度条可能显示在仪表盘轴线下方的问题。[#20276](https://github.com/apache/echarts/issues/20276) ([kingyue737](https://github.com/kingyue737)) ++ [Fix] [axis] 修复在启用 `dataZoom` 组件时,自定义轴刻度及标签溢出图表的问题。[#20194](https://github.com/apache/echarts/issues/20194) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [axis] [time] 修复柱状图在反向时间轴下柱条宽度可能溢出的问题。[#20246](https://github.com/apache/echarts/issues/20246) ([Ovilia](https://github.com/Ovilia)) ++ [Fix] [theme] 修复深色模式下图例分页标签的文本颜色。[#20396](https://github.com/apache/echarts/issues/20396) ([plainheart](https://github.com/plainheart)) ++ [Fix] [pie] 修复饼图部分标签可能不显示的问题。[#20074](https://github.com/apache/echarts/issues/20074) ([liuyunzidian](https://github.com/liuyunzidian)) ++ [Fix] [grid] 修复自定义系列的边界裁切问题。[#20043](https://github.com/apache/echarts/issues/20043) ([fandi-1205](https://github.com/fandi-1205)) ++ [Fix] [svg] 修复 SSR 模式下 SVG 元素可能无法交互的问题及透明颜色的平台兼容性问题。[#1076](https://github.com/ecomfe/zrender/issues/1076) ([plainheart](https://github.com/plainheart)) ++ [Fix] [data] 修复 `SeriesData#rawIndexOf` 潜在的报错问题。[#20534](https://github.com/apache/echarts/issues/20534) ([plainheart](https://github.com/plainheart)) ++ [Fix] [text] 修复当标签溢出并被截断时,其包围盒计算错误导致无法交互的问题。[#1091](https://github.com/ecomfe/zrender/pull/1091) ([linghaoSu](https://github.com/linghaoSu)) [#1100](https://github.com/ecomfe/zrender/pull/1100) ([100Pah](https://github.com/100Pah)) ++ [Fix] [env] 修复对 node 环境的侦测逻辑。[#1037](https://github.com/ecomfe/zrender/pull/1037) ([Uzlopak](https://github.com/Uzlopak)) [#1071](https://github.com/ecomfe/zrender/pull/1071) ([xg-qd](https://github.com/xg-qd)) [#1086](https://github.com/ecomfe/zrender/pull/1086) ([plainheart](https://github.com/plainheart)) ++ [Fix] [type] 修复标线 `markLine` 的 `symbolOffset` 的类型声明,其可以是一个二维数组用以分别设置两端标记的偏移量。[#20491](https://github.com/apache/echarts/issues/20491) ([plainheart](https://github.com/plainheart)) + ## v5.5.1 <div class="time">2024-06-27</div>