This is an automated email from the ASF dual-hosted git repository. sushuang pushed a commit to branch coord-sys-doc-enhancement in repository https://gitbox.apache.org/repos/asf/echarts-doc.git
The following commit(s) were added to refs/heads/coord-sys-doc-enhancement by this push: new fa0989bd Add thumbnail component doc. fa0989bd is described below commit fa0989bda874c555256348d43d6b24d6a3a37d4d Author: 100pah <sushuang0...@gmail.com> AuthorDate: Sun Aug 10 21:11:46 2025 +0800 Add thumbnail component doc. --- en/api/echarts-instance.md | 3 ++ en/option/component/thumbnail.md | 76 ++++++++++++++++++++++++++++++++++++++++ en/option/option.md | 1 + en/option/series/custom.md | 2 ++ zh/api/echarts-instance.md | 3 ++ zh/option/component/thumbnail.md | 75 +++++++++++++++++++++++++++++++++++++++ zh/option/option.md | 1 + zh/option/series/custom.md | 2 ++ 8 files changed, 163 insertions(+) diff --git a/en/api/echarts-instance.md b/en/api/echarts-instance.md index fccadb2d..8fdf936f 100644 --- a/en/api/echarts-instance.md +++ b/en/api/echarts-instance.md @@ -676,6 +676,9 @@ The format of the input `coord` and return type are defined by each coordinate s ## convertToLayout(Function) + +{{ use: partial-version(version = "6.0.0") }} + ```ts ( // `finder` is used to indicate in which coordinate system diff --git a/en/option/component/thumbnail.md b/en/option/component/thumbnail.md new file mode 100644 index 00000000..dd210ff2 --- /dev/null +++ b/en/option/component/thumbnail.md @@ -0,0 +1,76 @@ +{{ target: component-thumbnail }} + +# thumbnail(Object) + +{{ use: partial-version(version = "6.0.0") }} + +Thumbnail component. + +Currently it only supports [series.graph](~series-graph). + +Examples: [graph NPM](${galleryEditorPath}graph-npm&edit=1&reset=1), [graph Webkit dep](${galleryEditorPath}graph-webkit-dep&edit=1&reset=1). + + +{{ use: partial-component-id( + prefix = "#" +) }} + +## show(boolean) = true + +Whether to display the thumbnail component. + +{{ use: partial-rect-layout-width-height( + componentName = "thumbnail", + defaultLeft = "25%", + defaultTop = "25%" +) }} + +{{ use: partial-coord-sys( + version = '6.0.0', + nonSeriesComponentMainType = "thumbnail", + coordSysDefault = "'none'", + matrix = true, + calendar = true, + none = true +) }} + +## itemStyle(Object) + +{{ use: partial-version(version = "6.0.0") }} + +The style of the box and background of the thumbnail. + +{{ use: partial-item-style( + prefix = '##', + defaultBorderColor = "'#b7b9be'", + defaultBorderWidth = 2 +) }} + +## windowStyle(Object) + +{{ use: partial-version(version = "6.0.0") }} + +The style of the window of the thumbnail. + +{{ use: partial-item-style( + prefix = '##', + defaultColor = "'#9ea0a5'", + defaultBorderColor = "'#b7b9be'", + defaultBorderWidth = 1, + defaultOpacity = 0.3 +) }} + +## seriesIndex(number) + +{{ use: partial-version(version = "6.0.0") }} + +Specify which series this thumbnail is for. Use the first [series.graph](~series-graph) by default. + +## seriesId(string|number) + +{{ use: partial-version(version = "6.0.0") }} + +Specify which series this thumbnail is for. Use the first [series.graph](~series-graph) by default. + + +{{ /target }} diff --git a/en/option/option.md b/en/option/option.md index 64f11bfe..2e867780 100644 --- a/en/option/option.md +++ b/en/option/option.md @@ -23,6 +23,7 @@ {{import: component-graphic}} {{import: component-calendar}} {{import: component-matrix}} +{{import: component-thumbnail}} {{import: component-dataset}} {{import: component-aria}} diff --git a/en/option/series/custom.md b/en/option/series/custom.md index 12dbd7a3..2e78e1de 100644 --- a/en/option/series/custom.md +++ b/en/option/series/custom.md @@ -218,6 +218,8 @@ The behavior, parameters and returns are the same as [chart.convertToPixel](api. ##### layout(Function) +{{ use: partial-version(version = "6.0.0") }} + Convert data to the corresponding layout info based on the current coordinate system. The behavior, parameters and returns are the same as [chart.convertToLayout](api.html#echartsInstance.convertToLayout) (only exclude its first parameter `finder`). diff --git a/zh/api/echarts-instance.md b/zh/api/echarts-instance.md index c3989d1d..6d29d74b 100644 --- a/zh/api/echarts-instance.md +++ b/zh/api/echarts-instance.md @@ -679,6 +679,9 @@ ECharts 中的事件有两种,一种是鼠标事件,在鼠标点击某个图 ## convertToLayout(Function) + +{{ use: partial-version(version = "6.0.0") }} + ```ts ( // `finder` 用于指示『使用哪个坐标系或数轴或系列进行转换』。 diff --git a/zh/option/component/thumbnail.md b/zh/option/component/thumbnail.md new file mode 100644 index 00000000..5dff544f --- /dev/null +++ b/zh/option/component/thumbnail.md @@ -0,0 +1,75 @@ +{{ target: component-thumbnail }} + +# thumbnail(Object) + +{{ use: partial-version(version = "6.0.0") }} + +缩略图组件。 + +现在仅支持用在 [关系图系列(series.graph)](~series-graph) 上。 + +示例:[graph NPM](${galleryEditorPath}graph-npm&edit=1&reset=1)、[graph Webkit dep](${galleryEditorPath}graph-webkit-dep&edit=1&reset=1)。 + + +{{ use: partial-component-id( + prefix = "#" +) }} + +## show(boolean) = true + +是否显示缩略图组件。 + +{{ use: partial-rect-layout-width-height( + componentName = "缩略图组件(thumbnail)", + defaultLeft = "25%", + defaultTop = "25%" +) }} + +{{ use: partial-coord-sys( + version = '6.0.0', + nonSeriesComponentMainType = "thumbnail", + coordSysDefault = "'none'", + matrix = true, + calendar = true, + none = true +) }} + +## itemStyle(Object) + +{{ use: partial-version(version = "6.0.0") }} + +外壳的样式。 + +{{ use: partial-item-style( + prefix = '##', + defaultBorderColor = "'#b7b9be'", + defaultBorderWidth = 2 +) }} + +## windowStyle(Object) + +{{ use: partial-version(version = "6.0.0") }} + +缩略图窗口的样式。 + +{{ use: partial-item-style( + prefix = '##', + defaultColor = "'#9ea0a5'", + defaultBorderColor = "'#b7b9be'", + defaultBorderWidth = 1, + defaultOpacity = 0.3 +) }} + +## seriesIndex(number) + +{{ use: partial-version(version = "6.0.0") }} + +指定此缩略图作用在哪个系列上。默认取第一个 [关系图系列(series.graph)](~series-graph)。 + +## seriesId(string|number) + +{{ use: partial-version(version = "6.0.0") }} + +指定此缩略图作用在哪个系列上。默认取第一个 [关系图系列(series.graph)](~series-graph)。 + +{{ /target }} diff --git a/zh/option/option.md b/zh/option/option.md index cbb37655..77048280 100644 --- a/zh/option/option.md +++ b/zh/option/option.md @@ -23,6 +23,7 @@ {{import: component-graphic}} {{import: component-calendar}} {{import: component-matrix}} +{{import: component-thumbnail}} {{import: component-dataset}} {{import: component-aria}} diff --git a/zh/option/series/custom.md b/zh/option/series/custom.md index 59218a85..44f126ca 100644 --- a/zh/option/series/custom.md +++ b/zh/option/series/custom.md @@ -207,6 +207,8 @@ renderItem 函数的第二个参数。 ##### layout(Function) +{{ use: partial-version(version = "6.0.0") }} + 将数据值转换成坐标系上的布局信息。 其行为、输入参数和返回值和 [chart.convertToLayout](api.html#echartsInstance.convertToLayout) 相同(只是去除它的第一个参数 `finder`)。 --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@echarts.apache.org For additional commands, e-mail: commits-h...@echarts.apache.org