8000 Adding tutorial links for blitting in widgets (#21494) · matplotlib/matplotlib@750916f · GitHub
[go: up one dir, main page]

Skip to content

Commit 750916f

Browse files
authored
Adding tutorial links for blitting in widgets (#21494)
Adding tutorial links for blitting in widgets.py
2 parents b09aad2 + adcab6d commit 750916f

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

lib/matplotlib/widgets.py

Lines changed: 17 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,8 @@ 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`
1692+
for details.
16901693
16911694
horizOn : bool, default: False
16921695
Whether to draw the horizontal line.
@@ -2093,7 +2096,8 @@ def on_select(min: float, max: float) -> Any
20932096
20942097
useblit : bool, default: False
20952098
If True, use the backend-dependent blitting features for faster
2096-
canvas updates.
2099+
canvas updates. See the tutorial :doc:`/tutorials/advanced/blitting`
2100+
for details.
20972101
20982102
props : dict, optional
20992103
Dictionary of `matplotlib.patches.Patch` properties.
@@ -2502,7 +2506,8 @@ class ToolLineHandles:
25022506
Additional line properties. See `matplotlib.lines.Line2D`.
25032507
useblit : bool, default: True
25042508
Whether to use blitting for faster drawing (if supported by the
2505-
backend).
2509+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
2510+
for details.
25062511
"""
25072512

25082513
def __init__(self, ax, positions, direction, line_props=None,
@@ -2609,7 +2614,8 @@ class ToolHandles:
26092614
Additional marker properties. See `matplotlib.lines.Line2D`.
26102615
useblit : bool, default: True
26112616
Whether to use blitting for faster drawing (if supported by the
2612-
backend).
2617+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
2618+
for details.
26132619
"""
26142620

26152621
def __init__(self, ax, x, y, marker='o', marker_props=None, useblit=True):
@@ -2684,7 +2690,8 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
26842690
26852691
useblit : bool, default: False
26862692
Whether to use blitting for faster drawing (if supported by the
2687-
backend).
2693+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
2694+
for details.
26882695
26892696
props : dict, optional
26902697
Properties with which the __ARTIST_NAME__ is drawn. See
@@ -3240,7 +3247,8 @@ def onselect(verts):
32403247
passed the vertices of the selected path.
32413248
useblit : bool, default: True
32423249
Whether to use blitting for faster drawing (if supported by the
3243-
backend).
3250+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3251+
for details.
32443252
props : dict, optional
32453253
Properties with which the line is drawn, see `matplotlib.lines.Line2D`
32463254
for valid properties. Default values are defined in ``mpl.rcParams``.
@@ -3322,7 +3330,8 @@ class PolygonSelector(_SelectorWidget):
33223330
33233331
useblit : bool, default: False
33243332
Whether to use blitting for faster drawing (if supported by the
3325-
backend).
3333+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3334+
for details.
33263335
33273336
props : dict, optional
33283337
Properties with which the line is drawn, see `matplotlib.lines.Line2D`
@@ -3589,7 +3598,8 @@ class Lasso(AxesWidget):
35893598
Coordinates of the start of the lasso.
35903599
useblit : bool, default: True
35913600
Whether to use blitting for faster drawing (if supported by the
3592-
backend).
3601+
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3602+
for details.
35933603
callback : callable
35943604
Whenever the lasso is released, the *callback* function is called and
35953605
passed the vertices of the selected path.

0 commit comments

Comments
 (0)
0