Skip to content
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.

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

feat(event): add option for step-before/step-after charts for tooltip to match step behavior #2332

Closed
wants to merge 1 commit into from
Closed

Conversation

ebencollins
Copy link
Contributor

Issue

#2287

Details

Optionally makes tooltip show for point of moused over step for step-after and step-before charts.
Fixes the previous inconsistencies when mousing between step transitions and fixes it for timeseries charts.
Added note to the documentation that data․type must be step, and updated the demo to reflect this.

It's worth noting that prior to 5d3a5ed, this behavior was default for charts with step-after that weren't timeseries, but not step-before. I'm not sure what was intended, so I added it as an option with default false to be safe, though I think it makes the step chart feel far more intuitive.

step-before example: https://i.imgur.com/mXywDti.png
step-after example: https://i.imgur.com/IBoR69K.png

step-after with tooltipMatch=false (also current behavior): https://i.imgur.com/4B9rx2d.png

@coveralls
Copy link

Coverage Status

Coverage increased (+0.02%) to 89.968% when pulling 37941b8 on ebencollins:step-tooltip-placement into 1ce7333 on naver:master.

@netil netil added the feature label Sep 24, 2021
@netil netil closed this in 5f664ba Sep 27, 2021
@netil
Copy link
Member

netil commented Sep 27, 2021

@ebencollins thanks for the contribution!

I did some updates from your PR.
And the following is working example of the new tooltipMatch option.

line: {
    step: {
        type: "step-after",
        tooltipMatch: false
    }
}




line: {
    step: {
        type: "step-after",
        tooltipMatch: true
    }
},

github-actions bot pushed a commit that referenced this pull request Oct 1, 2021
# [3.2.0-next.6](3.2.0-next.5...3.2.0-next.6) (2021-10-01)

### Bug Fixes

* **types:** Allow string dates for zoom() domain ([9cae479](9cae479)), closes [#2316](#2316) [#2333](#2333)
* **types:** Fix type definition for load().json ([25ebb78](25ebb78)), closes [#2334](#2334)

### Features

* **event:** add option for step-before/step-after charts for tooltip to match step behavior ([5f664ba](5f664ba)), closes [#2332](#2332)
github-actions bot pushed a commit that referenced this pull request Oct 7, 2021
# [3.2.0](3.1.5...3.2.0) (2021-10-07)

### Bug Fixes

* **axis:** fix y axis stepSize value ([18f6f27](18f6f27)), closes [#2294](#2294)
* **bar:** fix data label to be shown for 0 values ([f3634ee](f3634ee)), closes [#2251](#2251)
* **event:** make consistent tooltip position on step-after ([5d3a5ed](5d3a5ed)), closes [#2287](#2287)
* **gauge:** fix error when interaction=false ([cc4a5e7](cc4a5e7)), closes [#2351](#2351)
* **grid:** Make grid elements pass through pointer events ([4db1bcd](4db1bcd)), closes [#2355](#2355)
* **grid:** pPrevent error throw  ([8fcf61c](8fcf61c)), closes [#2310](#2310)
* **plugin:** fix textoverlap plugin ([5e486b5](5e486b5)), closes [#1144](#1144)
* **subchart:** fix subchart esm import failure ([ba6c2b5](ba6c2b5)), closes [#2255](#2255)
* **tooltip:** fix tooltip.position call context ([b78a48d](b78a48d)), closes [#2265](#2265)
* **types:** Allow string dates for zoom() domain ([9cae479](9cae479)), closes [#2316](#2316) [#2333](#2333)
* **types:** fix data.onshown/hidden types ([3721c4c](3721c4c)), closes [#2270](#2270) [#2275](#2275)
* **types:** Fix type definition for load().json ([25ebb78](25ebb78)), closes [#2334](#2334)
* **types:** Fix wrong type definition ([5f7779b](5f7779b)), closes [#2316](#2316)
* **zoom:** Fix error throw on drag zoom interaction ([f1dcb27](f1dcb27)), closes [#2343](#2343)
* **zoom:** fix zoom event triggering for drag type ([0a0f039](0a0f039)), closes [#2254](#2254)
* **zoom:** Fix zoomend call on .zoom()  ([9515565](9515565)), closes [#2217](#2217) [#2254](#2254)

### Features

* **axis:** Enhance padding to accept px value ([769ec8f](769ec8f)), closes [#2246](#2246)
* **error:** Enhance error logging for ESM import ([4b5119c](4b5119c)), closes [#2311](#2311)
* **event:** add option for step-before/step-after charts for tooltip to match step behavior ([5f664ba](5f664ba)), closes [#2332](#2332)
* **module:** Support dual CJS/ESM package ([ddd8977](ddd8977)), closes [#2202](#2202)
* **plugin:** Intent to ship sparkline ([091284e](091284e)), closes [#2285](#2285)
* **plugin:** Intent to ship TableView plugin ([6f07e94](6f07e94)), closes [#1873](#1873)
* **Subchart:** add subchart x axis tick format option ([da2f3ff](da2f3ff)), closes [#2314](#2314)
* **tooltip:** Enhance tooltip.position passing curr pos ([ec783e9](ec783e9)), closes [#2267](#2267)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants