Parameters: |
- parent_axes :
matplotlib.axes.Axes
Axes to place the inset axes.
- width, height : float or str
Size of the inset axes to create. If a float is provided, it is
the size in inches, e.g. width=1.3. If a string is provided, it is
the size in relative units, e.g. width='40%'. By default, i.e. if
neither bbox_to_anchor nor bbox_transform are specified, those
are relative to the parent_axes. Otherwise they are to be understood
relative to the bounding box provided via bbox_to_anchor.
- loc : int or string, optional, default to 1
Location to place the inset axes. The valid locations are:
'upper right' : 1,
'upper left' : 2,
'lower left' : 3,
'lower right' : 4,
'right' : 5,
'center left' : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center' : 10
- bbox_to_anchor : tuple or
matplotlib.transforms.BboxBase , optional
Bbox that the inset axes will be anchored to. If None,
a tuple of (0, 0, 1, 1) is used if bbox_transform is set
to parent_axes.transAxes or parent_axes.figure.transFigure.
Otherwise, parent_axes.bbox is used. If a tuple, can be either
[left, bottom, width, height], or [left, bottom].
If the kwargs width and/or height are specified in relative units,
the 2-tuple [left, bottom] cannot be used. Note that,
unless bbox_transform is set, the units of the bounding box
are interpreted in the pixel coordinate. When using bbox_to_anchor
with tuple, it almost always makes sense to also specify
a bbox_transform. This might often be the axes transform
parent_axes.transAxes.
- bbox_transform :
matplotlib.transforms.Transform , optional
Transformation for the bbox that contains the inset axes.
If None, a transforms.IdentityTransform is used. The value
of bbox_to_anchor (or the return value of its get_points method)
is transformed by the bbox_transform and then interpreted
as points in the pixel coordinate (which is dpi dependent).
You may provide bbox_to_anchor in some normalized coordinate,
and give an appropriate transform (e.g., parent_axes.transAxes).
- axes_class :
matplotlib.axes.Axes type, optional
If specified, the inset axes created will be created with this class's
constructor.
- axes_kwargs : dict, optional
Keyworded arguments to pass to the constructor of the inset axes.
Valid arguments include:
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 |
float |
anchor |
2-tuple of floats or {'C', 'SW', 'S', 'SE', ...} |
animated |
bool |
aspect |
{'auto', 'equal'} or num |
autoscale_on |
bool |
autoscalex_on |
bool |
autoscaley_on |
bool |
axes_locator |
Callable[[Axes, Renderer], Bbox] |
axisbelow |
bool or 'line' |
clip_box |
Bbox |
clip_on |
bool |
clip_path |
[(Path , Transform ) | Patch | None] |
contains |
callable |
facecolor |
color |
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 |
rasterization_zorder |
float or None |
rasterized |
bool or None |
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 |
(left: float, right: float) |
xmargin |
float greater than -0.5 |
xscale |
{"linear", "log", "symlog", "logit", ...} |
xticklabels |
List[str] |
xticks |
list |
ybound |
unknown |
ylabel |
str |
ylim |
(bottom: float, top: float) |
ymargin |
float greater than -0.5 |
yscale |
{"linear", "log", "symlog", "logit", ...} |
yticklabels |
List[str] |
yticks |
list |
zorder |
float |
- borderpad : float, optional
Padding between inset axes and the bbox_to_anchor. Defaults to 0.5.
The units are axes font size, i.e. for a default font size of 10 points
borderpad = 0.5 is equivalent to a padding of 5 points.
|