Skip to content

SpanSelector widget: Improve doc for extents #27397

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.

Sign up for GitHub

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
story645 merged 4 commits into from
Dec 5, 2023
Merged

SpanSelector widget: Improve doc for extents #27397

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6312409
SpanSelector widget: Improve doc for `extents`
Nov 29, 2023
a331250
Update lib/matplotlib/widgets.py
judfs Nov 29, 2023
c311ec5
Fix formatting
Nov 30, 2023
72a18cc
remove "Writable." note
Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion lib/matplotlib/widgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2855,7 +2855,12 @@ def _snap(values, snap_values):

@property
def extents(self):
"""Return extents of the span selector."""
"""
(float, float)
The values, in data coordinates, for the start and end points of the current
selection. If there is no selection then the start and end values will be
the same.
"""
if self.direction == 'horizontal':
vmin = self._selection_artist.get_x()
vmax = vmin + self._selection_artist.get_width()
Expand Down