docs(axisPointer): document triggerOnNoData and findPointOnConnectedCharts#520
Open
aggarwal-h wants to merge 1 commit into
Open
docs(axisPointer): document triggerOnNoData and findPointOnConnectedCharts#520aggarwal-h wants to merge 1 commit into
triggerOnNoData and findPointOnConnectedCharts#520aggarwal-h wants to merge 1 commit into
Conversation
Add triggerOnNoData (shared across all axisPointer contexts) and findPointOnConnectedCharts (component only).
9 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents two new
axisPointeroptions added in apache/echarts#21656.Options
axisPointer.triggerOnNoData(boolean, defaultfalse) — when enabled, the axis pointer stays visible at a position even if there is no data there. Mainly useful for charts linked byecharts.connect: hovering one chart where a connected chart has no data keeps the pointer shown on the other chart at the linked axis value instead of hiding it.axisPointer.findPointOnConnectedCharts(boolean, defaulttrue) — set tofalseto stop a connected chart from snapping the pointer to a sample series point, so it follows the linked axis value only.Where
triggerOnNoDatagoes in the sharedoption/partial/axisPointer-common.md, so it is documented once and shown across all axisPointer contexts (x/y/radius/ angle/single/parallel axes, theaxisPointercomponent, andtooltip.axisPointer).findPointOnConnectedChartsgoes inoption/component/axisPointer.md, since the code reads it from the top-levelaxisPointercomponent only.Both options are documented in English and Chinese, tagged
Since v6.2.0(please adjust if the release version differs).Related
Verification
Ran
node build/build-doc.js --env asf; the option markdown parses and both options render intooption.json(en + zh) with the version badge, theecharts.connectlink, and thetriggerOnNoDatacross-reference.