Skip to content

doc(axisPointer): document triggerOnNull option #349

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(axisPointer): document triggerOnNull option #349

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
8 changes: 8 additions & 0 deletions en/option/partial/axisPointer-common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,14 @@ Options:

Whether to trigger tooltip.

#${prefix} triggerOnNull(boolean) = false

<ExampleUIControlBoolean default="false" />

Whether to trigger the axisPointer on `null` or `undefined` values. This is useful when used with the `echarts.connect()` API to trigger the axisPointer on connected charts if the value on those charts is `null`, `undefined`, or nonexistent.

The `snap` attribute takes precedence over this.

#${prefix} value(number) = null

current value. When using [axisPointer.handle](xAxisPointer.handle), `value` can be set to define the initial position of axisPointer.
Expand Down
8 changes: 8 additions & 0 deletions zh/option/partial/axisPointer-common.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,14 @@ axisPointer 的 label 默认不显示（也就是默认只显示指示线），

是否触发 tooltip。如果不想触发 tooltip 可以关掉。

#${prefix} triggerOnNull(boolean) = false

<ExampleUIControlBoolean default="false" />

是否在`'null'`或`'undefined'`值上触发 axisPointer。如果这些图表上的值为`'null'`、`'undefined'`或不存在，这在与`'echarts.connect()'`API 一起使用以触发连接图表上的 axisPointer 时非常有用。

`snap` 属性优先于此。

#${prefix} value(number) = null

当前的 value。在使用 [axisPointer.handle](xAxisPointer.handle) 时，可以设置此值进行初始值设定，从而决定 axisPointer 的初始位置。
Expand Down