Skip to content

Commit 3d71262

Browse files
committed
doc(custom): support compoundPath in custom series renderItem
apache/echarts#20402
1 parent d1c2beb commit 3d71262

2 files changed

Lines changed: 132 additions & 0 deletions

File tree

en/option/partial/zr-graphic.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1083,6 +1083,71 @@ Value range: [0, 1].
10831083
) }}
10841084

10851085

1086+
#${prefix} ${hostName}${symbolDeclare}compoundPath(Object)
1087+
1088+
The union of multiple elements.
1089+
1090+
{{ use: partial-graphic-cpt-common-props(
1091+
type = 'compoundPath',
1092+
prefix = ${prefix},
1093+
optionPath = ${optionPath},
1094+
usageType = ${usageType},
1095+
hostName = ${hostName},
1096+
enableMorph = true,
1097+
symbolVisit = ${symbolVisit},
1098+
symbolDeclare = ${symbolDeclare}
1099+
) }}
1100+
1101+
##${prefix} shape(Object)
1102+
1103+
###${prefix} paths(Array)
1104+
1105+
Array of elements, each of which can be a path/rect/circle/...
1106+
1107+
{{ use: partial-graphic-cpt-sub-prop-transition(
1108+
prefix = ${prefix},
1109+
hostProp = 'shape',
1110+
optionPath = ${optionPath},
1111+
usageType = ${usageType},
1112+
hostName = ${hostName},
1113+
symbolVisit = ${symbolVisit},
1114+
symbolDeclare = ${symbolDeclare}
1115+
) }}
1116+
1117+
##${prefix} style(Object)
1118+
1119+
{{ use: partial-graphic-cpt-style-prop-common(
1120+
prefix = ${prefix},
1121+
optionPath = ${optionPath},
1122+
usageType = ${usageType},
1123+
hostName = ${hostName},
1124+
symbolVisit = ${symbolVisit},
1125+
symbolDeclare = ${symbolDeclare}
1126+
) }}
1127+
1128+
{{ use: partial-graphic-cpt-focus-blur(
1129+
prefix = ${prefix}
1130+
) }}
1131+
1132+
{{ use: partial-graphic-cpt-style-emphasis(
1133+
prefix = ${prefix},
1134+
optionPath = ${optionPath},
1135+
usageType = ${usageType},
1136+
hostName = ${hostName},
1137+
symbolVisit = ${symbolVisit},
1138+
symbolDeclare = ${symbolDeclare}
1139+
) }}
1140+
1141+
{{ use: partial-graphic-cpt-event-handlers(
1142+
prefix = ${prefix},
1143+
optionPath = ${optionPath},
1144+
usageType = ${usageType},
1145+
hostName = ${hostName},
1146+
symbolVisit = ${symbolVisit},
1147+
symbolDeclare = ${symbolDeclare}
1148+
) }}
1149+
1150+
10861151

10871152
{{ target: partial-graphic-cpt-common-props }}
10881153

@@ -1999,6 +2064,7 @@ Same to [style](~${optionPath}.${hostName}${symbolVisit}polygon.style).
19992064
[line](~${optionPath}.${hostName}${symbolVisit}line),
20002065
[bezierCurve](~${optionPath}.${hostName}${symbolVisit}bezierCurve),
20012066
[arc](~${optionPath}.${hostName}${symbolVisit}arc),
2067+
[compoundPath](~${optionPath}.${hostName}${symbolVisit}compoundPath),
20022068
[group](~${optionPath}.${hostName}${symbolVisit}group),
20032069
20042070

zh/option/partial/zr-graphic.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -940,6 +940,72 @@ font: 'bolder 2em "Microsoft YaHei", sans-serif'
940940

941941
线画到百分之多少就不画了。值的范围:[0, 1]
942942

943+
944+
{{ use: partial-graphic-cpt-sub-prop-transition(
945+
prefix = ${prefix},
946+
hostProp = 'shape',
947+
optionPath = ${optionPath},
948+
usageType = ${usageType},
949+
hostName = ${hostName},
950+
symbolVisit = ${symbolVisit},
951+
symbolDeclare = ${symbolDeclare}
952+
) }}
953+
954+
##${prefix} style(Object)
955+
956+
{{ use: partial-graphic-cpt-style-prop-common(
957+
prefix = ${prefix},
958+
optionPath = ${optionPath},
959+
usageType = ${usageType},
960+
hostName = ${hostName},
961+
symbolVisit = ${symbolVisit},
962+
symbolDeclare = ${symbolDeclare}
963+
) }}
964+
965+
{{ use: partial-graphic-cpt-focus-blur(
966+
prefix = ${prefix}
967+
) }}
968+
969+
{{ use: partial-graphic-cpt-style-emphasis(
970+
prefix = ${prefix},
971+
optionPath = ${optionPath},
972+
usageType = ${usageType},
973+
hostName = ${hostName},
974+
symbolVisit = ${symbolVisit},
975+
symbolDeclare = ${symbolDeclare}
976+
) }}
977+
978+
{{ use: partial-graphic-cpt-event-handlers(
979+
prefix = ${prefix},
980+
optionPath = ${optionPath},
981+
usageType = ${usageType},
982+
hostName = ${hostName},
983+
symbolVisit = ${symbolVisit},
984+
symbolDeclare = ${symbolDeclare}
985+
) }}
986+
987+
988+
#${prefix} ${hostName}${symbolDeclare}compoundPath(Object)
989+
990+
The union of multiple elements.
991+
992+
{{ use: partial-graphic-cpt-common-props(
993+
type = 'compoundPath',
994+
prefix = ${prefix},
995+
optionPath = ${optionPath},
996+
usageType = ${usageType},
997+
hostName = ${hostName},
998+
enableMorph = true,
999+
symbolVisit = ${symbolVisit},
1000+
symbolDeclare = ${symbolDeclare}
1001+
) }}
1002+
1003+
##${prefix} shape(Object)
1004+
1005+
###${prefix} paths(Array)
1006+
1007+
图形元素的数组,元素可以是 path/rect/circle/……
1008+
9431009
{{ use: partial-graphic-cpt-sub-prop-transition(
9441010
prefix = ${prefix},
9451011
hostProp = 'shape',

0 commit comments

Comments
 (0)