doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
matplotlib.axes.Axes.vlines Axes.vlines(x, ymin, ymax, colors=None, linestyles='solid', label='', *, data=None, **kwargs)[source]
Plot vertical lines at each x from ymin to ymax. Parameters
xfloat or array-like
x-indexes where to plot the lines.
ymin, ymaxfloat or array-like
Respective beginning and end of each line. If scalars are provided, all lines will have same length.
colorslist of colors, default: rcParams["lines.color"] (default: 'C0')
linestyles{'solid', 'dashed', 'dashdot', 'dotted'}, optional
labelstr, default: ''
Returns
LineCollection
Other Parameters
dataindexable object, optional
If given, the following parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception): x, ymin, ymax, colors
**kwargsLineCollection properties.
See also hlines
horizontal lines axvline
vertical line across the Axes
Examples using matplotlib.axes.Axes.vlines
Creating a timeline with lines, dates, and text
hlines and vlines
Violin plot customization | matplotlib._as_gen.matplotlib.axes.axes.vlines |
matplotlib.axes.Axes.xaxis_date Axes.xaxis_date(tz=None)[source]
Set up axis ticks and labels to treat data along the xaxis as dates. Parameters
tzstr or datetime.tzinfo, default: rcParams["timezone"] (default: 'UTC')
The timezone used to create date labels. | matplotlib._as_gen.matplotlib.axes.axes.xaxis_date |
matplotlib.axes.Axes.xaxis_inverted Axes.xaxis_inverted()[source]
Return whether the xaxis is oriented in the "inverse" direction. The "normal" direction is increasing to the right for the x-axis and to the top for the y-axis; the "inverse" direction is increasing to the left for the x-axis and to the bottom for the y-axis. | matplotlib._as_gen.matplotlib.axes.axes.xaxis_inverted |
matplotlib.axes.Axes.xcorr Axes.xcorr(x, y, normed=True, detrend=<function detrend_none>, usevlines=True, maxlags=10, *, data=None, **kwargs)[source]
Plot the cross correlation between x and y. The correlation with lag k is defined as \(\sum_n x[n+k] \cdot y^*[n]\), where \(y^*\) is the complex conjugate of \(y\). Parameters
x, yarray-like of length n
detrendcallable, default: mlab.detrend_none (no detrending)
A detrending function applied to x and y. It must have the signature detrend(x: np.ndarray) -> np.ndarray
normedbool, default: True
If True, input vectors are normalised to unit length.
usevlinesbool, default: True
Determines the plot style. If True, vertical lines are plotted from 0 to the xcorr value using Axes.vlines. Additionally, a horizontal line is plotted at y=0 using Axes.axhline. If False, markers are plotted at the xcorr values using Axes.plot.
maxlagsint, default: 10
Number of lags to show. If None, will return all 2 * len(x) - 1 lags. Returns
lagsarray (length 2*maxlags+1)
The lag vector.
carray (length 2*maxlags+1)
The auto correlation vector.
lineLineCollection or Line2D
Artist added to the Axes of the correlation:
LineCollection if usevlines is True.
Line2D if usevlines is False.
bLine2D or None
Horizontal line at 0 if usevlines is True None usevlines is False. Other Parameters
linestyleLine2D property, optional
The linestyle for plotting the data points. Only used if usevlines is False.
markerstr, default: 'o'
The marker for plotting the data points. Only used if usevlines is False.
dataindexable object, optional
If given, the following parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception): x, y **kwargs
Additional parameters are passed to Axes.vlines and Axes.axhline if usevlines is True; otherwise they are passed to Axes.plot. Notes The cross correlation is performed with numpy.correlate with mode = "full".
Examples using matplotlib.axes.Axes.xcorr
Cross- and Auto-Correlation Demo | matplotlib._as_gen.matplotlib.axes.axes.xcorr |
matplotlib.axes.Axes.yaxis_date Axes.yaxis_date(tz=None)[source]
Set up axis ticks and labels to treat data along the yaxis as dates. Parameters
tzstr or datetime.tzinfo, default: rcParams["timezone"] (default: 'UTC')
The timezone used to create date labels. | matplotlib._as_gen.matplotlib.axes.axes.yaxis_date |
matplotlib.axes.Axes.yaxis_inverted Axes.yaxis_inverted()[source]
Return whether the yaxis is oriented in the "inverse" direction. The "normal" direction is increasing to the right for the x-axis and to the top for the y-axis; the "inverse" direction is increasing to the left for the x-axis and to the bottom for the y-axis. | matplotlib._as_gen.matplotlib.axes.axes.yaxis_inverted |
matplotlib.axes.Axes.zorder Axes.zorder=0 | matplotlib._as_gen.matplotlib.axes.axes.zorder |
matplotlib.axes.subplot_class_factory matplotlib.axes.subplot_class_factory(axes_class)[source] | matplotlib._as_gen.matplotlib.axes.subplot_class_factory |
matplotlib.axes.SubplotBase classmatplotlib.axes.SubplotBase(fig, *args, **kwargs)[source]
Bases: object Base class for subplots, which are Axes instances with additional methods to facilitate generating and manipulating a set of Axes within a figure. Parameters
figmatplotlib.figure.Figure
*argstuple (nrows, ncols, index) or int
The array of subplots in the figure has dimensions (nrows,
ncols), and index is the index of the subplot being created. index starts at 1 in the upper left corner and increases to the right. If nrows, ncols, and index are all single digit numbers, then args can be passed as a single 3-digit number (e.g. 234 for (2, 3, 4)). **kwargs
Keyword arguments are passed to the Axes (sub)class constructor. change_geometry(numrows, numcols, num)[source]
[Deprecated] Change subplot geometry, e.g., from (1, 1, 1) to (2, 2, 3). Notes Deprecated since version 3.4.
propertyfigbox[source]
get_geometry()[source]
[Deprecated] Get the subplot geometry, e.g., (2, 2, 3). Notes Deprecated since version 3.4.
get_gridspec()[source]
Return the GridSpec instance associated with the subplot.
get_subplotspec()[source]
Return the SubplotSpec instance associated with the subplot.
is_first_col()[source]
[Deprecated] Notes Deprecated since version 3.4:
is_first_row()[source]
[Deprecated] Notes Deprecated since version 3.4:
is_last_col()[source]
[Deprecated] Notes Deprecated since version 3.4:
is_last_row()[source]
[Deprecated] Notes Deprecated since version 3.4:
label_outer()[source]
Only show "outer" labels and tick labels. x-labels are only kept for subplots on the last row (or first row, if labels are on the top side); y-labels only for subplots on the first column (or last column, if labels are on the right side).
propertynumCols[source]
propertynumRows[source]
set_subplotspec(subplotspec)[source]
Set the SubplotSpec. instance associated with the subplot.
update_params()[source]
[Deprecated] Update the subplot position from self.figure.subplotpars. Notes Deprecated since version 3.4. | matplotlib._as_gen.matplotlib.axes.subplotbase |
change_geometry(numrows, numcols, num)[source]
[Deprecated] Change subplot geometry, e.g., from (1, 1, 1) to (2, 2, 3). Notes Deprecated since version 3.4. | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.change_geometry |
get_geometry()[source]
[Deprecated] Get the subplot geometry, e.g., (2, 2, 3). Notes Deprecated since version 3.4. | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.get_geometry |
get_gridspec()[source]
Return the GridSpec instance associated with the subplot. | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.get_gridspec |
get_subplotspec()[source]
Return the SubplotSpec instance associated with the subplot. | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.get_subplotspec |
is_first_col()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.is_first_col |
is_first_row()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.is_first_row |
is_last_col()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.is_last_col |
is_last_row()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.is_last_row |
label_outer()[source]
Only show "outer" labels and tick labels. x-labels are only kept for subplots on the last row (or first row, if labels are on the top side); y-labels only for subplots on the first column (or last column, if labels are on the right side). | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.label_outer |
set_subplotspec(subplotspec)[source]
Set the SubplotSpec. instance associated with the subplot. | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.set_subplotspec |
update_params()[source]
[Deprecated] Update the subplot position from self.figure.subplotpars. Notes Deprecated since version 3.4. | matplotlib._as_gen.matplotlib.axes.subplotbase#matplotlib.axes.SubplotBase.update_params |
mpl_toolkits.axes_grid Note AxesGrid has been a part of matplotlib since v 0.99. Originally, the toolkit used the axes_grid namespace. In more recent versions, the toolkit has been split into axes_grid1 and axisartist. While axes_grid is maintained for the backward compatibility, use of axes_grid1 and axisartist is recommended. For the documentation on axes_grid, see the previous version of the docs. mpl_toolkits.axes_grid1 mpl_toolkits.axisartist | matplotlib.toolkits.axes_grid |
mpl_toolkits.axes_grid1 mpl_toolkits.axes_grid1 provides a framework of helper classes to adjust the positioning of multiple fixed-aspect Axes (e.g., displaying images). It can be contrasted with the aspect property of Matplotlib Axes, which adjusts the position of a single Axes. See Overview of mpl_toolkits.axes_grid1 for a guide on the usage of axes_grid1. The submodules of the axes_grid1 API are:
axes_grid1.anchored_artists
axes_grid1.axes_divider Helper classes to adjust the positions of multiple axes at drawing time.
axes_grid1.axes_grid
axes_grid1.axes_rgb
axes_grid1.axes_size Provides classes of simple units that will be used with AxesDivider class (or others) to determine the size of each axes.
axes_grid1.inset_locator A collection of functions and objects for creating or placing inset axes.
axes_grid1.mpl_axes
axes_grid1.parasite_axes | matplotlib.toolkits.axes_grid1 |
mpl_toolkits.axes_grid1.anchored_artists Classes
AnchoredAuxTransformBox(transform, loc[, ...]) An anchored container with transformed coordinates.
AnchoredDirectionArrows(transform, label_x, ...) Draw two perpendicular arrows to indicate directions.
AnchoredDrawingArea(width, height, xdescent, ...) An anchored container with a fixed size and fillable DrawingArea.
AnchoredEllipse(transform, width, height, ...) Draw an anchored ellipse of a given size.
AnchoredSizeBar(transform, size, label, loc) Draw a horizontal scale bar with a center-aligned label underneath. | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists |
mpl_toolkits.axes_grid1.anchored_artists.AnchoredAuxTransformBox classmpl_toolkits.axes_grid1.anchored_artists.AnchoredAuxTransformBox(transform, loc, pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs)[source]
Bases: matplotlib.offsetbox.AnchoredOffsetbox An anchored container with transformed coordinates. Artists added to the drawing_area are scaled according to the coordinates of the transformation used. The dimensions of this artist will scale to contain the artists added. Parameters
transformmatplotlib.transforms.Transform
The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transData.
locstr
Location of this artist. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.
padfloat, default: 0.4
Padding around the child objects, in fraction of the font size.
borderpadfloat, default: 0.5
Border padding, in fraction of the font size.
propmatplotlib.font_manager.FontProperties, optional
Font property used as a reference for paddings.
frameonbool, default: True
If True, draw a box around this artists. **kwargs
Keyword arguments forwarded to AnchoredOffsetbox. Examples To display an ellipse in the upper left, with a width of 0.1 and height of 0.4 in data coordinates: >>> box = AnchoredAuxTransformBox(ax.transData, loc='upper left')
>>> el = Ellipse((0, 0), width=0.1, height=0.4, angle=30)
>>> box.drawing_area.add_artist(el)
>>> ax.add_artist(box)
Attributes
drawing_areamatplotlib.offsetbox.AuxTransformBox
A container for artists to display. set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float
Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredAuxTransformBox
Annotations | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoredauxtransformbox |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoredauxtransformbox#mpl_toolkits.axes_grid1.anchored_artists.AnchoredAuxTransformBox.set |
mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows classmpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows(transform, label_x, label_y, length=0.15, fontsize=0.08, loc='upper left', angle=0, aspect_ratio=1, pad=0.4, borderpad=0.4, frameon=False, color='w', alpha=1, sep_x=0.01, sep_y=0, fontproperties=None, back_length=0.15, head_width=10, head_length=15, tail_width=2, text_props=None, arrow_props=None, **kwargs)[source]
Bases: matplotlib.offsetbox.AnchoredOffsetbox Draw two perpendicular arrows to indicate directions. Parameters
transformmatplotlib.transforms.Transform
The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transAxes.
label_x, label_ystr
Label text for the x and y arrows
lengthfloat, default: 0.15
Length of the arrow, given in coordinates of transform.
fontsizefloat, default: 0.08
Size of label strings, given in coordinates of transform.
locstr, default: 'upper left'
Location of this ellipse. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.
anglefloat, default: 0
The angle of the arrows in degrees.
aspect_ratiofloat, default: 1
The ratio of the length of arrow_x and arrow_y. Negative numbers can be used to change the direction.
padfloat, default: 0.4
Padding around the labels and arrows, in fraction of the font size.
borderpadfloat, default: 0.4
Border padding, in fraction of the font size.
frameonbool, default: False
If True, draw a box around the arrows and labels.
colorstr, default: 'white'
Color for the arrows and labels.
alphafloat, default: 1
Alpha values of the arrows and labels
sep_x, sep_yfloat, default: 0.01 and 0 respectively
Separation between the arrows and labels in coordinates of transform.
fontpropertiesmatplotlib.font_manager.FontProperties, optional
Font properties for the label text.
back_lengthfloat, default: 0.15
Fraction of the arrow behind the arrow crossing.
head_widthfloat, default: 10
Width of arrow head, sent to ArrowStyle.
head_lengthfloat, default: 15
Length of arrow head, sent to ArrowStyle.
tail_widthfloat, default: 2
Width of arrow tail, sent to ArrowStyle.
text_props, arrow_propsdict
Properties of the text and arrows, passed to textpath.TextPath and patches.FancyArrowPatch. **kwargs
Keyword arguments forwarded to AnchoredOffsetbox. Notes If prop is passed as a keyword argument, but fontproperties is not, then prop is be assumed to be the intended fontproperties. Using both prop and fontproperties is not supported. Examples >>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import (
... AnchoredDirectionArrows)
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10, 10)))
>>> arrows = AnchoredDirectionArrows(ax.transAxes, '111', '110')
>>> ax.add_artist(arrows)
>>> fig.show()
Using several of the optional parameters, creating downward pointing arrow and high contrast text labels. >>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(family='monospace')
>>> arrows = AnchoredDirectionArrows(ax.transAxes, 'East', 'South',
... loc='lower left', color='k',
... aspect_ratio=-1, sep_x=0.02,
... sep_y=-0.01,
... text_props={'ec':'w', 'fc':'k'},
... fontproperties=fontprops)
Attributes
arrow_x, arrow_ymatplotlib.patches.FancyArrowPatch
Arrow x and y
text_path_x, text_path_ymatplotlib.textpath.TextPath
Path for arrow labels
p_x, p_ymatplotlib.patches.PathPatch
Patch for arrow labels
boxmatplotlib.offsetbox.AuxTransformBox
Container for the arrows and labels. set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float
Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows
Anchored Direction Arrow | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoreddirectionarrows |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoreddirectionarrows#mpl_toolkits.axes_grid1.anchored_artists.AnchoredDirectionArrows.set |
mpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea classmpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea(width, height, xdescent, ydescent, loc, pad=0.4, borderpad=0.5, prop=None, frameon=True, **kwargs)[source]
Bases: matplotlib.offsetbox.AnchoredOffsetbox An anchored container with a fixed size and fillable DrawingArea. Artists added to the drawing_area will have their coordinates interpreted as pixels. Any transformations set on the artists will be overridden. Parameters
width, heightfloat
width and height of the container, in pixels.
xdescent, ydescentfloat
descent of the container in the x- and y- direction, in pixels.
locstr
Location of this artist. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.
padfloat, default: 0.4
Padding around the child objects, in fraction of the font size.
borderpadfloat, default: 0.5
Border padding, in fraction of the font size.
propmatplotlib.font_manager.FontProperties, optional
Font property used as a reference for paddings.
frameonbool, default: True
If True, draw a box around this artists. **kwargs
Keyword arguments forwarded to AnchoredOffsetbox. Examples To display blue and red circles of different sizes in the upper right of an axes ax: >>> ada = AnchoredDrawingArea(20, 20, 0, 0,
... loc='upper right', frameon=False)
>>> ada.drawing_area.add_artist(Circle((10, 10), 10, fc="b"))
>>> ada.drawing_area.add_artist(Circle((30, 10), 5, fc="r"))
>>> ax.add_artist(ada)
Attributes
drawing_areamatplotlib.offsetbox.DrawingArea
A container for artists to display. set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float
Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea
Simple Anchored Artists
Annotations | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoreddrawingarea |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoreddrawingarea#mpl_toolkits.axes_grid1.anchored_artists.AnchoredDrawingArea.set |
mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse classmpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse(transform, width, height, angle, loc, pad=0.1, borderpad=0.1, prop=None, frameon=True, **kwargs)[source]
Bases: matplotlib.offsetbox.AnchoredOffsetbox Draw an anchored ellipse of a given size. Parameters
transformmatplotlib.transforms.Transform
The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transData.
width, heightfloat
Width and height of the ellipse, given in coordinates of transform.
anglefloat
Rotation of the ellipse, in degrees, anti-clockwise.
locstr
Location of this ellipse. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.
padfloat, default: 0.1
Padding around the ellipse, in fraction of the font size.
borderpadfloat, default: 0.1
Border padding, in fraction of the font size.
frameonbool, default: True
If True, draw a box around the ellipse.
propmatplotlib.font_manager.FontProperties, optional
Font property used as a reference for paddings. **kwargs
Keyword arguments forwarded to AnchoredOffsetbox. Attributes
ellipsematplotlib.patches.Ellipse
Ellipse patch drawn. set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float
Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse
Simple Anchored Artists | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoredellipse |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoredellipse#mpl_toolkits.axes_grid1.anchored_artists.AnchoredEllipse.set |
mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar classmpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar(transform, size, label, loc, pad=0.1, borderpad=0.1, sep=2, frameon=True, size_vertical=0, color='black', label_top=False, fontproperties=None, fill_bar=None, **kwargs)[source]
Bases: matplotlib.offsetbox.AnchoredOffsetbox Draw a horizontal scale bar with a center-aligned label underneath. Parameters
transformmatplotlib.transforms.Transform
The transformation object for the coordinate system in use, i.e., matplotlib.axes.Axes.transData.
sizefloat
Horizontal length of the size bar, given in coordinates of transform.
labelstr
Label to display.
locstr
Location of this ellipse. Valid locations are 'upper left', 'upper center', 'upper right', 'center left', 'center', 'center right', 'lower left', 'lower center, 'lower right'. For backward compatibility, numeric values are accepted as well. See the parameter loc of Legend for details.
padfloat, default: 0.1
Padding around the label and size bar, in fraction of the font size.
borderpadfloat, default: 0.1
Border padding, in fraction of the font size.
sepfloat, default: 2
Separation between the label and the size bar, in points.
frameonbool, default: True
If True, draw a box around the horizontal bar and label.
size_verticalfloat, default: 0
Vertical length of the size bar, given in coordinates of transform.
colorstr, default: 'black'
Color for the size bar and label.
label_topbool, default: False
If True, the label will be over the size bar.
fontpropertiesmatplotlib.font_manager.FontProperties, optional
Font properties for the label text.
fill_barbool, optional
If True and if size_vertical is nonzero, the size bar will be filled in with the color specified by the size bar. Defaults to True if size_vertical is greater than zero and False otherwise. **kwargs
Keyword arguments forwarded to AnchoredOffsetbox. Notes If prop is passed as a keyword argument, but fontproperties is not, then prop is be assumed to be the intended fontproperties. Using both prop and fontproperties is not supported. Examples >>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> from mpl_toolkits.axes_grid1.anchored_artists import (
... AnchoredSizeBar)
>>> fig, ax = plt.subplots()
>>> ax.imshow(np.random.random((10, 10)))
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 data units', 4)
>>> ax.add_artist(bar)
>>> fig.show()
Using all the optional parameters >>> import matplotlib.font_manager as fm
>>> fontprops = fm.FontProperties(size=14, family='monospace')
>>> bar = AnchoredSizeBar(ax.transData, 3, '3 units', 4, pad=0.5,
... sep=5, borderpad=0.5, frameon=False,
... size_vertical=0.5, color='white',
... fontproperties=fontprops)
Attributes
size_barmatplotlib.offsetbox.AuxTransformBox
Container for the size bar.
txt_labelmatplotlib.offsetbox.TextArea
Container for the label of the size bar. set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float
Examples using mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar
Inset Locator Demo2
Simple Anchored Artists | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoredsizebar |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, child=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, gid=<UNSET>, height=<UNSET>, in_layout=<UNSET>, label=<UNSET>, offset=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, width=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor unknown
child unknown
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
figure Figure
gid str
height float
in_layout bool
label object
offset (float, float) or callable
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width float
zorder float | matplotlib._as_gen.mpl_toolkits.axes_grid1.anchored_artists.anchoredsizebar#mpl_toolkits.axes_grid1.anchored_artists.AnchoredSizeBar.set |
mpl_toolkits.axes_grid1.axes_divider Helper classes to adjust the positions of multiple axes at drawing time. Classes
AxesDivider(axes[, xref, yref]) Divider based on the pre-existing axes.
AxesLocator(axes_divider, nx, ny[, nx1, ny1]) A callable object which returns the position and size of a given AxesDivider cell.
Divider(fig, pos, horizontal, vertical[, ...]) An Axes positioning class.
HBoxDivider(fig, *args[, horizontal, ...]) A SubplotDivider for laying out axes horizontally, while ensuring that they have equal heights.
SubplotDivider(fig, *args[, horizontal, ...]) The Divider class whose rectangle area is specified as a subplot geometry.
VBoxDivider(fig, *args[, horizontal, ...]) A SubplotDivider for laying out axes vertically, while ensuring that they have equal widths. Functions
make_axes_area_auto_adjustable(ax[, ...])
make_axes_locatable(axes) | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider |
mpl_toolkits.axes_grid1.axes_divider.AxesDivider classmpl_toolkits.axes_grid1.axes_divider.AxesDivider(axes, xref=None, yref=None)[source]
Bases: mpl_toolkits.axes_grid1.axes_divider.Divider Divider based on the pre-existing axes. Parameters
axesAxes
xref
yref
append_axes(position, size, pad=None, add_to_figure=<deprecated parameter>, **kwargs)[source]
Create an axes at the given position with the same height (or width) of the main axes. position
["left"|"right"|"bottom"|"top"] size and pad should be axes_grid.axes_size compatible.
get_anchor()[source]
Return the anchor.
get_aspect()[source]
Return aspect.
get_position()[source]
Return the position of the rectangle.
get_subplotspec()[source]
new_horizontal(size, pad=None, pack_start=False, **kwargs)[source]
Add a new axes on the right (or left) side of the main axes. Parameters
sizeaxes_size or float or str
The axes width. float or str arguments are interpreted as axes_size.from_any(size, AxesX(<main_axes>)).
padaxes_size or float or str
Padding between the axes. float or str arguments are interpreted as axes_size.from_any(size, AxesX(<main_axes>)). Defaults to rcParams["figure.subplot.wspace"] (default: 0.2) times the main axes width.
pack_startbool
If False, the new axes is appended at the end of the list, i.e., it became the right-most axes. If True, it is inserted at the start of the list, and becomes the left-most axes. **kwargs
All extra keywords arguments are passed to the created axes. If axes_class is given, the new axes will be created as an instance of the given class. Otherwise, the same class of the main axes will be used.
new_vertical(size, pad=None, pack_start=False, **kwargs)[source]
Add a new axes on the top (or bottom) side of the main axes. Parameters
sizeaxes_size or float or str
The axes height. float or str arguments are interpreted as axes_size.from_any(size, AxesY(<main_axes>)).
padaxes_size or float or str
Padding between the axes. float or str arguments are interpreted as axes_size.from_any(size, AxesY(<main_axes>)). Defaults to rcParams["figure.subplot.hspace"] (default: 0.2) times the main axes height.
pack_startbool
If False, the new axes is appended at the end of the list, i.e., it became the right-most axes. If True, it is inserted at the start of the list, and becomes the left-most axes. **kwargs
All extra keywords arguments are passed to the created axes. If axes_class is given, the new axes will be created as an instance of the given class. Otherwise, the same class of the main axes will be used.
Examples using mpl_toolkits.axes_grid1.axes_divider.AxesDivider
Colorbar with AxesDivider
Make Room For Ylabel Using Axesgrid
Scatter Histogram (Locatable Axes)
Simple Colorbar
Tight Layout guide | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider |
append_axes(position, size, pad=None, add_to_figure=<deprecated parameter>, **kwargs)[source]
Create an axes at the given position with the same height (or width) of the main axes. position
["left"|"right"|"bottom"|"top"] size and pad should be axes_grid.axes_size compatible. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider#mpl_toolkits.axes_grid1.axes_divider.AxesDivider.append_axes |
get_anchor()[source]
Return the anchor. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider#mpl_toolkits.axes_grid1.axes_divider.AxesDivider.get_anchor |
get_aspect()[source]
Return aspect. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider#mpl_toolkits.axes_grid1.axes_divider.AxesDivider.get_aspect |
get_position()[source]
Return the position of the rectangle. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider#mpl_toolkits.axes_grid1.axes_divider.AxesDivider.get_position |
get_subplotspec()[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider#mpl_toolkits.axes_grid1.axes_divider.AxesDivider.get_subplotspec |
new_horizontal(size, pad=None, pack_start=False, **kwargs)[source]
Add a new axes on the right (or left) side of the main axes. Parameters
sizeaxes_size or float or str
The axes width. float or str arguments are interpreted as axes_size.from_any(size, AxesX(<main_axes>)).
padaxes_size or float or str
Padding between the axes. float or str arguments are interpreted as axes_size.from_any(size, AxesX(<main_axes>)). Defaults to rcParams["figure.subplot.wspace"] (default: 0.2) times the main axes width.
pack_startbool
If False, the new axes is appended at the end of the list, i.e., it became the right-most axes. If True, it is inserted at the start of the list, and becomes the left-most axes. **kwargs
All extra keywords arguments are passed to the created axes. If axes_class is given, the new axes will be created as an instance of the given class. Otherwise, the same class of the main axes will be used. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider#mpl_toolkits.axes_grid1.axes_divider.AxesDivider.new_horizontal |
new_vertical(size, pad=None, pack_start=False, **kwargs)[source]
Add a new axes on the top (or bottom) side of the main axes. Parameters
sizeaxes_size or float or str
The axes height. float or str arguments are interpreted as axes_size.from_any(size, AxesY(<main_axes>)).
padaxes_size or float or str
Padding between the axes. float or str arguments are interpreted as axes_size.from_any(size, AxesY(<main_axes>)). Defaults to rcParams["figure.subplot.hspace"] (default: 0.2) times the main axes height.
pack_startbool
If False, the new axes is appended at the end of the list, i.e., it became the right-most axes. If True, it is inserted at the start of the list, and becomes the left-most axes. **kwargs
All extra keywords arguments are passed to the created axes. If axes_class is given, the new axes will be created as an instance of the given class. Otherwise, the same class of the main axes will be used. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axesdivider#mpl_toolkits.axes_grid1.axes_divider.AxesDivider.new_vertical |
mpl_toolkits.axes_grid1.axes_divider.AxesLocator classmpl_toolkits.axes_grid1.axes_divider.AxesLocator(axes_divider, nx, ny, nx1=None, ny1=None)[source]
Bases: object A callable object which returns the position and size of a given AxesDivider cell. Parameters
axes_dividerAxesDivider
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. __call__(axes, renderer)[source]
Call self as a function.
get_subplotspec()[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axeslocator |
__call__(axes, renderer)[source]
Call self as a function. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axeslocator#mpl_toolkits.axes_grid1.axes_divider.AxesLocator.__call__ |
get_subplotspec()[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.axeslocator#mpl_toolkits.axes_grid1.axes_divider.AxesLocator.get_subplotspec |
mpl_toolkits.axes_grid1.axes_divider.Divider classmpl_toolkits.axes_grid1.axes_divider.Divider(fig, pos, horizontal, vertical, aspect=None, anchor='C')[source]
Bases: object An Axes positioning class. The divider is initialized with lists of horizontal and vertical sizes (mpl_toolkits.axes_grid1.axes_size) based on which a given rectangular area will be divided. The new_locator method then creates a callable object that can be used as the axes_locator of the axes. Parameters
figFigure
postuple of 4 floats
Position of the rectangle that will be divided.
horizontallist of axes_size
Sizes for horizontal division.
verticallist of axes_size
Sizes for vertical division.
aspectbool
Whether overall rectangular area is reduced so that the relative part of the horizontal and vertical scales have the same scale.
anchor{'C', 'SW', 'S', 'SE', 'E', 'NE', 'N', 'NW', 'W'}
Placement of the reduced rectangle, when aspect is True. add_auto_adjustable_area(use_axes, pad=0.1, adjust_dirs=None)[source]
append_size(position, size)[source]
get_anchor()[source]
Return the anchor.
get_aspect()[source]
Return aspect.
get_horizontal()[source]
Return horizontal sizes.
get_horizontal_sizes(renderer)[source]
get_locator()[source]
get_position()[source]
Return the position of the rectangle.
get_position_runtime(ax, renderer)[source]
get_vertical()[source]
Return vertical sizes.
get_vertical_sizes(renderer)[source]
get_vsize_hsize()[source]
[Deprecated] Notes Deprecated since version 3.5:
locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]
Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. axes
renderer
new_locator(nx, ny, nx1=None, ny1=None)[source]
Return a new AxesLocator for the specified cell. Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions.
set_anchor(anchor)[source]
Parameters
anchor(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
Either an (x, y) pair of relative coordinates (0 is left or bottom, 1 is right or top), 'C' (center), or a cardinal direction ('SW', southwest, is bottom left, etc.). See also Axes.set_anchor
set_aspect(aspect=False)[source]
Parameters
aspectbool
set_horizontal(h)[source]
Parameters
hlist of axes_size
sizes for horizontal division
set_locator(_locator)[source]
set_position(pos)[source]
Set the position of the rectangle. Parameters
postuple of 4 floats
position of the rectangle that will be divided
set_vertical(v)[source]
Parameters
vlist of axes_size
sizes for vertical division | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider |
add_auto_adjustable_area(use_axes, pad=0.1, adjust_dirs=None)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.add_auto_adjustable_area |
append_size(position, size)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.append_size |
get_anchor()[source]
Return the anchor. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_anchor |
get_aspect()[source]
Return aspect. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_aspect |
get_horizontal()[source]
Return horizontal sizes. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_horizontal |
get_horizontal_sizes(renderer)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_horizontal_sizes |
get_locator()[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_locator |
get_position()[source]
Return the position of the rectangle. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_position |
get_position_runtime(ax, renderer)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_position_runtime |
get_vertical()[source]
Return vertical sizes. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_vertical |
get_vertical_sizes(renderer)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_vertical_sizes |
get_vsize_hsize()[source]
[Deprecated] Notes Deprecated since version 3.5: | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.get_vsize_hsize |
locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]
Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. axes
renderer | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.locate |
new_locator(nx, ny, nx1=None, ny1=None)[source]
Return a new AxesLocator for the specified cell. Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.new_locator |
set_anchor(anchor)[source]
Parameters
anchor(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
Either an (x, y) pair of relative coordinates (0 is left or bottom, 1 is right or top), 'C' (center), or a cardinal direction ('SW', southwest, is bottom left, etc.). See also Axes.set_anchor | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.set_anchor |
set_aspect(aspect=False)[source]
Parameters
aspectbool | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.set_aspect |
set_horizontal(h)[source]
Parameters
hlist of axes_size
sizes for horizontal division | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.set_horizontal |
set_locator(_locator)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.set_locator |
set_position(pos)[source]
Set the position of the rectangle. Parameters
postuple of 4 floats
position of the rectangle that will be divided | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.set_position |
set_vertical(v)[source]
Parameters
vlist of axes_size
sizes for vertical division | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.divider#mpl_toolkits.axes_grid1.axes_divider.Divider.set_vertical |
mpl_toolkits.axes_grid1.axes_divider.HBoxDivider classmpl_toolkits.axes_grid1.axes_divider.HBoxDivider(fig, *args, horizontal=None, vertical=None, aspect=None, anchor='C')[source]
Bases: mpl_toolkits.axes_grid1.axes_divider.SubplotDivider A SubplotDivider for laying out axes horizontally, while ensuring that they have equal heights. Examples (Source code, png, pdf) Parameters
figmatplotlib.figure.Figure
*argstuple (nrows, ncols, index) or int
The array of subplots in the figure has dimensions (nrows,
ncols), and index is the index of the subplot being created. index starts at 1 in the upper left corner and increases to the right. If nrows, ncols, and index are all single digit numbers, then args can be passed as a single 3-digit number (e.g. 234 for (2, 3, 4)). locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]
Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. axes
renderer
new_locator(nx, nx1=None)[source]
Create a new AxesLocator for the specified cell. Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
Examples using mpl_toolkits.axes_grid1.axes_divider.HBoxDivider
HBoxDivider demo | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.hboxdivider |
locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]
Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. axes
renderer | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.hboxdivider#mpl_toolkits.axes_grid1.axes_divider.HBoxDivider.locate |
new_locator(nx, nx1=None)[source]
Create a new AxesLocator for the specified cell. Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.hboxdivider#mpl_toolkits.axes_grid1.axes_divider.HBoxDivider.new_locator |
mpl_toolkits.axes_grid1.axes_divider.make_axes_area_auto_adjustable mpl_toolkits.axes_grid1.axes_divider.make_axes_area_auto_adjustable(ax, use_axes=None, pad=0.1, adjust_dirs=None)[source]
Examples using mpl_toolkits.axes_grid1.axes_divider.make_axes_area_auto_adjustable
Make Room For Ylabel Using Axesgrid | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.make_axes_area_auto_adjustable |
mpl_toolkits.axes_grid1.axes_divider.make_axes_locatable mpl_toolkits.axes_grid1.axes_divider.make_axes_locatable(axes)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.make_axes_locatable |
mpl_toolkits.axes_grid1.axes_divider.SubplotDivider classmpl_toolkits.axes_grid1.axes_divider.SubplotDivider(fig, *args, horizontal=None, vertical=None, aspect=None, anchor='C')[source]
Bases: mpl_toolkits.axes_grid1.axes_divider.Divider The Divider class whose rectangle area is specified as a subplot geometry. Parameters
figmatplotlib.figure.Figure
*argstuple (nrows, ncols, index) or int
The array of subplots in the figure has dimensions (nrows,
ncols), and index is the index of the subplot being created. index starts at 1 in the upper left corner and increases to the right. If nrows, ncols, and index are all single digit numbers, then args can be passed as a single 3-digit number (e.g. 234 for (2, 3, 4)). change_geometry(numrows, numcols, num)[source]
[Deprecated] Change subplot geometry, e.g., from (1, 1, 1) to (2, 2, 3). Notes Deprecated since version 3.4.
propertyfigbox[source]
get_geometry()[source]
[Deprecated] Get the subplot geometry, e.g., (2, 2, 3). Notes Deprecated since version 3.4.
get_position()[source]
Return the bounds of the subplot box.
get_subplotspec()[source]
Get the SubplotSpec instance.
set_subplotspec(subplotspec)[source]
Set the SubplotSpec instance.
update_params()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.subplotdivider |
change_geometry(numrows, numcols, num)[source]
[Deprecated] Change subplot geometry, e.g., from (1, 1, 1) to (2, 2, 3). Notes Deprecated since version 3.4. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.subplotdivider#mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.change_geometry |
get_geometry()[source]
[Deprecated] Get the subplot geometry, e.g., (2, 2, 3). Notes Deprecated since version 3.4. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.subplotdivider#mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.get_geometry |
get_position()[source]
Return the bounds of the subplot box. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.subplotdivider#mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.get_position |
get_subplotspec()[source]
Get the SubplotSpec instance. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.subplotdivider#mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.get_subplotspec |
set_subplotspec(subplotspec)[source]
Set the SubplotSpec instance. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.subplotdivider#mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.set_subplotspec |
update_params()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.subplotdivider#mpl_toolkits.axes_grid1.axes_divider.SubplotDivider.update_params |
mpl_toolkits.axes_grid1.axes_divider.VBoxDivider classmpl_toolkits.axes_grid1.axes_divider.VBoxDivider(fig, *args, horizontal=None, vertical=None, aspect=None, anchor='C')[source]
Bases: mpl_toolkits.axes_grid1.axes_divider.SubplotDivider A SubplotDivider for laying out axes vertically, while ensuring that they have equal widths. Parameters
figmatplotlib.figure.Figure
*argstuple (nrows, ncols, index) or int
The array of subplots in the figure has dimensions (nrows,
ncols), and index is the index of the subplot being created. index starts at 1 in the upper left corner and increases to the right. If nrows, ncols, and index are all single digit numbers, then args can be passed as a single 3-digit number (e.g. 234 for (2, 3, 4)). locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]
Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. axes
renderer
new_locator(ny, ny1=None)[source]
Create a new AxesLocator for the specified cell. Parameters
ny, ny1int
Integers specifying the row-position of the cell. When ny1 is None, a single ny-th row is specified. Otherwise location of rows spanning between ny to ny1 (but excluding ny1-th row) is specified. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.vboxdivider |
locate(nx, ny, nx1=None, ny1=None, axes=None, renderer=None)[source]
Parameters
nx, nx1int
Integers specifying the column-position of the cell. When nx1 is None, a single nx-th column is specified. Otherwise location of columns spanning between nx to nx1 (but excluding nx1-th column) is specified.
ny, ny1int
Same as nx and nx1, but for row positions. axes
renderer | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.vboxdivider#mpl_toolkits.axes_grid1.axes_divider.VBoxDivider.locate |
new_locator(ny, ny1=None)[source]
Create a new AxesLocator for the specified cell. Parameters
ny, ny1int
Integers specifying the row-position of the cell. When ny1 is None, a single ny-th row is specified. Otherwise location of rows spanning between ny to ny1 (but excluding ny1-th row) is specified. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_divider.vboxdivider#mpl_toolkits.axes_grid1.axes_divider.VBoxDivider.new_locator |
mpl_toolkits.axes_grid1.axes_grid Classes
AxesGrid alias of mpl_toolkits.axes_grid1.axes_grid.ImageGrid
CbarAxes(*args, orientation, **kwargs) [Deprecated]
CbarAxesBase(*args, orientation, **kwargs)
Grid(fig, rect, nrows_ncols[, ngrids, ...]) A grid of Axes.
ImageGrid(fig, rect, nrows_ncols[, ngrids, ...])
Parameters | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid |
mpl_toolkits.axes_grid1.axes_grid.AxesGrid mpl_toolkits.axes_grid1.axes_grid.AxesGrid[source]
alias of mpl_toolkits.axes_grid1.axes_grid.ImageGrid | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.axesgrid |
mpl_toolkits.axes_grid1.axes_grid.CbarAxes classmpl_toolkits.axes_grid1.axes_grid.CbarAxes(*args, orientation, **kwargs)[source]
Bases: mpl_toolkits.axes_grid1.axes_grid.CbarAxesBase, mpl_toolkits.axes_grid1.mpl_axes.Axes [Deprecated] Notes Deprecated since version 3.5: Build an Axes in a figure. Parameters
figFigure
The Axes is built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built in the rectangle rect. rect is in Figure coordinates.
sharex, shareyAxes, optional
The x or y axis is shared with the x or y axis in the input Axes.
frameonbool, default: True
Whether the Axes frame is visible.
box_aspectfloat, optional
Set a fixed aspect for the Axes box, i.e. the ratio of height to width. See set_box_aspect for details. **kwargs
Other optional keyword arguments:
Property Description
adjustable {'box', 'datalim'}
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float Returns
Axes
The new Axes object. set(*, adjustable=<UNSET>, agg_filter=<UNSET>, alpha=<UNSET>, anchor=<UNSET>, animated=<UNSET>, aspect=<UNSET>, autoscale_on=<UNSET>, autoscalex_on=<UNSET>, autoscaley_on=<UNSET>, axes_locator=<UNSET>, axisbelow=<UNSET>, box_aspect=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, facecolor=<UNSET>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<UNSET>, ylabel=<UNSET>, ylim=<UNSET>, ymargin=<UNSET>, yscale=<UNSET>, yticklabels=<UNSET>, yticks=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
adjustable {'box', 'datalim'}
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.cbaraxes |
set(*, adjustable=<UNSET>, agg_filter=<UNSET>, alpha=<UNSET>, anchor=<UNSET>, animated=<UNSET>, aspect=<UNSET>, autoscale_on=<UNSET>, autoscalex_on=<UNSET>, autoscaley_on=<UNSET>, axes_locator=<UNSET>, axisbelow=<UNSET>, box_aspect=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, facecolor=<UNSET>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, navigate=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, prop_cycle=<UNSET>, rasterization_zorder=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xbound=<UNSET>, xlabel=<UNSET>, xlim=<UNSET>, xmargin=<UNSET>, xscale=<UNSET>, xticklabels=<UNSET>, xticks=<UNSET>, ybound=<UNSET>, ylabel=<UNSET>, ylim=<UNSET>, ymargin=<UNSET>, yscale=<UNSET>, yticklabels=<UNSET>, yticks=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
adjustable {'box', 'datalim'}
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
anchor (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
animated bool
aspect {'auto', 'equal'} or float
autoscale_on bool
autoscalex_on bool
autoscaley_on bool
axes_locator Callable[[Axes, Renderer], Bbox]
axisbelow bool or 'line'
box_aspect float or None
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
facecolor or fc color
figure Figure
frame_on bool
gid str
in_layout bool
label object
navigate bool
navigate_mode unknown
path_effects AbstractPathEffect
picker None or bool or float or callable
position [left, bottom, width, height] or Bbox
prop_cycle unknown
rasterization_zorder float or None
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
title str
transform Transform
url str
visible bool
xbound unknown
xlabel str
xlim (bottom: float, top: float)
xmargin float greater than -0.5
xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
xticklabels unknown
xticks unknown
ybound unknown
ylabel str
ylim (bottom: float, top: float)
ymargin float greater than -0.5
yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase
yticklabels unknown
yticks unknown
zorder float | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.cbaraxes#mpl_toolkits.axes_grid1.axes_grid.CbarAxes.set |
mpl_toolkits.axes_grid1.axes_grid.CbarAxesBase classmpl_toolkits.axes_grid1.axes_grid.CbarAxesBase(*args, orientation, **kwargs)[source]
Bases: object cla()[source]
colorbar(mappable, *, ticks=None, **kwargs)[source]
toggle_label(b)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.cbaraxesbase |
cla()[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.cbaraxesbase#mpl_toolkits.axes_grid1.axes_grid.CbarAxesBase.cla |
colorbar(mappable, *, ticks=None, **kwargs)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.cbaraxesbase#mpl_toolkits.axes_grid1.axes_grid.CbarAxesBase.colorbar |
toggle_label(b)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.cbaraxesbase#mpl_toolkits.axes_grid1.axes_grid.CbarAxesBase.toggle_label |
mpl_toolkits.axes_grid1.axes_grid.Grid classmpl_toolkits.axes_grid1.axes_grid.Grid(fig, rect, nrows_ncols, ngrids=None, direction='row', axes_pad=0.02, *, share_all=False, share_x=True, share_y=True, label_mode='L', axes_class=None, aspect=False)[source]
Bases: object A grid of Axes. In Matplotlib, the axes location (and size) is specified in normalized figure coordinates. This may not be ideal for images that needs to be displayed with a given aspect ratio; for example, it is difficult to display multiple images of a same size with some fixed padding between them. AxesGrid can be used in such case. Parameters
figFigure
The parent figure.
rect(float, float, float, float) or int
The axes position, as a (left, bottom, width, height) tuple or as a three-digit subplot position code (e.g., "121").
nrows_ncols(int, int)
Number of rows and columns in the grid.
ngridsint or None, default: None
If not None, only the first ngrids axes in the grid are created.
direction{"row", "column"}, default: "row"
Whether axes are created in row-major ("row by row") or column-major order ("column by column"). This also affects the order in which axes are accessed using indexing (grid[index]).
axes_padfloat or (float, float), default: 0.02
Padding or (horizontal padding, vertical padding) between axes, in inches.
share_allbool, default: False
Whether all axes share their x- and y-axis. Overrides share_x and share_y.
share_xbool, default: True
Whether all axes of a column share their x-axis.
share_ybool, default: True
Whether all axes of a row share their y-axis.
label_mode{"L", "1", "all"}, default: "L"
Determines which axes will get tick labels: "L": All axes on the left column get vertical tick labels; all axes on the bottom row get horizontal tick labels. "1": Only the bottom left axes is labelled. "all": all axes are labelled.
axes_classsubclass of matplotlib.axes.Axes, default: None
aspectbool, default: False
Whether the axes aspect ratio follows the aspect ratio of the data limits. get_aspect()[source]
Return the aspect of the SubplotDivider.
get_axes_locator()[source]
get_axes_pad()[source]
Return the axes padding. Returns
hpad, vpad
Padding (horizontal pad, vertical pad) in inches.
get_divider()[source]
get_geometry()[source]
Return the number of rows and columns of the grid as (nrows, ncols).
get_vsize_hsize()[source]
[Deprecated] Notes Deprecated since version 3.5:
set_aspect(aspect)[source]
Set the aspect of the SubplotDivider.
set_axes_locator(locator)[source]
set_axes_pad(axes_pad)[source]
Set the padding between the axes. Parameters
axes_pad(float, float)
The padding (horizontal pad, vertical pad) in inches.
set_label_mode(mode)[source]
Define which axes have tick labels. Parameters
mode{"L", "1", "all"}
The label mode: "L": All axes on the left column get vertical tick labels; all axes on the bottom row get horizontal tick labels. "1": Only the bottom left axes is labelled. "all": all axes are labelled. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid |
get_aspect()[source]
Return the aspect of the SubplotDivider. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.get_aspect |
get_axes_locator()[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.get_axes_locator |
get_axes_pad()[source]
Return the axes padding. Returns
hpad, vpad
Padding (horizontal pad, vertical pad) in inches. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.get_axes_pad |
get_divider()[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.get_divider |
get_geometry()[source]
Return the number of rows and columns of the grid as (nrows, ncols). | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.get_geometry |
get_vsize_hsize()[source]
[Deprecated] Notes Deprecated since version 3.5: | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.get_vsize_hsize |
set_aspect(aspect)[source]
Set the aspect of the SubplotDivider. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.set_aspect |
set_axes_locator(locator)[source] | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.set_axes_locator |
set_axes_pad(axes_pad)[source]
Set the padding between the axes. Parameters
axes_pad(float, float)
The padding (horizontal pad, vertical pad) in inches. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.set_axes_pad |
set_label_mode(mode)[source]
Define which axes have tick labels. Parameters
mode{"L", "1", "all"}
The label mode: "L": All axes on the left column get vertical tick labels; all axes on the bottom row get horizontal tick labels. "1": Only the bottom left axes is labelled. "all": all axes are labelled. | matplotlib._as_gen.mpl_toolkits.axes_grid1.axes_grid.grid#mpl_toolkits.axes_grid1.axes_grid.Grid.set_label_mode |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.