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 |
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. |