Data tooltip support #25831

yanxinc · 2023-05-08T02:48:21Z

PR summary

This adds data tooltip support to the tkinter, qt, gtk3, gtk4, and wx backend. The tooltip is added as a label in the bottom right hand corner whenever the cursor hovers over a data point.

import matplotlib
import matplotlib.pyplot as plt
from numpy.random import rand
matplotlib.use('tkagg')

fig, ax = plt.subplots()
ax.plot(rand(100), 'o', hover=True)
plt.show()

The tooltip can also be set with a list of explicit strings or a user-defined function.

explicit string: ax.plot(rand(3), 'o', hover=['London', 'Paris', 'Barcelona'])
user-defined function:

def user_defined_function(event):
    x, y = round(event.xdata * 10, 1), round(event.ydata + 3, 3)
    return f'({x}, {y})'

ax.plot(rand(100), 'o', hover=user_defined_function)

data dictionary:

x = rand(3)
y = rand(3)
ax.plot(x, y, 'o', hover={(x[0], y[0]): "London", (x[1], y[1]): "Paris", (x[2], y[2]): "Barcelona"})

PR checklist

"closes #0000" is in the body of the PR description to link the related issue
new and changed code is tested
Plotting related features are demonstrated in an example
New Features and API Changes are noted with a directive and release note
Documentation complies with general and docstring guidelines

…approach

Add tooltip API to backend_bases.py and get/set_hover() to artist.pyi

task 2 - added hover backend implementation & tk specific label

Test addition for hover

…k 3, bug fixes

Remove figure not None check

Added support for lists of string literals as arbitrary data tooltips

modified hover functions stub files & fixed style

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

eslothower · 2023-05-08T03:10:46Z

Looks good! Ready to review.

Add documentation

ksunden

Mostly looked closely at the things that were flagging CI such as sphinx warnings.

Broad strokes, I think it looks pretty good, though I would want to take a bit more time to play around with it.

I do think that if this requires changes to other backends we should at least have a plan for achieving feature parity where possible (particularly for gui backends, as this seems to edit tk and qt, but not some of the other options). That doesn't necessarily have to be done in this PR, but having a plan would be good.

Do you feel comfortable squashing commits down? if not, we can do so on merge.

doc/api/next_api_changes/development/00001-ABC.rst

doc/api/next_api_changes/development/00001-EFS.rst

lib/matplotlib/backend_bases.py

lib/matplotlib/tests/test_toolkit.py

pyvenv.cfg

.gitignore

#9) * implemented hover feature for other backends; fixed string list; added dict * fix linter issues * more linter issues --------- Co-authored-by: Yanshi Chen <[email protected]>

* implemented hover feature for other backends; fixed string list; added dict * fix linter issues * more linter issues * fix documentations --------- Co-authored-by: Yanshi Chen <[email protected]>

anntzer · 2023-05-21T12:50:54Z

Based on #23378 (comment) I assume @timhoffm's intent was to have some real "native" tooltip which does not live in the toolbar, but can instead span multiple lines.

tacaswell · 2023-06-01T20:42:25Z

Thank you for this work, however we are currently unlikely to take it in it's current state.

We have two major concerns:

There is not yet a consensus that we want to add a HoverEvent to our set of events
The primary thing that [ENH]: Data tooltip support #23378 was asking for was "native" tooltip support (like we have a "native" rectangle for the zoombox). Getting that in first is a prerequisite for considering if we want a HoverEvent.

eslothower and others added 30 commits April 17, 2023 17:38

Added tooltip API and get/set_hover methods using general HoverEvent …

c8d08d4

…approach

Pushing again for workflows to run

3ebfc4e

Class definition, method implementations, and API doc changes

38e8cbb

Edited HoverEvent constructor for consistent argument order

85a05fc

Ignore bin/ and lib/python3.8/site-packages/ directories

b6c5d75

Merge pull request #1 from eslothower/Eli---Task-1

e2b2c0e

Add tooltip API to backend_bases.py and get/set_hover() to artist.pyi

Attempt to add event corresponding to hover

068e770

style fixing

1cc592b

change event name not to conflict

6ab710d

task 2 - added hover backend implementation & tk specific label

4bdbc54

adding hover_event stub

73e1f59

merging from yc-task2

8423793

Minor fixes and testing

0804eeb

added to pyi files

a1438c7

fix artist.pyi

b7b5db4

fix trailing whitespace

3998293

modified test to fit current yc-task2 spec

1226060

Merge pull request #2 from eslothower/yc-task2

844fcc8

task 2 - added hover backend implementation & tk specific label

Merge branch 'main' into yc-task2-tests

5505989

Style fixes to make lint less angry

ceffed1

Removed redundant part of test

3159fa4

wording fix

2f87853

Merge pull request #3 from eslothower/yc-task2-tests

0a062ed

Test addition for hover

removed check

f9ab7f4

Groundwork for task 3, plotting with function(x,y), test file for tas…

77bfe8e

…k 3, bug fixes

Merge pull request #4 from eslothower/fix-check

028dd77

Remove figure not None check

Fixing linter errors

1ec7212

Fixing more linter errors

324608d

More linter errors

07b8008

LINTER ERRORS

3f78f05

root and others added 15 commits May 7, 2023 08:10

Added support for lists of string literals as arbitrary data tooltips

82a2ab3

initial style fixes

d6a1d31

further linter fixes

bf83d3e

Even more linter fixes

cfc7039

linter fixes for backend_bases

e2ae36a

More linter fixes for backend_bases

4b6fb18

Should be the last push for linting

824a398

Should really be the last linter push now

7aa0571

Merge pull request #6 from eslothower/task3

5c5e5cc

Added support for lists of string literals as arbitrary data tooltips

modified hover functions stub files & fixed style

a5d858f

fix linter errors

82fba4e

test toolkit linter error

402fbbb

minor error fix in mouse_move

599948e

final style fixes

736d53e

Merge pull request #7 from eslothower/task3

66ade4e

modified hover functions stub files & fixed style

github-actions bot reviewed May 8, 2023

View reviewed changes

created demo file

2c859ee

yanxinc marked this pull request as ready for review May 8, 2023 03:11

pm3512 and others added 2 commits May 8, 2023 08:28

wrote docs

d84037d

Merge pull request #8 from eslothower/docs

2211b57

Add documentation

ksunden requested changes May 8, 2023

View reviewed changes

lucychencys and others added 2 commits May 19, 2023 16:34

implemented hover feature for other backends; fixed string list; adde… (

56766cc

#9) * implemented hover feature for other backends; fixed string list; added dict * fix linter issues * more linter issues --------- Co-authored-by: Yanshi Chen <[email protected]>

Fix documentation issues (#10)

f4d50b4

* implemented hover feature for other backends; fixed string list; added dict * fix linter issues * more linter issues * fix documentations --------- Co-authored-by: Yanshi Chen <[email protected]>

yanxinc requested a review from ksunden May 20, 2023 00:04

melissawm added New feature topic: widgets/UI labels May 23, 2023

github-actions bot added the status: needs rebase label Aug 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Data tooltip support #25831

Data tooltip support #25831

yanxinc commented May 8, 2023 •

edited

Loading

github-actions bot left a comment

eslothower commented May 8, 2023

ksunden left a comment

anntzer commented May 21, 2023

tacaswell commented Jun 1, 2023

Data tooltip support #25831

Are you sure you want to change the base?

Data tooltip support #25831

Conversation

yanxinc commented May 8, 2023 • edited Loading

PR summary

PR checklist

github-actions bot left a comment

Choose a reason for hiding this comment

eslothower commented May 8, 2023

ksunden left a comment

Choose a reason for hiding this comment

anntzer commented May 21, 2023

tacaswell commented Jun 1, 2023

yanxinc commented May 8, 2023 •

edited

Loading