mpl_toolkits.axisartist.axislines.Axes

class mpl_toolkits.axisartist.axislines.Axes(*args, grid_helper=None, **kwargs)

Bases: matplotlib.axes._axes.Axes

class AxisDict(**kwargs)

Bases: dict

[Deprecated]

Notes

Deprecated since version 3.1:

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. Either none or all of the limits must be given. 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.
'scaled'	Set equal scaling (i.e., make circles circular) by changing dimensions of the plot box.
'tight'	Set limits just large enough to show all data.
'auto'	Automatic scaling (fill plot box with data).
'normal'	Same as 'auto'; deprecated.
'image'	'scaled' with axis limits equal to data limits.
'square'	Square plot; similar to 'scaled', but initially forcing xmax-xmin = ymax-ymin.

emit : bool, optional, default True

Whether observers are notified of the axis limit change. This option is passed on to set_xlim and set_ylim.

Returns:

xmin, xmax, ymin, ymax : float

The axis limits.

See also

matplotlib.axes.Axes.set_xlim, matplotlib.axes.Axes.set_ylim

cla()

Clear the current axes.

get_children()

Return a list of the child Artists of this Artist.

get_grid_helper()

grid(b=None, which='major', axis='both', **kwargs)

Toggle the gridlines, and optionally set the properties of the lines.

invalidate_grid_helper()

new_fixed_axis(loc, offset=None)

new_floating_axis(nth_coord, value, axis_direction='bottom')

new_gridlines(grid_helper=None)

Create and return a new GridlineCollection instance.

which : "major" or "minor" axis : "both", "x" or "y"

toggle_axisline(b=None)