apache / apache/echarts

[Feature] Document tooltip events

Open
#19,238 2 comments 1 reaction 0 assignees View on GitHub
en new-feature pending
Dominant language
TypeScript
Stars
67.3k
Forks
19.8k
Avg merge
11d 14h
Merged PRs (30d)
8

Description

### What problem does this feature solve?

The documentation on `tooltip.showContent` says: "It should be configurated to be false, if you only need tooltip to trigger the event or show the axisPointer without content."
However there's no tooltip-triggered event documented. `showTip` and `hideTip` are only listed as actions, although you actually can listen to these two events.

`updateAxisPointer` is another event that exists but is not documented, also previously mentioned in #18936.

I want to use these events to let users click on the chart (even in empty places) when an axis-triggered tooltip is shown and perform some action depending on the axisPointer value. I previously did this by reading the value in a custom tooltip formatter and check whether the position the user clicked on is inside the grid area.

### What does the proposed API look like?

Just document the events, no API changes needed.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.