Skip to content

Update scriptable tooltip context docs #8599

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

Merged
merged 1 commit into from
Mar 9, 2021
Merged

Update scriptable tooltip context docs #8599

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 docs/docs/general/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ There are multiple levels of context objects:
* `data`
* `scale`
* `tick`
* `tooltip`

Each level inherits its parent(s) and any contextual information stored in the parent is available through the child.

Expand Down Expand Up @@ -162,3 +163,10 @@ In addition to [scale](#scale)
* `tick`: the associated tick object
* `index`: tick index
* `type`: `'tick'`

### tooltip

In addition to [chart](#chart)

* `tooltip`: the tooltip object
* `tooltipItems`: the items the tooltip is displaying