Skip to content

Commit fa0989b

Browse files
committed
Add thumbnail component doc.
1 parent 4c36a0b commit fa0989b

8 files changed

Lines changed: 163 additions & 0 deletions

File tree

en/api/echarts-instance.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,9 @@ The format of the input `coord` and return type are defined by each coordinate s
676676

677677

678678
## convertToLayout(Function)
679+
680+
{{ use: partial-version(version = "6.0.0") }}
681+
679682
```ts
680683
(
681684
// `finder` is used to indicate in which coordinate system

en/option/component/thumbnail.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
{{ target: component-thumbnail }}
2+
3+
# thumbnail(Object)
4+
5+
{{ use: partial-version(version = "6.0.0") }}
6+
7+
Thumbnail component.
8+
9+
Currently it only supports [series.graph](~series-graph).
10+
11+
Examples: [graph NPM](${galleryEditorPath}graph-npm&edit=1&reset=1), [graph Webkit dep](${galleryEditorPath}graph-webkit-dep&edit=1&reset=1).
12+
13+
14+
{{ use: partial-component-id(
15+
prefix = "#"
16+
) }}
17+
18+
## show(boolean) = true
19+
20+
Whether to display the thumbnail component.
21+
22+
{{ use: partial-rect-layout-width-height(
23+
componentName = "thumbnail",
24+
defaultLeft = "25%",
25+
defaultTop = "25%"
26+
) }}
27+
28+
{{ use: partial-coord-sys(
29+
version = '6.0.0',
30+
nonSeriesComponentMainType = "thumbnail",
31+
coordSysDefault = "'none'",
32+
matrix = true,
33+
calendar = true,
34+
none = true
35+
) }}
36+
37+
## itemStyle(Object)
38+
39+
{{ use: partial-version(version = "6.0.0") }}
40+
41+
The style of the box and background of the thumbnail.
42+
43+
{{ use: partial-item-style(
44+
prefix = '##',
45+
defaultBorderColor = "'#b7b9be'",
46+
defaultBorderWidth = 2
47+
) }}
48+
49+
## windowStyle(Object)
50+
51+
{{ use: partial-version(version = "6.0.0") }}
52+
53+
The style of the window of the thumbnail.
54+
55+
{{ use: partial-item-style(
56+
prefix = '##',
57+
defaultColor = "'#9ea0a5'",
58+
defaultBorderColor = "'#b7b9be'",
59+
defaultBorderWidth = 1,
60+
defaultOpacity = 0.3
61+
) }}
62+
63+
## seriesIndex(number)
64+
65+
{{ use: partial-version(version = "6.0.0") }}
66+
67+
Specify which series this thumbnail is for. Use the first [series.graph](~series-graph) by default.
68+
69+
## seriesId(string|number)
70+
71+
{{ use: partial-version(version = "6.0.0") }}
72+
73+
Specify which series this thumbnail is for. Use the first [series.graph](~series-graph) by default.
74+
75+
76+
{{ /target }}

en/option/option.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
{{import: component-graphic}}
2424
{{import: component-calendar}}
2525
{{import: component-matrix}}
26+
{{import: component-thumbnail}}
2627
{{import: component-dataset}}
2728
{{import: component-aria}}
2829

en/option/series/custom.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,8 @@ The behavior, parameters and returns are the same as [chart.convertToPixel](api.
218218

219219
##### layout(Function)
220220

221+
{{ use: partial-version(version = "6.0.0") }}
222+
221223
Convert data to the corresponding layout info based on the current coordinate system.
222224

223225
The behavior, parameters and returns are the same as [chart.convertToLayout](api.html#echartsInstance.convertToLayout) (only exclude its first parameter `finder`).

zh/api/echarts-instance.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -679,6 +679,9 @@ ECharts 中的事件有两种,一种是鼠标事件,在鼠标点击某个图
679679

680680

681681
## convertToLayout(Function)
682+
683+
{{ use: partial-version(version = "6.0.0") }}
684+
682685
```ts
683686
(
684687
// `finder` 用于指示『使用哪个坐标系或数轴或系列进行转换』。

zh/option/component/thumbnail.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{{ target: component-thumbnail }}
2+
3+
# thumbnail(Object)
4+
5+
{{ use: partial-version(version = "6.0.0") }}
6+
7+
缩略图组件。
8+
9+
现在仅支持用在 [关系图系列(series.graph)](~series-graph) 上。
10+
11+
示例:[graph NPM](${galleryEditorPath}graph-npm&edit=1&reset=1)[graph Webkit dep](${galleryEditorPath}graph-webkit-dep&edit=1&reset=1)
12+
13+
14+
{{ use: partial-component-id(
15+
prefix = "#"
16+
) }}
17+
18+
## show(boolean) = true
19+
20+
是否显示缩略图组件。
21+
22+
{{ use: partial-rect-layout-width-height(
23+
componentName = "缩略图组件(thumbnail)",
24+
defaultLeft = "25%",
25+
defaultTop = "25%"
26+
) }}
27+
28+
{{ use: partial-coord-sys(
29+
version = '6.0.0',
30+
nonSeriesComponentMainType = "thumbnail",
31+
coordSysDefault = "'none'",
32+
matrix = true,
33+
calendar = true,
34+
none = true
35+
) }}
36+
37+
## itemStyle(Object)
38+
39+
{{ use: partial-version(version = "6.0.0") }}
40+
41+
外壳的样式。
42+
43+
{{ use: partial-item-style(
44+
prefix = '##',
45+
defaultBorderColor = "'#b7b9be'",
46+
defaultBorderWidth = 2
47+
) }}
48+
49+
## windowStyle(Object)
50+
51+
{{ use: partial-version(version = "6.0.0") }}
52+
53+
缩略图窗口的样式。
54+
55+
{{ use: partial-item-style(
56+
prefix = '##',
57+
defaultColor = "'#9ea0a5'",
58+
defaultBorderColor = "'#b7b9be'",
59+
defaultBorderWidth = 1,
60+
defaultOpacity = 0.3
61+
) }}
62+
63+
## seriesIndex(number)
64+
65+
{{ use: partial-version(version = "6.0.0") }}
66+
67+
指定此缩略图作用在哪个系列上。默认取第一个 [关系图系列(series.graph)](~series-graph)
68+
69+
## seriesId(string|number)
70+
71+
{{ use: partial-version(version = "6.0.0") }}
72+
73+
指定此缩略图作用在哪个系列上。默认取第一个 [关系图系列(series.graph)](~series-graph)
74+
75+
{{ /target }}

zh/option/option.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
{{import: component-graphic}}
2424
{{import: component-calendar}}
2525
{{import: component-matrix}}
26+
{{import: component-thumbnail}}
2627
{{import: component-dataset}}
2728
{{import: component-aria}}
2829

zh/option/series/custom.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,8 @@ renderItem 函数的第二个参数。
207207

208208
##### layout(Function)
209209

210+
{{ use: partial-version(version = "6.0.0") }}
211+
210212
将数据值转换成坐标系上的布局信息。
211213

212214
其行为、输入参数和返回值和 [chart.convertToLayout](api.html#echartsInstance.convertToLayout) 相同(只是去除它的第一个参数 `finder`)。

0 commit comments

Comments
 (0)