From acb10e33e96eb42a9af44a8de6a38c24235e1309 Mon Sep 17 00:00:00 2001 From: susiwen8 Date: Sun, 16 Oct 2022 21:40:00 +0800 Subject: [PATCH 1/2] feat(sankey): add doc for sankey `edgeLabel` --- en/option/series/sankey.md | 14 ++++++++++++++ zh/option/series/sankey.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/en/option/series/sankey.md b/en/option/series/sankey.md index 2324c00ef..ef52d1dc0 100644 --- a/en/option/series/sankey.md +++ b/en/option/series/sankey.md @@ -82,6 +82,20 @@ The layout direction of the nodes in the Sankey diagram, which can be horizontal The drag-and-drop interaction of the node, which is enabled by default. After opening, the user can drag any node in the Sankey diagram to any position. To turn this interaction off, simply set the value to `false`. +## edgeLabel(Object) + +{{ use: partial-version( + version = "5.4.1" +) }} + +`edgeLabel` describes the text label style in each link. + +{{ use: partial-label( + prefix = "##", + noPosition = true, + formatter1d = true +) }} + ## levels(Array) The setting of each layer of Sankey diagram. Can be set layer by layer, as follows: diff --git a/zh/option/series/sankey.md b/zh/option/series/sankey.md index 3eb4b9001..4d828e880 100644 --- a/zh/option/series/sankey.md +++ b/zh/option/series/sankey.md @@ -85,6 +85,20 @@ const option = {"tooltip":{"trigger":"item","triggerOn":"mousemove"},"series":[{ 控制节点拖拽的交互，默认开启。开启后，用户可以将图中任意节点拖拽到任意位置。若想关闭此交互，只需将值设为 `false` 就行了。 +## edgeLabel(Object) + +{{ use: partial-version( + version = "5.4.1" +) }} + +`edgeLabel` 描述了每个边中文本标签的样式。 + +{{ use: partial-label( + prefix = "##", + noPosition = true, + formatter1d = true +) }} + ## levels(Array) 桑基图每一层的设置。可以逐层设置，如下： From 6a156169ee4d0fd883a0c6d2f3e4dc34676372a3 Mon Sep 17 00:00:00 2001 From: plainheart Date: Wed, 26 Oct 2022 18:26:33 +0800 Subject: [PATCH 2/2] fix(sankey): improve doc for sankey `edgeLabel` --- en/option/series/sankey.md | 82 ++++++++++++++++++++++++-------------- zh/option/series/sankey.md | 82 ++++++++++++++++++++++++-------------- 2 files changed, 106 insertions(+), 58 deletions(-) diff --git a/en/option/series/sankey.md b/en/option/series/sankey.md index ef52d1dc0..b354e6464 100644 --- a/en/option/series/sankey.md +++ b/en/option/series/sankey.md @@ -84,16 +84,8 @@ The drag-and-drop interaction of the node, which is enabled by default. After op ## edgeLabel(Object) -{{ use: partial-version( - version = "5.4.1" -) }} - -`edgeLabel` describes the text label style in each link. - -{{ use: partial-label( - prefix = "##", - noPosition = true, - formatter1d = true +{{ use: sankey-edge-label( + prefix = "##" ) }} ## levels(Array) @@ -388,12 +380,8 @@ The [name of target node](~series-sankey.data.name) of edge The value of edge, which decides the width of edge. -### lineStyle(Object) - -The line stlye of edge. - -{{ use: partial-sankey-line-style( - prefix = "###" +{{ use: sankey-edge-state( + prefix = "##" ) }} ### emphasis(Object) @@ -402,11 +390,9 @@ The line stlye of edge. prefix = "###" ) }} -#### lineStyle(Object) - -{{ use: partial-sankey-line-style( - prefix = "####", - hasInherit = true +{{ use: sankey-edge-state( + prefix = "###", + state = "emphasis" ) }} ### blur(Object) @@ -415,10 +401,9 @@ The line stlye of edge. version = "5.0.0" ) }} -#### lineStyle(Object) - -{{ use: partial-sankey-line-style( - prefix = "####" +{{ use: sankey-edge-state( + prefix = "###", + state = "blur" ) }} ### select(Object) @@ -431,10 +416,9 @@ The line stlye of edge. prefix = "###" ) }} -#### lineStyle(Object) - -{{ use: partial-sankey-line-style( - prefix = "####" +{{ use: sankey-edge-state( + prefix = "###", + state = "select" ) }} ## edges(Array) @@ -508,6 +492,12 @@ The curveness of the edge in Sankey diagram. formatter1d = ${prefix} === '##' ) }} +#${prefix} edgeLabel(Object) + +{{ use: sankey-edge-label( + prefix = "#" + ${prefix} +) }} + #${prefix} itemStyle(Object) {{ use: partial-item-style( @@ -522,3 +512,37 @@ The curveness of the edge in Sankey diagram. hasInherit = ${state} === 'emphasis' ) }} + + +{{ target: sankey-edge-state }} + +#${prefix} edgeLabel(Object) + +{{ use: sankey-edge-label( + prefix = "#" + ${prefix} +) }} + +#${prefix} lineStyle(Object) + +The line style of edge. + +{{ use: partial-sankey-line-style( + prefix = "#" + ${prefix}, + hasInherit = ${state} === 'emphasis' +) }} + + + +{{ target: sankey-edge-label }} + +{{ use: partial-version( + version = "5.4.1" +) }} + +The label style of each edge/link. + +{{ use: partial-label( + prefix = ${prefix}, + noPosition = true, + formatter1d = true +) }} diff --git a/zh/option/series/sankey.md b/zh/option/series/sankey.md index 4d828e880..971d0f7bb 100644 --- a/zh/option/series/sankey.md +++ b/zh/option/series/sankey.md @@ -87,16 +87,8 @@ const option = {"tooltip":{"trigger":"item","triggerOn":"mousemove"},"series":[{ ## edgeLabel(Object) -{{ use: partial-version( - version = "5.4.1" -) }} - -`edgeLabel` 描述了每个边中文本标签的样式。 - -{{ use: partial-label( - prefix = "##", - noPosition = true, - formatter1d = true +{{ use: sankey-edge-label( + prefix = "##" ) }} ## levels(Array) @@ -391,12 +383,8 @@ links: [{ 边的数值，决定边的宽度。 -### lineStyle(Object) - -关系边的线条样式。 - -{{ use: partial-sankey-line-style( - prefix = "###" +{{ use: sankey-edge-state( + prefix = "##" ) }} ### emphasis(Object) @@ -405,11 +393,9 @@ links: [{ prefix = "###" ) }} -#### lineStyle(Object) - -{{ use: partial-sankey-line-style( - prefix = "####", - hasInherit = true +{{ use: sankey-edge-state( + prefix = "###", + state = "emphasis" ) }} ### blur(Object) @@ -418,10 +404,9 @@ links: [{ version = "5.0.0" ) }} -#### lineStyle(Object) - -{{ use: partial-sankey-line-style( - prefix = "####" +{{ use: sankey-edge-state( + prefix = "###", + state = "blur" ) }} ### select(Object) @@ -434,10 +419,9 @@ links: [{ prefix = "###" ) }} -#### lineStyle(Object) - -{{ use: partial-sankey-line-style( - prefix = "####" +{{ use: sankey-edge-state( + prefix = "###", + state = "select" ) }} ## edges(Array) @@ -511,6 +495,12 @@ links: [{ formatter1d = ${prefix} === '##' ) }} +#${prefix} edgeLabel(Object) + +{{ use: sankey-edge-label( + prefix = "#" + ${prefix} +) }} + #${prefix} itemStyle(Object) {{ use: partial-item-style( @@ -525,3 +515,37 @@ links: [{ hasInherit = ${state} === 'emphasis' ) }} + + +{{ target: sankey-edge-state }} + +#${prefix} edgeLabel(Object) + +{{ use: sankey-edge-label( + prefix = "#" + ${prefix} +) }} + +#${prefix} lineStyle(Object) + +关系边的线条样式。 + +{{ use: partial-sankey-line-style( + prefix = "#" + ${prefix}, + hasInherit = ${state} === 'emphasis' +) }} + + + +{{ target: sankey-edge-label }} + +{{ use: partial-version( + version = "5.4.1" +) }} + +关系边文本标签的样式。 + +{{ use: partial-label( + prefix = ${prefix}, + noPosition = true, + formatter1d = true +) }}