Allow disabling specific mouse actions in blocking_input #12199
Merged
Conversation
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
ginput doesn´t allow to disable buttons. With this change you can assign an invalid button to the three mouse buttons and leave the left click empty to zoom or pan. Updated the documentation associated with ginput, regarding the changes applied to blocking_input to allow for pan and zoom (PR cleanup by the committer.)
98767df to
7c24848
Compare
tacaswell
approved these changes
Sep 21, 2018
timhoffm
reviewed
Sep 22, 2018
lib/matplotlib/figure.py
Outdated
| points, terminating the inputs) can be overridden via the arguments | ||
| *mouse_add*, *mouse_pop* and *mouse_stop*, that set the associated | ||
| mouse button: 1 for left, 2 for middle, 3 for right. Using a different | ||
| value (e.g. None) disables the corresponding mouse action. |
There was a problem hiding this comment.
We should be stricter about the guaranteed behavior: "Passing None disables the corresponding mouse action."
Other values should have undefined behavior, or better be rejected with a ValueError. I could for example imagine that we allow 'left', 'middle', 'right' instead of 1, 2, 3 in the future, which would be a more readable API. That would be a breaking API change with the above laissez-faire definition.
There was a problem hiding this comment.
I'd rather not change the behavior in this PR (other than the check for botton_add which is clearly correct). Feel free to push changes to the docstring as you see fit.
There was a problem hiding this comment.
Ok. I've updated the docstring.
timhoffm
approved these changes
Sep 22, 2018
QuLogic
reviewed
Sep 23, 2018
lib/matplotlib/figure.py
Outdated
| - Remove the most recently added point. | ||
| - Stop the interaction and return the points added so far. | ||
|
|
||
| The actions are assigned to mouse buttons via the the arguments |
f07b7cb to
5f29877
Compare
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is #11661 taking into account @timhoffm's comment and fixing the docs. Thanks to @saksmito for the PR.
ginput doesn´t allow to disable buttons.
With this change you can assign an invalid button to the three mouse buttons and leave the left click empty to zoom or pan.
Updated the documentation associated with ginput, regarding the changes applied to blocking_input to allow for pan and zoom
(PR cleanup by the committer.)
PR Summary
PR Checklist