Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Added support for lists of string literals as arbitrary data tooltips #6

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

Merged
merged 8 commits into from
May 7, 2023

Conversation

Ebot101
Copy link
Collaborator

@Ebot101 Ebot101 commented May 7, 2023

PR summary

This PR continues to work on issue matplotlib#23378. It allows users to call ax.plot() with the argument "hover=usr_list", where usr_list is a list of string literals that can be pieces of arbitrary additional information assigned to each data point. These arbitrary data labels will appear as a tooltip in the bottom right hand corner of the screen when the cursor is detected to be hovering over a data point that corresponds with one of the data labels. This PR also includes an extension of a preexisting test file for this feature from the perspective of a user.

PR checklist

  • Documentation and Tests
  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

New plotting related features are documented with examples.
Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 eslothower added the enhancement New feature or request label May 7, 2023
@eslothower
Copy link
Owner

Please resolve linter errors

@yanxinc
Copy link
Collaborator

yanxinc commented May 7, 2023

  • Maybe you could directly modify the set_message call that's a few lines above to add the "Original coords:" label in front, instead of appending " Original coords: " to the set hover message (although idk if the label is necessary)
  • we could also make the user-defined hover function more generalized (instead of only allowing newX, newY)
  • also the pyi files should be changed to account for the additional types

@eslothower eslothower merged commit 5c5e5cc into main May 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants