8000 added parameter documentation for MultiCursor · matplotlib/matplotlib@a404e9e · GitHub
[go: up one dir, main page]

Skip to content

Commit a404e9e

Browse files
author
Felix Nößler
committed
added parameter documentation for MultiCursor
1 parent b09aad2 commit a404e9e

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

lib/matplotlib/widgets.py

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1592,6 +1592,7 @@ class Cursor(AxesWidget):
15921592
Whether to draw the vertical line.
15931593
useblit : bool, default: False
15941594
Use blitting for faster drawing if supported by the backend.
1595+
See the tutorial :doc:`/tutorials/advanced/blitting` for details.
15951596
15961597
Other Parameters
15971598
----------------
@@ -1687,6 +1688,7 @@ class MultiCursor(Widget):
16871688
16881689
useblit : bool, default: True
16891690
Use blitting for faster drawing if supported by the backend.
1691+
See the tutorial :doc:`/tutorials/advanced/blitting` for details.
16901692
16911693
horizOn : bool, default: False
16921694
Whether to draw the horizontal line.
@@ -2093,7 +2095,8 @@ def on_select(min: float, max: float) -> Any
20932095
20942096
useblit : bool, default: False
20952097
If True, use the backend-dependent blitting features for faster
2096-
canvas updates.
2098+
canvas updates. See the tutorial :doc:`/tutorials/advanced/blitting`
2099+
for details.
20972100
20982101
props : dict, optional
20992102
Dictionary of `matplotlib.patches.Patch` properties.
@@ -2502,7 +2505,8 @@ class ToolLineHandles:
25022505
Additional line properties. See `matplotlib.lines.Line2D`.
25032506
useblit : bool, default: True
25042507
Whether to use blitting for faster drawing (if supported by the
2505-
backend).
2508+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
2509+
for details.
25062510
"""
25072511

25082512
def __init__(self, ax, positions, direction, line_props=None,
@@ -2609,7 +2613,8 @@ class ToolHandles:
26092613
Additional marker properties. See `matplotlib.lines.Line2D`.
26102614
useblit : bool, default: True
26112615
Whether to use blitting for faster drawing (if supported by the
2612-
backend).
2616+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
2617+
for details.
26132618
"""
26142619

26152620
def __init__(self, ax, x, y, marker='o', marker_props=None, useblit=True):
@@ -2684,7 +2689,8 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
26842689
26852690
useblit : bool, default: False
26862691
Whether to use blitting for faster drawing (if supported by the
2687-
backend).
2692+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
2693+
for details.
26882694
26892695
props : dict, optional
26902696
Properties with which the __ARTIST_NAME__ is drawn. See
@@ -3240,7 +3246,8 @@ def onselect(verts):
32403246
passed the vertices of the selected path.
32413247
useblit : bool, default: True
32423248
Whether to use blitting for faster drawing (if supported by the
3243-
backend).
3249+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3250+
for details.
32443251
props : dict, optional
32453252
Properties with which the line is drawn, see `matplotlib.lines.Line2D`
32463253
for valid properties. Default values are defined in ``mpl.rcParams``.
@@ -3322,7 +3329,8 @@ class PolygonSelector(_SelectorWidget):
33223329
33233330
useblit : bool, default: False
33243331
Whether to use blitting for faster drawing (if supported by the
3325-
backend).
3332+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3333+
for details.
33263334
33273335
props : dict, optional
33283336
Properties with which the line is drawn, see `matplotlib.lines.Line2D`
@@ -3589,7 +3597,8 @@ class Lasso(AxesWidget):
35893597
Coordinates of the start of the lasso.
35903598
useblit : bool, default: True
35913599
Whether to use blitting for faster drawing (if supported by the
3592-
backend).
3600+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3601+
for details.
35933602
callback : callable
35943603
Whenever the lasso is released, the *callback* function is called and
35953604
passed the vertices of the selected path.

0 commit comments

Comments
 (0)
0