Skip to content

doc: add option includeMarkerInExtent for xAxis and yAxis #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: add option includeMarkerInExtent for xAxis and yAxis #481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions en/option/component/x-axis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ Notice: Set `xAxis.axisLine.onZero` to `false` to activate this option.
Offset of x axis relative to default position. Useful when multiple x axis has same [position](~xAxis.position) value.
Notice: Set `xAxis.axisLine.onZero` to `false` to activate this option.

## includeMarkerInExtent(boolean) = true

<ExampleUIControlBoolean />

{{ use: partial-version(version = "6.0.1") }}

Whether to include markers (markPoint, markLine, markArea) in the default axis extent calculation.

By default or when set to `true`, the axis extent calculation will consider the positions of markers, ensuring that markers are visible within the axis range. When set to `false`, marker values are not considered when calculating the default axis range.

{{ use: axis-common(
prefix = '#',
componentType = 'xAxis',
Expand Down
10 changes: 10 additions & 0 deletions en/option/component/y-axis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ Notice: Set `yAxis.axisLine.onZero` to `false` to activate this option.
Offset of y axis relative to default position. Useful when multiple y axis has same [position](~yAxis.position) value.
Notice: Set `yAxis.axisLine.onZero` to `false` to activate this option.

## includeMarkerInExtent(boolean) = true

<ExampleUIControlBoolean />

{{ use: partial-version(version = "6.0.1") }}

Whether to include markers (markPoint, markLine, markArea) in the default axis extent calculation.

By default or when set to `true`, the axis extent calculation will consider the positions of markers, ensuring that markers are visible within the axis range. When set to `false`, marker values are not considered when calculating the default axis range.

{{ use: axis-common(
prefix = '#',
componentType = 'yAxis',
Expand Down
10 changes: 10 additions & 0 deletions zh/option/component/x-axis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,16 @@ x 轴的位置。

X 轴相对于默认位置的偏移，在相同的 `position` 上有多个 X 轴的时候有用。注：若未将 `xAxis.axisLine.onZero` 设为 `false` , 则该项无法生效。

## includeMarkerInExtent(boolean) = true

<ExampleUIControlBoolean />

{{ use: partial-version(version = "6.0.1") }}

是否在坐标轴默认范围计算时包含标记（markPoint、markLine、markArea）。

默认条件下或设置为 `true` 时坐标轴的范围计算会考虑标记的位置，确保标记在坐标轴范围内可见。当设置 `false`时，计算默认轴范围时则不考虑标记的数值。

{{ use: axis-common(
prefix = '#',
componentType = 'xAxis',
Expand Down
10 changes: 10 additions & 0 deletions zh/option/component/y-axis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,16 @@ Y 轴相对于默认位置的偏移，在相同的 `position` 上有多个 Y 轴

需要配合其他配置项共同实现动态排序柱状图效果，具体参见[动态排序柱状图](${handbookPath}how-to/chart-types/bar/bar-race)教程。

## includeMarkerInExtent(boolean) = true

<ExampleUIControlBoolean />

{{ use: partial-version(version = "6.0.1") }}

是否在坐标轴默认范围计算时包含标记（markPoint、markLine、markArea）。

默认条件下或设置为 `true` 时坐标轴的范围计算会考虑标记的位置，确保标记在坐标轴范围内可见。当设置 `false`时，计算默认轴范围时则不考虑标记的数值。

{{ use: axis-common(
prefix = '#',
componentType = 'yAxis',
Expand Down