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:

figFigure The axes is build in the Figure fig. rect[left, bottom, width, height] The axes is build in the rectangle rect. rect is in Figure coordinates. sharex, shareyAxes, optional The x or y axis is shared with the x or y axis in the input Axes. frameonbool, default: True Whether the axes frame is visible. box_aspectfloat, 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 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 scalar or None anchor 2-tuple of floats or {'C', 'SW', 'S', 'SE', ...} animated bool aspect {'auto', 'equal'} or float autoscale_on bool autoscalex_on bool autoscaley_on bool axes_locator Callable[[Axes, Renderer], Bbox] axisbelow bool or 'line' box_aspect float or None clip_box Bbox clip_on bool clip_path Patch or (Path, Transform) or None contains unknown facecolor or 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 prop_cycle unknown rasterization_zorder float or None rasterized bool 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 (bottom: float, top: float) xmargin float greater than -0.5 xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase xticklabels unknown xticks unknown ybound unknown ylabel str ylim (bottom: float, top: float) ymargin float greater than -0.5 yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase yticklabels unknown yticks unknown zorder float

Returns:

Axes The new Axes object.

__call__(*args, **kwargs)[source]

Call self as a function.

__init__(*args, grid_helper=None, **kwargs)[source]

Build an axes in a figure.

Parameters:

figFigure The axes is build in the Figure fig. rect[left, bottom, width, height] The axes is build in the rectangle rect. rect is in Figure coordinates. sharex, shareyAxes, optional The x or y axis is shared with the x or y axis in the input Axes. frameonbool, default: True Whether the axes frame is visible. box_aspectfloat, 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 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 scalar or None anchor 2-tuple of floats or {'C', 'SW', 'S', 'SE', ...} animated bool aspect {'auto', 'equal'} or float autoscale_on bool autoscalex_on bool autoscaley_on bool axes_locator Callable[[Axes, Renderer], Bbox] axisbelow bool or 'line' box_aspect float or None clip_box Bbox clip_on bool clip_path Patch or (Path, Transform) or None contains unknown facecolor or 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 prop_cycle unknown rasterization_zorder float or None rasterized bool 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 (bottom: float, top: float) xmargin float greater than -0.5 xscale {"linear", "log", "symlog", "logit", ...} or ScaleBase xticklabels unknown xticks unknown ybound unknown ylabel str ylim (bottom: float, top: float) ymargin float greater than -0.5 yscale {"linear", "log", "symlog", "logit", ...} or ScaleBase yticklabels unknown yticks unknown zorder float

Returns:

Axes The new Axes object.

__module__ = 'mpl_toolkits.axisartist.axislines'

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, ymaxfloat, optional The axis limits to be set. This can also be achieved using ax.set(xlim=(xmin, xmax), ylim=(ymin, ymax)) optionbool 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. emitbool, 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, ymaxfloat The axis limits.

See also

matplotlib.axes.Axes.set_xlim

matplotlib.axes.Axes.set_ylim

cla()[source]

Clear the axes.

get_children()[source]

Return a list of the child Artists of this Artist.

get_grid_helper()[source]

grid(b=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"

toggle_axisline(b=None)[source]

Examples using mpl_toolkits.axisartist.axislines.Axes