| Parameters: |
- parent_axes :
matplotlib.axes.Axes
Axes to place the inset axes.
- zoom : float
Scaling factor of the data axes. zoom > 1 will enlargen the
coordinates (i.e., "zoomed in"), while zoom < 1 will shrink the
coordinates (i.e., "zoomed out").
- 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,
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
the units of the bounding box are determined through the transform
in use. When using bbox_to_anchor 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 (i.e. pixel
coordinates). This is useful when not providing any argument to
bbox_to_anchor. When using bbox_to_anchor it almost always makes
sense to also specify a bbox_transform. This might often be the
axes transform parent_axes.transAxes. Inversely, when specifying
the axes- or figure-transform here, be aware that not specifying
bbox_to_anchor will use parent_axes.bbox, the units of which are
in display (pixel) coordinates.
- 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 (0.0 transparent through 1.0 opaque) |
anchor |
[ 'C' | 'SW' | 'S' | 'SE' | 'E' | 'NE' | 'N' | 'NW' | 'W' ] |
animated |
bool |
aspect |
unknown |
autoscale_on |
bool |
autoscalex_on |
bool |
autoscaley_on |
bool |
axes_locator |
a callable object which takes an axes instance and renderer and returns a bbox. |
axisbelow |
[ bool | 'line' ] |
clip_box |
a Bbox instance |
clip_on |
bool |
clip_path |
[(Path, Transform) | Patch | None] |
contains |
a callable function |
facecolor |
color |
fc |
color |
figure |
Figure |
frame_on |
bool |
gid |
an id string |
label |
object |
navigate |
bool |
navigate_mode |
unknown |
path_effects |
AbstractPathEffect |
picker |
[None | bool | float | callable] |
position |
unknown |
rasterization_zorder |
float or None |
rasterized |
bool or None |
sketch_params |
(scale: float, length: float, randomness: float) |
snap |
bool or None |
title |
unknown |
transform |
Transform |
url |
a url string |
visible |
bool |
xbound |
(lower: float, upper: float) |
xlabel |
unknown |
xlim |
(left: float, right: float) |
xmargin |
float greater than -0.5 |
xscale |
[ 'linear' | 'log' | 'symlog' | 'logit' | ... ] |
xticklabels |
list of string labels |
xticks |
list of tick locations. |
ybound |
(lower: float, upper: float) |
ylabel |
unknown |
ylim |
(bottom: float, top: float) |
ymargin |
float greater than -0.5 |
yscale |
[ 'linear' | 'log' | 'symlog' | 'logit' | ... ] |
yticklabels |
list of string labels |
yticks |
list of tick locations. |
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.
|
|---|
