mpl_toolkits.axisartist.axislines.Axes
- class mpl_toolkits.axisartist.axislines. Axes ( *args, grid_helper=None, **kwargs ) [source]
-
Bases:
matplotlib.axes._axes.Axes
Build an Axes in a figure.
- Parameters
-
-
fig
Figure
-
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, sharey
Axes
, optional -
The x or y
axis
is shared with the x or y axis in the inputAxes
. - frameon bool, default: True
-
Whether the Axes frame is visible.
- box_aspect float, 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
{'box', 'datalim'}
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
scalar or None
(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
bool
{'auto', 'equal'} or float
bool
bool
bool
Callable[[Axes, Renderer], Bbox]
bool or 'line'
float or None
bool
Patch or (Path, Transform) or None
facecolor
or fccolor
bool
str
bool
object
bool
unknown
None or bool or float or callable
[left, bottom, width, height] or
Bbox
unknown
float or None
bool
(scale: float, length: float, randomness: float)
bool or None
str
str
bool
unknown
str
(bottom: float, top: float)
float greater than -0.5
{"linear", "log", "symlog", "logit", ...} or
ScaleBase
unknown
unknown
unknown
str
(bottom: float, top: float)
float greater than -0.5
{"linear", "log", "symlog", "logit", ...} or
ScaleBase
unknown
unknown
float
-
fig
- Returns
- __call__ ( *args, **kwargs ) [source]
-
Call self as a function.
- property axis
-
Convenience method to get or set some axis properties.
Call signatures:
xmin, xmax, ymin, ymax = axis() xmin, xmax, ymin, ymax = axis([xmin, xmax, ymin, ymax]) xmin, xmax, ymin, ymax = axis(option) xmin, xmax, ymin, ymax = axis(**kwargs)
- Parameters
-
- xmin, xmax, ymin, ymax float, optional
-
The axis limits to be set. This can also be achieved using
ax.set(xlim=(xmin, xmax), ylim=(ymin, ymax))
- option bool or str
-
If a bool, turns axis lines and labels on or off. If a string, possible values are:
Value
Description
'on'
Turn on axis lines and labels. Same as
True
.'off'
Turn off axis lines and labels. Same as
False
.'equal'
Set equal scaling (i.e., make circles circular) by changing axis limits. This is the same as
ax.set_aspect('equal', adjustable='datalim')
. Explicit data limits may not be respected in this case.'scaled'
Set equal scaling (i.e., make circles circular) by changing dimensions of the plot box. This is the same as
ax.set_aspect('equal', adjustable='box', anchor='C')
. Additionally, further autoscaling will be disabled.'tight'
Set limits just large enough to show all data, then disable further autoscaling.
'auto'
Automatic scaling (fill plot box with data).
'image'
'scaled' with axis limits equal to data limits.
'square'
Square plot; similar to 'scaled', but initially forcing
xmax-xmin == ymax-ymin
. - emit bool, default: True
-
Whether observers are notified of the axis limit change. This option is passed on to
set_xlim
andset_ylim
.
- Returns
-
- xmin, xmax, ymin, ymax float
-
The axis limits.
- cla ( ) [source]
-
Clear the Axes.
- get_grid_helper ( ) [source]
- grid ( visible=None, which='major', axis='both', **kwargs ) [source]
-
Toggle the gridlines, and optionally set the properties of the lines.
- invalidate_grid_helper ( ) [source]
-
[Deprecated]
Notes
Deprecated since version 3.4:
- new_fixed_axis ( loc, offset=None ) [source]
- new_floating_axis ( nth_coord, value, axis_direction='bottom' ) [source]
- new_gridlines ( grid_helper=None ) [source]
-
Create and return a new GridlineCollection instance.
which : "major" or "minor" axis : "both", "x" or "y"
- 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
{'box', 'datalim'}
a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
scalar or None
(float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
bool
{'auto', 'equal'} or float
bool
bool
bool
Callable[[Axes, Renderer], Bbox]
bool or 'line'
float or None
bool
Patch or (Path, Transform) or None
facecolor
or fccolor
bool
str
bool
object
bool
unknown
None or bool or float or callable
[left, bottom, width, height] or
Bbox
unknown
float or None
bool
(scale: float, length: float, randomness: float)
bool or None
str
str
bool
unknown
str
(bottom: float, top: float)
float greater than -0.5
{"linear", "log", "symlog", "logit", ...} or
ScaleBase
unknown
unknown
unknown
str
(bottom: float, top: float)
float greater than -0.5
{"linear", "log", "symlog", "logit", ...} or
ScaleBase
unknown
unknown
float
- toggle_axisline ( b=None ) [source]
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/_as_gen/mpl_toolkits.axisartist.axislines.Axes.html