8000 Better document the relation between figure and manager · matplotlib/matplotlib@585bdce · GitHub
[go: up one dir, main page]

Skip to content

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 585bdce

Browse files
committed
Better document the relation between figure and manager
Closes #27774.
1 parent d2cc4d0 commit 585bdce

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

lib/matplotlib/backend_bases.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2607,9 +2607,13 @@ class FigureManagerBase:
26072607
backend-independent way. It's an adapter for the real (GUI) framework that
26082608
represents the visual figure on screen.
26092609
2610-
GUI backends define from this class to translate common operations such
2610+
The figure manager is connected to a specific canvas instance, which in turn
2611+
is connected to a specific figure instance. To access a figure manager for
2612+
a given figure in user code, you typically use ``fig.canvas.manager``.
2613+
2614+
GUI backends derive from this class to translate common operations such
26112615
as *show* or *resize* to the GUI-specific code. Non-GUI backends do not
2612-
support these operations an can just use the base class.
2616+
support these operations and can just use the base class.
26132617
26142618
This following basic operations are accessible:
26152619
@@ -2794,6 +2798,11 @@ def set_window_title(self, title):
27942798
Set the title text of the window containing the figure.
27952799
27962800
This has no effect for non-GUI (e.g., PS) backends.
2801+
2802+
Examples
2803+
--------
2804+
>>> fig = plt.figure()
2805+
>>> fig.canvas.manager.set_window_title('My figure')
27972806
"""
27982807

27992808

0 commit comments

Comments
 (0)
0