Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1ec61c9

Browse files
committed
DOC [ci doc]
1 parent 97cfe9d commit 1ec61c9

File tree

5 files changed

+27
-15
lines changed

5 files changed

+27
-15
lines changed

doc/api/figure_api.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,18 @@ Modifying appearance
296296
SubFigure.set_edgecolor
297297
SubFigure.get_edgecolor
298298

299+
Passthroughs
300+
------------
301+
302+
.. autosummary::
303+
:toctree: _as_gen
304+
:template: autosummary.rst
305+
:nosignatures:
306+
307+
SubFigure.set_dpi
308+
SubFigure.get_dpi
309+
310+
299311
Helper classes
300312
==============
301313

doc/api/prev_api_changes/api_changes_3.4.2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Behaviour changes
77
Rename first argument to ``subplot_mosaic``
88
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99

10-
Both `.FigureBase.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
10+
Both `.Figure.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
1111
first position argument renamed from *layout* to *mosaic*. This is because we
1212
are considering to consolidate *constrained_layout* and *tight_layout* keyword
1313
arguments in the Figure creation functions of `.pyplot` into a single *layout*

doc/api/prev_api_changes/api_changes_3.5.0/behaviour.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Behaviour changes
44
First argument to ``subplot_mosaic`` renamed
55
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66

7-
Both `.FigureBase.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
7+
Both `.Figure.subplot_mosaic`, and `.pyplot.subplot_mosaic` have had the
88
first positional argument renamed from *layout* to *mosaic*. As we have
99
consolidated the *constrained_layout* and *tight_layout* keyword arguments in
1010
the Figure creation functions of `.pyplot` into a single *layout* keyword

galleries/examples/subplots_axes_and_figures/figure_title.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
66
Each axes can have a title (or actually three - one each with *loc* "left",
77
"center", and "right"), but is sometimes desirable to give a whole figure
8-
(or `.SubFigure`) an overall title, using `.FigureBase.suptitle`.
8+
(or `.SubFigure`) an overall title, using `.Figure.suptitle`.
99
10-
We can also add figure-level x- and y-labels using `.FigureBase.supxlabel` and
11-
`.FigureBase.supylabel`.
10+
We can also add figure-level x- and y-labels using `.Figure.supxlabel` and
11+
`.Figure.supylabel`.
1212
"""
1313

1414
import matplotlib.pyplot as plt
@@ -31,8 +31,8 @@
3131
fig.suptitle('Different types of oscillations', fontsize=16)
3232

3333
# %%
34-
# A global x- or y-label can be set using the `.FigureBase.supxlabel` and
35-
# `.FigureBase.supylabel` methods.
34+
# A global x- or y-label can be set using the `.Figure.supxlabel` and
35+
# `.Figure.supylabel` methods.
3636

3737

3838
with get_sample_data('Stocks.csv') as file:

galleries/users_explain/figure/figure_intro.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -197,15 +197,15 @@ common cases.
197197
Adding Artists
198198
--------------
199199

200-
The `~.FigureBase` class has a number of methods to add artists to a `~.Figure` or
200+
The `~.Figure` class has a number of methods to add artists to a `~.Figure` or
201201
a `~.SubFigure`. By far the most common are to add Axes of various configurations
202-
(`~.FigureBase.add_axes`, `~.FigureBase.add_subplot`, `~.FigureBase.subplots`,
203-
`~.FigureBase.subplot_mosaic`) and subfigures (`~.FigureBase.subfigures`). Colorbars
204-
are added to Axes or group of Axes at the Figure level (`~.FigureBase.colorbar`).
205-
It is also possible to have a Figure-level legend (`~.FigureBase.legend`).
206-
Other Artists include figure-wide labels (`~.FigureBase.suptitle`,
207-
`~.FigureBase.supxlabel`, `~.FigureBase.supylabel`) and text (`~.FigureBase.text`).
208-
Finally, low-level Artists can be added directly using `~.FigureBase.add_artist`
202+
(`~.Figure.add_axes`, `~.Figure.add_subplot`, `~.Figure.subplots`,
203+
`~.Figure.subplot_mosaic`) and subfigures (`~.Figure.subfigures`). Colorbars
204+
are added to Axes or group of Axes at the Figure level (`~.Figure.colorbar`).
205+
It is also possible to have a Figure-level legend (`~.Figure.legend`).
206+
Other Artists include figure-wide labels (`~.Figure.suptitle`,
207+
`~.Figure.supxlabel`, `~.Figure.supylabel`) and text (`~.Figure.text`).
208+
Finally, low-level Artists can be added directly using `~.Figure.add_artist`
209209
usually with care being taken to use the appropriate transform. Usually these
210210
include ``Figure.transFigure`` which ranges from 0 to 1 in each direction, and
211211
represents the fraction of the current Figure size, or ``Figure.dpi_scale_trans``

0 commit comments

Comments
 (0)