Skip to content

Commit af3a97e

Browse files
committed
add note on what's considered a "visible patch" to the example
1 parent fa8e7e4 commit af3a97e

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

galleries/examples/showcase/pan_zoom_overlap.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,20 @@
1313
- Shared axes always trigger with their parent axes
1414
(irrespective of the patch visibility)
1515
16+
Note: The visibility of the patch hereby refers to the value of
17+
``ax.patch.get_visible()``. The color and transparency of a
18+
patch have no effect on the treatment of pan/zoom events!
19+
1620
1721
``ax.set_forward_navigation_events(val)`` can be used to override the
1822
default behaviour:
1923
2024
- ``True``: Forward navigation events to axes below.
2125
- ``False``: Execute navigation events only on this axes.
22-
- ``"auto"``: Use the default behaviour
23-
(``True`` for axes with an invisible patch and ``False`` otherwise).
26+
- ``"auto"``: Use the default behaviour.
2427
2528
To disable pan/zoom events completely, use ``ax.set_navigate(False)``
29+
2630
"""
2731

2832

0 commit comments

Comments
 (0)