matplotlib.axes.Axes.can_pan() in Python

Matplotlib is a library in Python and it is numerical – mathematical extension for NumPy library. The Axes Class contains most of the figure elements: Axis, Tick, Line2D, Text, Polygon, etc., and sets the coordinate system. And the instances of Axes supports callbacks through a callbacks attribute.

matplotlib.axes.Axes.can_pan() Function

The Axes.can_pan() Function in axes module of matplotlib library is used to check whether the axes supports any pan/zoom button functionality or not.

Syntax: Axes.can_pan(self)

Parameters: This method does not accept any parameters.

Return value: This method returns boolean value True if supports any pan/zoom button functionality.

Below examples illustrate the matplotlib.axes.Axes.can_pan() function in matplotlib.axes:
Example 1:

# Implementation of matplotlib function
import matplotlib.pyplot as plt
import numpy as np


fig, ax = plt.subplots()
ax.plot([1, 2, 3])

w = ax.can_pan()
# print(w)

ax.text(0.4, 2.75, "Value return by can_pan() function:",
        fontweight ="bold")
ax.text(0.9, 2.6, w, fontweight ="bold")

fig.suptitle('matplotlib.axes.Axes.can_pan() function \
Example\n\n', fontweight ="bold")

plt.show()

Output:

Example 2:

# Implementation of matplotlib function
import numpy as np
import matplotlib.pyplot as plt
from matplotlib.widgets import Slider, Button, RadioButtons

fig, ax1 = plt.subplots()
plt.subplots_adjust(bottom = 0.25)
t = np.arange(0.0, 1.0, 0.001)
a0 = 5
f0 = 3
delta_f = 5.0
s = a0 * np.sin(2 * np.pi * f0 * t)

ax1.plot(t, s, lw = 2, color = 'green')
ax1.set_ymargin(0.5)

w = ax1.can_pan()

ax1.text(0.2, 7.5, "Value return by can_pan() function:",
         fontweight ="bold")
ax1.text(0.47, 5.6, w, fontweight ="bold")

fig.suptitle('matplotlib.axes.Axes.can_pan() function\
 Example\n\n', fontweight ="bold")

plt.show()

Output: