Matplotlib.figure.Figure.get_frameon()

The get_frameon() method is used to get the current state of the figure's frame. A figure frame is a rectangular border that surrounds the figure's entire contents, including axis labels, title, and other elements.

import matplotlib.pyplot as plt

fig = plt.figure()
frame_on = fig.get_frameon()

Returns:

• frame_on (bool): Boolean value indicating if the figure frame is visible (True) or not (False).

Example:

import matplotlib.pyplot as plt

fig = plt.figure(frameon=False)

# Get the current frame status
frame_on = fig.get_frameon()
print(frame_on)  # Output: False

In this example, we create a new figure using plt.figure() and set the frameon parameter to False. This means that the figure will not have a visible frame. We then call the get_frameon() method to determine the current state of the figure's frame. The resulting value is False, indicating that the figure frame is not visible.

Remember that the default value for frameon is True, so if you do not explicitly set it to False, the figure will have a visible frame by default.