This is an automated email from the ASF dual-hosted git repository. sushuang pushed a commit to branch feat-coord-sys in repository https://gitbox.apache.org/repos/asf/echarts-doc.git
commit 655332917d4b2e0dd7fc88512930cedb54dccb01 Author: 100pah <sushuang0...@gmail.com> AuthorDate: Thu Jul 31 00:48:15 2025 +0800 (1) Fix the expression of grid. (2) Add xxxId to reference a coord sys. --- en/option/component/grid.md | 10 ++- en/option/partial/coord-sys.md | 141 ++++++++++++++++++++++++++--------------- zh/option/component/grid.md | 8 ++- zh/option/partial/coord-sys.md | 123 +++++++++++++++++++++++------------ 4 files changed, 187 insertions(+), 95 deletions(-) diff --git a/en/option/component/grid.md b/en/option/component/grid.md index 7ef8e5d5..f2344c97 100644 --- a/en/option/component/grid.md +++ b/en/option/component/grid.md @@ -3,9 +3,15 @@ # grid(Object) -Drawing grid in rectangular coordinate. In a single grid, at most two X and Y axes each is allowed. [Line chart](~series-line), [bar chart](~series-bar), and [scatter chart (bubble chart)](~series-scatter) can be drawn in grid. +The `grid component` is a rectangular container, used to lay out two-dimensional rectangular coordinate system (also known as `cartesian2d` coordinate system). -In ECharts 2.x, there could only be one single grid component at most in a single echarts instance. But in ECharts 3, there is no limitation. +A `cartesian2d` coordinate system is composed fo an [xAxis](~xAixs) and a [yAxis](~yAxis). Multiple `cartesian2d` coordinate systems can be arranged within a single `grid component` - that is, multiple [xAxis](~xAixs) and multiple [yAxis](~yAxis) instances can be configured within one `grid component`. + +An [xAxis](~xAixs) or a [yAxis](~yAxis) can be shared by multiple `cartesian2d` coordinate systems. For example, one [xAxis](~xAixs) and two [yAxis](~yAxis) form two `cartesian2d` coordinate systems. + +[Line chart](~series-line), [bar chart](~series-bar), and [scatter chart (bubble chart)](~series-scatter), etc., can be drawn in `grid component`. + +> In ECharts 2.x, there could only be one single grid component at most in a single echarts instance. But since ECharts 3, there is no limitation. **Following is an example of Anscombe Quartet:** diff --git a/en/option/partial/coord-sys.md b/en/option/partial/coord-sys.md index 4f1605fe..7ba38ccc 100644 --- a/en/option/partial/coord-sys.md +++ b/en/option/partial/coord-sys.md @@ -4,158 +4,199 @@ ## coordinateSystem(string) = ${coordSysDefault} {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -The coordinate used in the series or component, whose options are: +The coordinate system used in the series or component, whose options are: {{ if: ${none} }} -+ `null` or `'none'` ++ `null`/`undefined`/`'none'` - No coordinate. + Do not use coordinate system. {{ /if }} {{ if: ${cartesian2d} }} + `'cartesian2d'` - Use a two-dimensional rectangular coordinate (also known as Cartesian coordinate), with [xAxisIndex](~series-${seriesType}.xAxisIndex) and [yAxisIndex](~series-${seriesType}.yAxisIndex) or [xAxisId](~series-${seriesType}.xAxisId) and [yAxisId](~series-${seriesType}.yAxisId) to assign the corresponding axis component. + Use a two-dimensional [rectangular coordinate system (also known as Cartesian coordinate system)](~grid), with [xAxisIndex](~series-${seriesType}.xAxisIndex) and [yAxisIndex](~series-${seriesType}.yAxisIndex) or [xAxisId](~series-${seriesType}.xAxisId) and [yAxisId](~series-${seriesType}.yAxisId) to assign the corresponding axis component. {{ /if }} {{ if: ${polar} }} + `'polar'` - Use polar coordinates, with [polarIndex](~series-${seriesType}.polarIndex) or [polarId](~series-${seriesType}.polarId) to assign the corresponding polar coordinate component. + Use [polar coordinate system](~polar), with [polarIndex](~series-${seriesType}.polarIndex) or [polarId](~series-${seriesType}.polarId) to assign the corresponding polar coordinate system component. {{ /if }} {{ if: ${singleAxis} }} + `'singleAxis'` - Use `singleAxis` coordinates, with [singleAxisIndex](~series-${seriesType}.polarIndex) or [singleAxisId](~series-${seriesType}.polarId) to assign the corresponding `singleAxis` coordinate component. + Use [singleAxis coordinate system](~singleAxis), with [singleAxisIndex](~series-${seriesType}.polarIndex) or [singleAxisId](~series-${seriesType}.polarId) to assign the corresponding `singleAxis` coordinate system component. {{ /if }} {{ if: ${geo} }} + `'geo'` - Use geographic coordinate, with [geoIndex](~series-${seriesType}.geoIndex) or [geoId](~series-${seriesType}.geoId) to assign the corresponding geographic coordinate components. + Use [geographic coordinate system](~geo), with [geoIndex](~series-${seriesType}.geoIndex) or [geoId](~series-${seriesType}.geoId) to assign the corresponding geographic coordinate system components. {{ /if }} {{ if: ${parallel} }} + `'parallel'` - Use parallel coordinates, with [parallelIndex](~series-${seriesType}.parallelIndex) or [parallelId](~series-${seriesType}.parallelId) to assign the corresponding parallel coordinate components. + Use [parallel coordinate system](~parallel), with [parallelIndex](~series-${seriesType}.parallelIndex) or [parallelId](~series-${seriesType}.parallelId) to assign the corresponding parallel coordinate system components. {{ /if }} {{ if: ${calendar} }} + `'calendar'` - Use calendar coordinates, with [calendarIndex](~series-${seriesType}.calendarIndex) or [calendarId](~series-${seriesType}.calendarId) to assign the corresponding calendar coordinate components. + Use [calendar coordinate system](~calendar), with [calendarIndex](~series-${seriesType}.calendarIndex) or [calendarId](~series-${seriesType}.calendarId) to assign the corresponding calendar coordinate system components. {{ /if }} {{ if: ${matrix} }} + `'matrix'` - Use matrix coordinates, with [matrixIndex](~series-${seriesType}.matrixIndex) or [matrixId](~series-${seriesType}.matrixId) to assign the corresponding matrix coordinate components. + Use [matrix coordinate system](~matrix), with [matrixIndex](~series-${seriesType}.matrixIndex) or [matrixId](~series-${seriesType}.matrixId) to assign the corresponding matrix coordinate system components. {{ /if }} -{{ if: ${none} }} -+ `'none'` - - Do not use coordinate system. -{{ /if }} {{ if: ${cartesian2d} }} ## xAxisIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Index of [x axis](~xAxis) to combine with, which is useful for multiple x axes in one chart. + +## xAxisId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [x axis](~xAxis) to combine with, which is useful for multiple x axes in one chart. +Id of [x axis](~xAxis) to combine with, which is useful for multiple x axes in one chart. ## yAxisIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [y axis](~yAxis) to combine with, which is useful for multiple y axes in one chart. +Index of [y axis](~yAxis) to combine with, which is useful for multiple y axes in one chart. + +## yAxisId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Id of [y axis](~yAxis) to combine with, which is useful for multiple y axes in one chart. {{ /if }} {{ if: ${polar} }} ## polarIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [polar coordinate](~polar) to combine with, which is useful for multiple polar axes in one chart. +Index of [polar coordinate system](~polar) to combine with, which is useful for multiple polar axes in one chart. + +## polarId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Id of [polar coordinate system](~polar) to combine with, which is useful for multiple polar axes in one chart. {{ /if }} {{ if: ${singleAxis} }} ## singleAxisIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [singleAxis coordinate](~singleAxis) to combine with, which is useful for multiple singleAxis in one chart. +Index of [singleAxis coordinate system](~singleAxis) to combine with, which is useful for multiple singleAxis in one chart. + +## singleAxisId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Id of [singleAxis coordinate system](~singleAxis) to combine with, which is useful for multiple singleAxis in one chart. {{ /if }} {{ if: ${geo} }} ## geoIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [geographic coordinate](~geo) to combine with, which is useful for multiple geographic axes in one chart. +Index of [geographic coordinate system](~geo) to combine with, which is useful for multiple geographic axes in one chart. + +## geoId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Id of [geographic coordinate system](~geo) to combine with, which is useful for multiple geographic axes in one chart. {{ /if }} {{ if: ${parallel} }} ## parallelIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Index of [parallel coordinate system](~parallel) to combine with, which is useful for multiple parallel axes in one chart. + +## parallelId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [parallel coordinates](~parallel) to combine with, which is useful for multiple parallel axes in one chart. +Id of [parallel coordinate system](~parallel) to combine with, which is useful for multiple parallel axes in one chart. {{ /if }} {{ if: ${calendar} }} ## calendarIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Index of [calendar coordinate system](~calendar) to combine with, which is useful for multiple calendar coordinate system in one chart. + +## calendarId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [calendar coordinates](~calendar) to combine with, which is useful for multiple calendar coordinates in one chart. +Id of [calendar coordinate system](~calendar) to combine with, which is useful for multiple calendar coordinate system in one chart. {{ /if }} {{ if: ${matrix} }} ## matrixIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +Index of [matrix coordinate system](~matrix) to combine with, which is useful for multiple matrix coordinate system in one chart. + +## matrixId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} {{ /if }} -Index of [matrix coordinates](~matrix) to combine with, which is useful for multiple matrix coordinates in one chart. +Id of [matrix coordinate system](~matrix) to combine with, which is useful for multiple matrix coordinate system in one chart. {{ /if }} diff --git a/zh/option/component/grid.md b/zh/option/component/grid.md index 36bd0628..1dec218d 100644 --- a/zh/option/component/grid.md +++ b/zh/option/component/grid.md @@ -3,9 +3,13 @@ # grid(Object) -直角坐标系内绘图网格,单个 grid 内最多可以放置上下两个 X 轴,左右两个 Y 轴。可以在网格上绘制[折线图](~series-line),[柱状图](~series-bar),[散点图(气泡图)](~series-scatter)。 +`grid 组件` 是一个矩形容器,用于绘制二维直角坐标系(`cartesian2d`)。一个 `cartesian2d` 坐标系由一个 [xAxis](~xAixs) 和一个 [yAxis](~yAxis) 构成。一个 `grid 组件` 中可以存在多个 `cartesian2d` 坐标系。即,一个 `grid 组件` 可以配置多个 [xAxis](~xAixs) 和多个 [yAxis](~yAxis)。 -在 ECharts 2.x 里单个 echarts 实例中最多只能存在一个 grid 组件,在 ECharts 3 中可以存在任意个 grid 组件。 +[xAxis](~xAixs) 和 [yAxis](~yAxis) 可以被多个 `cartesian2d` 坐标系共享。例如,一个 [xAxis](~xAixs) 和两个 [yAxis](~yAxis) 构成两个 `cartesian2d` 坐标系。 + +可以在 `grid 组件` 中绘制例如 [折线图](~series-line),[柱状图](~series-bar),[散点图(气泡图)](~series-scatter) 等等。 + +> 在 ECharts 2.x 里单个 echarts 实例中最多只能存在一个 grid 组件,自从 ECharts 3 开始可以存在任意多个 `grid 组件`。 **例如下面这个 Anscombe Quartet 的示例:** diff --git a/zh/option/partial/coord-sys.md b/zh/option/partial/coord-sys.md index 23c3bc8e..d64fd3ec 100644 --- a/zh/option/partial/coord-sys.md +++ b/zh/option/partial/coord-sys.md @@ -4,158 +4,199 @@ ## coordinateSystem(string) = ${coordSysDefault} {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 该系列或组件使用的坐标系,可选: {{ if: ${none} }} -+ `null` 或者 `'none'` ++ `null`、`undefined` 或者 `'none'` - 无坐标系。 + 不使用坐标系。 {{ /if }} {{ if: ${cartesian2d} }} + `'cartesian2d'` - 使用二维的直角坐标系(也称笛卡尔坐标系),通过 [xAxisIndex](~series-${seriesType}.xAxisIndex) 和 [yAxisIndex](~series-${seriesType}.yAxisIndex) 或者 [xAxisId](~series-${seriesType}.xAxisId) 和 [yAxisId](~series-${seriesType}.yAxisId) 指定相应的坐标轴组件。 + 使用二维 [直角坐标系(也称笛卡尔坐标系)](~grid),通过 [xAxisIndex](~series-${seriesType}.xAxisIndex) 和 [yAxisIndex](~series-${seriesType}.yAxisIndex) 或者 [xAxisId](~series-${seriesType}.xAxisId) 和 [yAxisId](~series-${seriesType}.yAxisId) 指定相应的坐标轴组件。 {{ /if }} {{ if: ${polar} }} + `'polar'` - 使用极坐标系,通过 [polarIndex](~series-${seriesType}.polarIndex) 或 [polarId](~series-${seriesType}.polarId) 指定相应的极坐标组件 + 使用 [极坐标系](~polar),通过 [polarIndex](~series-${seriesType}.polarIndex) 或 [polarId](~series-${seriesType}.polarId) 指定相应的极坐标系组件 {{ /if }} {{ if: ${singleAxis} }} + `'singleAxis'` - 使用单轴坐标系,通过 [singleAxisIndex](~series-${seriesType}.singleAxisIndex) 或 [singleAxisId](~series-${seriesType}.singleAxisId) 指定相应的单轴标组件 + 使用 [单轴坐标系](~singleAxis),通过 [singleAxisIndex](~series-${seriesType}.singleAxisIndex) 或 [singleAxisId](~series-${seriesType}.singleAxisId) 指定相应的单轴标系组件 {{ /if }} {{ if: ${geo} }} + `'geo'` - 使用地理坐标系,通过 [geoIndex](~series-${seriesType}.geoIndex) 或 [geoId](~series-${seriesType}.geoId) 指定相应的地理坐标系组件。 + 使用 [地理坐标系](~geo),通过 [geoIndex](~series-${seriesType}.geoIndex) 或 [geoId](~series-${seriesType}.geoId) 指定相应的地理坐标系组件。 {{ /if }} {{ if: ${parallel} }} + `'parallel'` - 使用平行坐标系,通过 [parallelIndex](~series-${seriesType}.parallelIndex) 或 [parallelId](~series-${seriesType}.parallelId) 指定相应的平行坐标系组件。 + 使用 [平行坐标系](~parallel),通过 [parallelIndex](~series-${seriesType}.parallelIndex) 或 [parallelId](~series-${seriesType}.parallelId) 指定相应的平行坐标系组件。 {{ /if }} {{ if: ${calendar} }} + `'calendar'` - 使用日历坐标系,通过 [calendarIndex](~series-${seriesType}.calendarIndex) 或 [calendarId](~series-${seriesType}.calendarId) 指定相应的日历坐标系组件。 + 使用 [日历坐标系](~calendar),通过 [calendarIndex](~series-${seriesType}.calendarIndex) 或 [calendarId](~series-${seriesType}.calendarId) 指定相应的日历坐标系组件。 {{ /if }} {{ if: ${matrix} }} + `'matrix'` - 使用矩阵坐标系,通过 [matrixIndex](~series-${seriesType}.matrixIndex) 或 [matrixId](~series-${seriesType}.matrixId) 指定相应的矩阵坐标系组件。 + 使用 [矩阵坐标系](~matrix),通过 [matrixIndex](~series-${seriesType}.matrixIndex) 或 [matrixId](~series-${seriesType}.matrixId) 指定相应的矩阵坐标系组件。 {{ /if }} -{{ if: ${none} }} -+ `'none'` - - 不使用坐标系。 -{{ /if }} {{ if: ${cartesian2d} }} ## xAxisIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的 [x 轴](~xAxis)的 index,在单个图表实例中存在多个 x 轴的时候有用。 +## xAxisId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的 [x 轴](~xAxis)的 id,在单个图表实例中存在多个 x 轴的时候有用。 + ## yAxisIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的 [y 轴](~yAxis)的 index,在单个图表实例中存在多个 y轴的时候有用。 + +## yAxisId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的 [y 轴](~yAxis)的 id,在单个图表实例中存在多个 y轴的时候有用。 {{ /if }} {{ if: ${polar} }} ## polarIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的[极坐标系](~polar)的 index,在单个图表实例中存在多个极坐标系的时候有用。 + +## polarId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的[极坐标系](~polar)的 id,在单个图表实例中存在多个极坐标系的时候有用。 {{ /if }} {{ if: ${singleAxis} }} ## singleAxisIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的[单轴标系](~singleAxis)的 index,在单个图表实例中存在多个单轴坐标系的时候有用。 + +## singleAxisId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的[单轴标系](~singleAxis)的 id,在单个图表实例中存在多个单轴坐标系的时候有用。 {{ /if }} {{ if: ${geo} }} ## geoIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的[地理坐标系](~geo)的 index,在单个图表实例中存在多个地理坐标系的时候有用。 + +## geoId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的[地理坐标系](~geo)的 id,在单个图表实例中存在多个地理坐标系的时候有用。 {{ /if }} {{ if: ${parallel} }} ## parallelIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的[平行坐标系](~parallel)的 index,在单个图表实例中存在多个平行坐标系的时候有用。 + +## parallelId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的[平行坐标系](~parallel)的 id,在单个图表实例中存在多个平行坐标系的时候有用。 {{ /if }} {{ if: ${calendar} }} ## calendarIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的[日历坐标系](~calendar)的 index,在单个图表实例中存在多个日历坐标系的时候有用。 + +## calendarId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的[日历坐标系](~calendar)的 id,在单个图表实例中存在多个日历坐标系的时候有用。 {{ /if }} {{ if: ${matrix} }} ## matrixIndex(number) = 0 {{ if: ${version} }} -{{ use: partial-version( - version = ${version} -) }} +{{ use: partial-version(version = ${version}) }} {{ /if }} 使用的[矩阵坐标系](~matrix)的 index,在单个图表实例中存在多个矩阵坐标系的时候有用。 + +## matrixId(number) = undefined + +{{ if: ${version} }} +{{ use: partial-version(version = ${version}) }} +{{ /if }} + +使用的[矩阵坐标系](~matrix)的 id,在单个图表实例中存在多个矩阵坐标系的时候有用。 {{ /if }} --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@echarts.apache.org For additional commands, e-mail: commits-h...@echarts.apache.org