Skip to content

Commit 1d83674

Browse files
plainheartplainheart
committed
fix candlestick doc for apache/echarts#20105 
1 parent 001c2bd commit 1d83674

6 files changed

Lines changed: 75 additions & 21 deletions

File tree

‎en/option/partial/emphasis-common.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11

22
{{ target: partial-emphasis-disabled }}
33

4-
#${prefix} disabled(boolean)
4+
#${prefix} disabled(boolean) = ${defaultValue|default(false)}
55

6-
<ExampleUIControlBoolean default="false" />
6+
<ExampleUIControlBoolean default="${defaultValue|default(false)}" />
77

88
{{ use: partial-version(
9-
version = "5.3.0"
9+
version = ${version|default('5.3.0')}
1010
) }}
1111

1212
Whether to disable the emphasis state.

‎en/option/partial/select-common.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11

22
{{ target: partial-select-disabled }}
33

4-
#${prefix} disabled(boolean)
4+
#${prefix} disabled(boolean) = ${defaultValue|default(false)}
55

6-
<ExampleUIControlBoolean default="false" />
6+
<ExampleUIControlBoolean default="${defaultValue|default(false)}" />
77

88
{{ use: partial-version(
9-
version = "5.3.0"
9+
version = ${version|default('5.3.0')}
1010
) }}
1111

1212
If data can be selected. Available when `selectedMode` is used. Can be used to disable selection for part of the data.

‎en/option/series/candlestick.md‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,26 @@ Item style of candlestick.
9191

9292
## emphasis(Object)
9393

94+
{{ use: partial-version(
95+
version = "5.5.2"
96+
) }}
97+
9498
Emphasis style of candlestick.
9599

96100
{{ use: partial-emphasis-disabled(
97-
prefix = "##"
101+
prefix = "##",
102+
defaultValue = true
98103
) }}
99104

105+
**Note:** The emphasis state is disabled in the candlestick series by default for historical reasons and needs to be explicitly enabled as follows.
106+
107+
```js
108+
emphasis: {
109+
// enable the emphasis state
110+
disabled: false
111+
}
112+
```
113+
100114
{{ use: partial-focus-blur-scope() }}
101115

102116
### itemStyle(Object)
@@ -109,7 +123,7 @@ Emphasis style of candlestick.
109123
## blur(Object)
110124

111125
{{ use: partial-version(
112-
version = "5.0.0"
126+
version = "5.5.2"
113127
) }}
114128

115129
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
137151

138152
{{ use: partial-candlestick-item-style-detail(
139153
prefix = "###",
140-
defaultBorderWidth = 2
154+
defaultBorderWidth = 2,
155+
option0Version = "5.5.2"
141156
) }}
142157

143158
{{ use: partial-selected-mode(
@@ -315,6 +330,12 @@ Fill color of bullish candle stick.
315330

316331
<ExampleUIControlColor />
317332

333+
{{ if: ${option0Version} }}
334+
{{ use: partial-version(
335+
version = ${option0Version}
336+
) }}
337+
{{ /if }}
338+
318339
Fill color of bearish candle stick.
319340

320341
{{ use: partial-color-desc() }}
@@ -331,6 +352,12 @@ Border color of bullish candle stick.
331352

332353
<ExampleUIControlColor />
333354

355+
{{ if: ${option0Version} }}
356+
{{ use: partial-version(
357+
version = ${option0Version}
358+
) }}
359+
{{ /if }}
360+
334361
Border color of bearish candle stick.
335362

336363
{{ use: partial-color-desc() }}
@@ -340,7 +367,7 @@ Border color of bearish candle stick.
340367
<ExampleUIControlColor />
341368

342369
{{ use: partial-version(
343-
version = "5.4.1"
370+
version = ${option0Version|default("5.4.1")}
344371
) }}
345372

346373
Border color of doji (when the open price is the same as the close price).

‎zh/option/partial/emphasis-common.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11

22
{{ target: partial-emphasis-disabled }}
33

4-
#${prefix} disabled(boolean)
4+
#${prefix} disabled(boolean) = ${defaultValue|default(false)}
55

6-
<ExampleUIControlBoolean default="false" />
6+
<ExampleUIControlBoolean default="${defaultValue|default(false)}" />
77

88
{{ use: partial-version(
9-
version = "5.3.0"
9+
version = ${version|default('5.3.0')}
1010
) }}
1111

1212
是否关闭高亮状态。

‎zh/option/partial/select-common.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

22
{{ target: partial-select-disabled }}
33

4-
#${prefix} disabled(boolean)
4+
#${prefix} disabled(boolean) = ${defaultValue|default(false)}
55

6-
<ExampleUIControlBoolean default="false" />
6+
<ExampleUIControlBoolean default="${defaultValue|default(false)}" />
77

88
{{ use: partial-version(
9-
version = "5.3.0"
9+
version = ${version|default('5.3.0')}
1010
) }}
1111

12-
是否可以被选中。在开启`selectedMode`的时候有效，可以用于关闭部分数据。
12+
是否可以被选中。在开启 `selectedMode` 的时候有效，可以用于关闭部分数据。
1313

‎zh/option/series/candlestick.md‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -277,12 +277,26 @@ K 线图的图形样式。
277277

278278
## emphasis(Object)
279279

280+
{{ use: partial-version(
281+
version = "5.5.2"
282+
) }}
283+
280284
K 线图的高亮状态。
281285

282286
{{ use: partial-emphasis-disabled(
283-
prefix = "##"
287+
prefix = "##",
288+
defaultValue = true
284289
) }}
285290

291+
**注意：** K 线图由于历史遗留原因，默认关闭，需要如下显式启用。
292+
293+
```js
294+
emphasis: {
295+
// 启用高亮状态
296+
disabled: false
297+
}
298+
```
299+
286300
{{ use: partial-focus-blur-scope() }}
287301

288302
### itemStyle(Object)
@@ -295,7 +309,7 @@ K 线图的高亮状态。
295309
## blur(Object)
296310

297311
{{ use: partial-version(
298-
version = "5.0.0"
312+
version = "5.5.2"
299313
) }}
300314

301315
K 线图的淡出状态。开启 [emphasis.focus](~series-candlestick.emphasis.focus) 后有效
@@ -323,7 +337,8 @@ K 线图的选中状态。开启 [selectedMode](~series-candlestick.selectedMode
323337

324338
{{ use: partial-candlestick-item-style-detail(
325339
prefix = "###",
326-
defaultBorderWidth = 2
340+
defaultBorderWidth = 2,
341+
option0Version = "5.5.2"
327342
) }}
328343

329344
{{ use: partial-selected-mode(
@@ -502,6 +517,12 @@ K 线图的选中状态。开启 [selectedMode](~series-candlestick.selectedMode
502517

503518
<ExampleUIControlColor />
504519

520+
{{ if: ${option0Version} }}
521+
{{ use: partial-version(
522+
version = ${option0Version}
523+
) }}
524+
{{ /if }}
525+
505526
`阴线` 图形的颜色。
506527

507528
{{ use: partial-color-desc() }}
@@ -520,14 +541,20 @@ K 线图的选中状态。开启 [selectedMode](~series-candlestick.selectedMode
520541

521542
`阴线` 图形的描边颜色。
522543

544+
{{ if: ${option0Version} }}
545+
{{ use: partial-version(
546+
version = ${option0Version}
547+
) }}
548+
{{ /if }}
549+
523550
{{ use: partial-color-desc() }}
524551

525552
#${prefix} borderColorDoji(Color) = null
526553

527554
<ExampleUIControlColor />
528555

529556
{{ use: partial-version(
530-
version = "5.4.1"
557+
version = ${option0Version|default("5.4.1")}
531558
) }}
532559

533560
十字星（开盘价等于收盘价）的描边颜色。

0 commit comments

Comments
 (0)