doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
draw(renderer)[source]
Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False). Parameters
rendererRendererBase subclass.
Notes This method is overridden in the Artist subclasses. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.draw |
get_ref_artist()[source]
Return the underlying artist that actually defines some properties (e.g., color) of this artist. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.get_ref_artist |
get_texts_widths_heights_descents(renderer)[source]
Return a list of (width, height, descent) tuples for ticklabels. Empty labels are left out. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.get_texts_widths_heights_descents |
get_window_extents(renderer)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.get_window_extents |
invert_axis_direction()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.invert_axis_direction |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, axis_direction=<UNSET>, backgroundcolor=<UNSET>, bbox=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, default_alignment=<UNSET>, default_angle=<UNSET>, fontfamily=<UNSET>, fontproperties=<UNSET>, fontsize=<UNSET>, fontstretch=<UNSET>, fontstyle=<UNSET>, fontvariant=<UNSET>, fontweight=<UNSET>, gid=<UNSET>, horizontalalignment=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linespacing=<UNSET>, locs_angles_labels=<UNSET>, math_fontfamily=<UNSET>, multialignment=<UNSET>, pad=<UNSET>, parse_math=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, rotation=<UNSET>, rotation_mode=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, text=<UNSET>, transform=<UNSET>, transform_rotates_text=<UNSET>, url=<UNSET>, usetex=<UNSET>, verticalalignment=<UNSET>, visible=<UNSET>, wrap=<UNSET>, x=<UNSET>, y=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
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
animated bool
axis_direction unknown
backgroundcolor color
bbox dict with properties for patches.FancyBboxPatch
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color or c color
default_alignment unknown
default_angle unknown
figure Figure
fontfamily or family {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
fontproperties or font or font_properties font_manager.FontProperties or str or pathlib.Path
fontsize or size float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
fontstretch or stretch {a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
fontstyle or style {'normal', 'italic', 'oblique'}
fontvariant or variant {'normal', 'small-caps'}
fontweight or weight {a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
gid str
horizontalalignment or ha {'center', 'right', 'left'}
in_layout bool
label object
linespacing float (multiple of font size)
locs_angles_labels unknown
math_fontfamily str
multialignment or ma {'left', 'right', 'center'}
pad unknown
parse_math bool
path_effects AbstractPathEffect
picker None or bool or float or callable
position (float, float)
rasterized bool
rotation float or {'vertical', 'horizontal'}
rotation_mode {None, 'default', 'anchor'}
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
text object
transform Transform
transform_rotates_text bool
url str
usetex bool or None
verticalalignment or va {'center', 'top', 'bottom', 'baseline', 'center_baseline'}
visible bool
wrap bool
x float
y float
zorder float | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.set |
set_axis_direction(label_direction)[source]
Adjust the text angle and text alignment of ticklabels according to the matplotlib convention. The label_direction must be one of [left, right, bottom, top].
property left bottom right top
ticklabels angle 90 0 -90 180
ticklabel va center baseline center baseline
ticklabel ha right center right center Note that the text angles are actually relative to (90 + angle of the direction to the ticklabel), which gives 0 for bottom axis. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.set_axis_direction |
set_locs_angles_labels(locs_angles_labels)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticklabels#mpl_toolkits.axisartist.axis_artist.TickLabels.set_locs_angles_labels |
mpl_toolkits.axisartist.axis_artist.Ticks classmpl_toolkits.axisartist.axis_artist.Ticks(ticksize, tick_out=False, *, axis=None, **kwargs)[source]
Bases: mpl_toolkits.axisartist.axis_artist.AttributeCopier, matplotlib.lines.Line2D Ticks are derived from Line2D, and note that ticks themselves are markers. Thus, you should use set_mec, set_mew, etc. To change the tick size (length), you need to use set_ticksize. To change the direction of the ticks (ticks are in opposite direction of ticklabels by default), use set_tick_out(False). draw(renderer)[source]
Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False). Parameters
rendererRendererBase subclass.
Notes This method is overridden in the Artist subclasses.
get_color()[source]
Return the line color. See also set_color.
get_markeredgecolor()[source]
Return the marker edge color. See also set_markeredgecolor.
get_markeredgewidth()[source]
Return the marker edge width in points. See also set_markeredgewidth.
get_ref_artist()[source]
Return the underlying artist that actually defines some properties (e.g., color) of this artist.
get_tick_out()[source]
Return whether ticks are drawn inside or outside the axes.
get_ticksize()[source]
Return length of the ticks in points.
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, dash_capstyle=<UNSET>, dash_joinstyle=<UNSET>, dashes=<UNSET>, data=<UNSET>, drawstyle=<UNSET>, fillstyle=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, locs_angles=<UNSET>, marker=<UNSET>, markeredgecolor=<UNSET>, markeredgewidth=<UNSET>, markerfacecolor=<UNSET>, markerfacecoloralt=<UNSET>, markersize=<UNSET>, markevery=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, solid_capstyle=<UNSET>, solid_joinstyle=<UNSET>, tick_out=<UNSET>, ticksize=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xdata=<UNSET>, ydata=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
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
animated bool
antialiased or aa bool
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color or c unknown
dash_capstyle CapStyle or {'butt', 'projecting', 'round'}
dash_joinstyle JoinStyle or {'miter', 'round', 'bevel'}
dashes sequence of floats (on/off ink in points) or (None, None)
data (2, N) array or two 1D arrays
drawstyle or ds {'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default'
figure Figure
fillstyle {'full', 'left', 'right', 'bottom', 'top', 'none'}
gid str
in_layout bool
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float
locs_angles unknown
marker marker style string, Path or MarkerStyle
markeredgecolor or mec color
markeredgewidth or mew float
markerfacecolor or mfc color
markerfacecoloralt or mfcalt color
markersize or ms float
markevery None or int or (int, int) or slice or list[int] or float or (float, float) or list[bool]
path_effects AbstractPathEffect
picker float or callable[[Artist, Event], tuple[bool, dict]]
pickradius float
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
solid_capstyle CapStyle or {'butt', 'projecting', 'round'}
solid_joinstyle JoinStyle or {'miter', 'round', 'bevel'}
tick_out unknown
ticksize unknown
transform Transform
url str
visible bool
xdata 1D array
ydata 1D array
zorder float
set_color(color)[source]
Set the color of the line. Parameters
colorcolor
set_locs_angles(locs_angles)[source]
set_tick_out(b)[source]
Set whether ticks are drawn inside or outside the axes.
set_ticksize(ticksize)[source]
Set length of the ticks in points. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks |
draw(renderer)[source]
Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False). Parameters
rendererRendererBase subclass.
Notes This method is overridden in the Artist subclasses. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.draw |
get_color()[source]
Return the line color. See also set_color. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.get_color |
get_markeredgecolor()[source]
Return the marker edge color. See also set_markeredgecolor. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.get_markeredgecolor |
get_markeredgewidth()[source]
Return the marker edge width in points. See also set_markeredgewidth. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.get_markeredgewidth |
get_ref_artist()[source]
Return the underlying artist that actually defines some properties (e.g., color) of this artist. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.get_ref_artist |
get_tick_out()[source]
Return whether ticks are drawn inside or outside the axes. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.get_tick_out |
get_ticksize()[source]
Return length of the ticks in points. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.get_ticksize |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, dash_capstyle=<UNSET>, dash_joinstyle=<UNSET>, dashes=<UNSET>, data=<UNSET>, drawstyle=<UNSET>, fillstyle=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, locs_angles=<UNSET>, marker=<UNSET>, markeredgecolor=<UNSET>, markeredgewidth=<UNSET>, markerfacecolor=<UNSET>, markerfacecoloralt=<UNSET>, markersize=<UNSET>, markevery=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, solid_capstyle=<UNSET>, solid_joinstyle=<UNSET>, tick_out=<UNSET>, ticksize=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xdata=<UNSET>, ydata=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
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
animated bool
antialiased or aa bool
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color or c unknown
dash_capstyle CapStyle or {'butt', 'projecting', 'round'}
dash_joinstyle JoinStyle or {'miter', 'round', 'bevel'}
dashes sequence of floats (on/off ink in points) or (None, None)
data (2, N) array or two 1D arrays
drawstyle or ds {'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default'
figure Figure
fillstyle {'full', 'left', 'right', 'bottom', 'top', 'none'}
gid str
in_layout bool
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float
locs_angles unknown
marker marker style string, Path or MarkerStyle
markeredgecolor or mec color
markeredgewidth or mew float
markerfacecolor or mfc color
markerfacecoloralt or mfcalt color
markersize or ms float
markevery None or int or (int, int) or slice or list[int] or float or (float, float) or list[bool]
path_effects AbstractPathEffect
picker float or callable[[Artist, Event], tuple[bool, dict]]
pickradius float
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
solid_capstyle CapStyle or {'butt', 'projecting', 'round'}
solid_joinstyle JoinStyle or {'miter', 'round', 'bevel'}
tick_out unknown
ticksize unknown
transform Transform
url str
visible bool
xdata 1D array
ydata 1D array
zorder float | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.set |
set_color(color)[source]
Set the color of the line. Parameters
colorcolor | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.set_color |
set_locs_angles(locs_angles)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.set_locs_angles |
set_tick_out(b)[source]
Set whether ticks are drawn inside or outside the axes. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.set_tick_out |
set_ticksize(ticksize)[source]
Set length of the ticks in points. | matplotlib._as_gen.mpl_toolkits.axisartist.axis_artist.ticks#mpl_toolkits.axisartist.axis_artist.Ticks.set_ticksize |
mpl_toolkits.axisartist.axisline_style Classes
AxislineStyle(stylename, **kw) A container class which defines style classes for AxisArtists. | matplotlib._as_gen.mpl_toolkits.axisartist.axisline_style |
mpl_toolkits.axisartist.axisline_style.AxislineStyle classmpl_toolkits.axisartist.axisline_style.AxislineStyle(stylename, **kw)[source]
Bases: matplotlib.patches._Style A container class which defines style classes for AxisArtists. An instance of any axisline style class is an callable object, whose call signature is __call__(self, axis_artist, path, transform)
When called, this should return an Artist with the following methods: def set_path(self, path):
# set the path for axisline.
def set_line_mutation_scale(self, scale):
# set the scale
def draw(self, renderer):
# draw
Return the instance of the subclass with the given style name. classFilledArrow(size=1)[source]
Bases: mpl_toolkits.axisartist.axisline_style.AxislineStyle.SimpleArrow Parameters
sizefloat
Size of the arrow as a fraction of the ticklabel size. ArrowAxisClass[source]
alias of mpl_toolkits.axisartist.axisline_style._FancyAxislineStyle.FilledArrow
classSimpleArrow(size=1)[source]
Bases: mpl_toolkits.axisartist.axisline_style.AxislineStyle._Base A simple arrow. Parameters
sizefloat
Size of the arrow as a fraction of the ticklabel size. ArrowAxisClass[source]
alias of mpl_toolkits.axisartist.axisline_style._FancyAxislineStyle.SimpleArrow
new_line(axis_artist, transform)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axisline_style.axislinestyle |
classFilledArrow(size=1)[source]
Bases: mpl_toolkits.axisartist.axisline_style.AxislineStyle.SimpleArrow Parameters
sizefloat
Size of the arrow as a fraction of the ticklabel size. ArrowAxisClass[source]
alias of mpl_toolkits.axisartist.axisline_style._FancyAxislineStyle.FilledArrow | matplotlib._as_gen.mpl_toolkits.axisartist.axisline_style.axislinestyle#mpl_toolkits.axisartist.axisline_style.AxislineStyle.FilledArrow |
ArrowAxisClass[source]
alias of mpl_toolkits.axisartist.axisline_style._FancyAxislineStyle.FilledArrow | matplotlib._as_gen.mpl_toolkits.axisartist.axisline_style.axislinestyle#mpl_toolkits.axisartist.axisline_style.AxislineStyle.FilledArrow.ArrowAxisClass |
classSimpleArrow(size=1)[source]
Bases: mpl_toolkits.axisartist.axisline_style.AxislineStyle._Base A simple arrow. Parameters
sizefloat
Size of the arrow as a fraction of the ticklabel size. ArrowAxisClass[source]
alias of mpl_toolkits.axisartist.axisline_style._FancyAxislineStyle.SimpleArrow
new_line(axis_artist, transform)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axisline_style.axislinestyle#mpl_toolkits.axisartist.axisline_style.AxislineStyle.SimpleArrow |
ArrowAxisClass[source]
alias of mpl_toolkits.axisartist.axisline_style._FancyAxislineStyle.SimpleArrow | matplotlib._as_gen.mpl_toolkits.axisartist.axisline_style.axislinestyle#mpl_toolkits.axisartist.axisline_style.AxislineStyle.SimpleArrow.ArrowAxisClass |
new_line(axis_artist, transform)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axisline_style.axislinestyle#mpl_toolkits.axisartist.axisline_style.AxislineStyle.SimpleArrow.new_line |
mpl_toolkits.axisartist.axislines Axislines includes modified implementation of the Axes class. The biggest difference is that the artists responsible for drawing the axis spine, ticks, ticklabels and axis labels are separated out from Matplotlib's Axis class. Originally, this change was motivated to support curvilinear grid. Here are a few reasons that I came up with a new axes class: "top" and "bottom" x-axis (or "left" and "right" y-axis) can have different ticks (tick locations and labels). This is not possible with the current Matplotlib, although some twin axes trick can help. Curvilinear grid. angled ticks. In the new axes class, xaxis and yaxis is set to not visible by default, and new set of artist (AxisArtist) are defined to draw axis line, ticks, ticklabels and axis label. Axes.axis attribute serves as a dictionary of these artists, i.e., ax.axis["left"] is a AxisArtist instance responsible to draw left y-axis. The default Axes.axis contains "bottom", "left", "top" and "right". AxisArtist can be considered as a container artist and has following children artists which will draw ticks, labels, etc. line major_ticks, major_ticklabels minor_ticks, minor_ticklabels offsetText label Note that these are separate artists from matplotlib.axis.Axis, thus most tick-related functions in Matplotlib won't work. For example, color and markerwidth of the ax.axis["bottom"].major_ticks will follow those of Axes.xaxis unless explicitly specified. In addition to AxisArtist, the Axes will have gridlines attribute, which obviously draws grid lines. The gridlines needs to be separated from the axis as some gridlines can never pass any axis. Classes
Axes(*args[, grid_helper]) Build an Axes in a figure.
AxesZero(*args[, grid_helper]) Build an Axes in a figure.
AxisArtistHelper() AxisArtistHelper should define following method with given APIs. Note that the first axes argument will be axes attribute of the caller artist.::.
AxisArtistHelperRectlinear()
GridHelperBase()
GridHelperRectlinear(axes) | matplotlib._as_gen.mpl_toolkits.axisartist.axislines |
mpl_toolkits.axisartist.axislines.Axes classmpl_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 built in the Figure fig.
rect[left, bottom, width, height]
The Axes is built 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 (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
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
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.
propertyaxis
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(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
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 (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
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
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
toggle_axisline(b=None)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes |
__call__(*args, **kwargs)[source]
Call self as a function. | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.__call__ |
cla()[source]
Clear the Axes. | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.cla |
get_children()[source]
Return a list of the child Artists of this Artist. | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.get_children |
get_grid_helper()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.get_grid_helper |
grid(visible=None, which='major', axis='both', **kwargs)[source]
Toggle the gridlines, and optionally set the properties of the lines. | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.grid |
invalidate_grid_helper()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.invalidate_grid_helper |
new_fixed_axis(loc, offset=None)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.new_fixed_axis |
new_floating_axis(nth_coord, value, axis_direction='bottom')[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.new_floating_axis |
new_gridlines(grid_helper=None)[source]
Create and return a new GridlineCollection instance. which : "major" or "minor" axis : "both", "x" or "y" | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.new_gridlines |
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
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 (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
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
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 | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.set |
toggle_axisline(b=None)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axes#mpl_toolkits.axisartist.axislines.Axes.toggle_axisline |
mpl_toolkits.axisartist.axislines.AxesZero classmpl_toolkits.axisartist.axislines.AxesZero(*args, grid_helper=None, **kwargs)[source]
Bases: mpl_toolkits.axisartist.axislines.Axes Build an Axes in a figure. Parameters
figFigure
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, 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 (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
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
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. 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
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 (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
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
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 | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axeszero |
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
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 (float, float) or {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
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
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 | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axeszero#mpl_toolkits.axisartist.axislines.AxesZero.set |
mpl_toolkits.axisartist.axislines.AxisArtistHelper classmpl_toolkits.axisartist.axislines.AxisArtistHelper[source]
Bases: object AxisArtistHelper should define following method with given APIs. Note that the first axes argument will be axes attribute of the caller artist.: # LINE (spinal line?)
def get_line(self, axes):
# path : Path
return path
def get_line_transform(self, axes):
# ...
# trans : transform
return trans
# LABEL
def get_label_pos(self, axes):
# x, y : position
return (x, y), trans
def get_label_offset_transform(self,
axes,
pad_points, fontprops, renderer,
bboxes,
):
# va : vertical alignment
# ha : horizontal alignment
# a : angle
return trans, va, ha, a
# TICK
def get_tick_transform(self, axes):
return trans
def get_tick_iterators(self, axes):
# iter : iterable object that yields (c, angle, l) where
# c, angle, l is position, tick angle, and label
return iter_major, iter_minor
classFixed(loc, nth_coord=None)[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base Helper class for a fixed (in the axes coordinate) axis. nth_coord = along which coordinate value varies in 2D, nth_coord = 0 -> x axis, nth_coord = 1 -> y axis get_axislabel_pos_angle(axes)[source]
Return the label reference position in transAxes. get_label_transform() returns a transform of (transAxes+offset)
get_axislabel_transform(axes)[source]
get_line(axes)[source]
get_line_transform(axes)[source]
get_nth_coord()[source]
get_tick_transform(axes)[source]
classFloating(nth_coord, value)[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base get_line(axes)[source]
get_nth_coord()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper |
classFixed(loc, nth_coord=None)[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base Helper class for a fixed (in the axes coordinate) axis. nth_coord = along which coordinate value varies in 2D, nth_coord = 0 -> x axis, nth_coord = 1 -> y axis get_axislabel_pos_angle(axes)[source]
Return the label reference position in transAxes. get_label_transform() returns a transform of (transAxes+offset)
get_axislabel_transform(axes)[source]
get_line(axes)[source]
get_line_transform(axes)[source]
get_nth_coord()[source]
get_tick_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed |
get_axislabel_pos_angle(axes)[source]
Return the label reference position in transAxes. get_label_transform() returns a transform of (transAxes+offset) | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed.get_axislabel_pos_angle |
get_axislabel_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed.get_axislabel_transform |
get_line(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed.get_line |
get_line_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed.get_line_transform |
get_nth_coord()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed.get_nth_coord |
get_tick_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed.get_tick_transform |
classFloating(nth_coord, value)[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper._Base get_line(axes)[source]
get_nth_coord()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Floating |
get_line(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Floating.get_line |
get_nth_coord()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelper#mpl_toolkits.axisartist.axislines.AxisArtistHelper.Floating.get_nth_coord |
mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear classmpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear[source]
Bases: object classFixed(axes, loc, nth_coord=None)[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed nth_coord = along which coordinate value varies in 2D, nth_coord = 0 -> x axis, nth_coord = 1 -> y axis get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label
classFloating(axes, nth_coord, passingthrough_point, axis_direction='bottom')[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper.Floating get_axislabel_pos_angle(axes)[source]
Return the label reference position in transAxes. get_label_transform() returns a transform of (transAxes+offset)
get_axislabel_transform(axes)[source]
get_line(axes)[source]
get_line_transform(axes)[source]
get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label
get_tick_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear |
classFixed(axes, loc, nth_coord=None)[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper.Fixed nth_coord = along which coordinate value varies in 2D, nth_coord = 0 -> x axis, nth_coord = 1 -> y axis get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Fixed |
get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Fixed.get_tick_iterators |
classFloating(axes, nth_coord, passingthrough_point, axis_direction='bottom')[source]
Bases: mpl_toolkits.axisartist.axislines.AxisArtistHelper.Floating get_axislabel_pos_angle(axes)[source]
Return the label reference position in transAxes. get_label_transform() returns a transform of (transAxes+offset)
get_axislabel_transform(axes)[source]
get_line(axes)[source]
get_line_transform(axes)[source]
get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label
get_tick_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Floating |
get_axislabel_pos_angle(axes)[source]
Return the label reference position in transAxes. get_label_transform() returns a transform of (transAxes+offset) | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Floating.get_axislabel_pos_angle |
get_axislabel_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Floating.get_axislabel_transform |
get_line(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Floating.get_line |
get_line_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Floating.get_line_transform |
get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Floating.get_tick_iterators |
get_tick_transform(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.axisartisthelperrectlinear#mpl_toolkits.axisartist.axislines.AxisArtistHelperRectlinear.Floating.get_tick_transform |
mpl_toolkits.axisartist.axislines.GridHelperBase classmpl_toolkits.axisartist.axislines.GridHelperBase[source]
Bases: object get_gridlines(which, axis)[source]
Return list of grid lines as a list of paths (list of points). which : "major" or "minor" axis : "both", "x" or "y"
invalidate()[source]
[Deprecated] Notes Deprecated since version 3.4:
new_gridlines(ax)[source]
Create and return a new GridlineCollection instance. which : "major" or "minor" axis : "both", "x" or "y"
update_lim(axes)[source]
valid()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperbase |
get_gridlines(which, axis)[source]
Return list of grid lines as a list of paths (list of points). which : "major" or "minor" axis : "both", "x" or "y" | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperbase#mpl_toolkits.axisartist.axislines.GridHelperBase.get_gridlines |
invalidate()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperbase#mpl_toolkits.axisartist.axislines.GridHelperBase.invalidate |
new_gridlines(ax)[source]
Create and return a new GridlineCollection instance. which : "major" or "minor" axis : "both", "x" or "y" | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperbase#mpl_toolkits.axisartist.axislines.GridHelperBase.new_gridlines |
update_lim(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperbase#mpl_toolkits.axisartist.axislines.GridHelperBase.update_lim |
valid()[source]
[Deprecated] Notes Deprecated since version 3.4: | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperbase#mpl_toolkits.axisartist.axislines.GridHelperBase.valid |
mpl_toolkits.axisartist.axislines.GridHelperRectlinear classmpl_toolkits.axisartist.axislines.GridHelperRectlinear(axes)[source]
Bases: mpl_toolkits.axisartist.axislines.GridHelperBase get_gridlines(which='major', axis='both')[source]
Return list of gridline coordinates in data coordinates. which : "major" or "minor" axis : "both", "x" or "y"
new_fixed_axis(loc, nth_coord=None, axis_direction=None, offset=None, axes=None)[source]
new_floating_axis(nth_coord, value, axis_direction='bottom', axes=None)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperrectlinear |
get_gridlines(which='major', axis='both')[source]
Return list of gridline coordinates in data coordinates. which : "major" or "minor" axis : "both", "x" or "y" | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperrectlinear#mpl_toolkits.axisartist.axislines.GridHelperRectlinear.get_gridlines |
new_fixed_axis(loc, nth_coord=None, axis_direction=None, offset=None, axes=None)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperrectlinear#mpl_toolkits.axisartist.axislines.GridHelperRectlinear.new_fixed_axis |
new_floating_axis(nth_coord, value, axis_direction='bottom', axes=None)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.axislines.gridhelperrectlinear#mpl_toolkits.axisartist.axislines.GridHelperRectlinear.new_floating_axis |
mpl_toolkits.axisartist.clip_path Functions
atan2(dy, dx)
clip(xlines, ylines, x0[, clip, xdir, ydir])
clip_line_to_rect(xline, yline, bbox) | matplotlib._as_gen.mpl_toolkits.axisartist.clip_path |
mpl_toolkits.axisartist.clip_path.atan2 mpl_toolkits.axisartist.clip_path.atan2(dy, dx)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.clip_path.atan2 |
mpl_toolkits.axisartist.clip_path.clip mpl_toolkits.axisartist.clip_path.clip(xlines, ylines, x0, clip='right', xdir=True, ydir=True)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.clip_path.clip |
mpl_toolkits.axisartist.clip_path.clip_line_to_rect mpl_toolkits.axisartist.clip_path.clip_line_to_rect(xline, yline, bbox)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.clip_path.clip_line_to_rect |
mpl_toolkits.axisartist.floating_axes An experimental support for curvilinear grid. Classes
ExtremeFinderFixed(extremes) This subclass always returns the same bounding box.
FixedAxisArtistHelper(grid_helper, side[, ...]) nth_coord = along which coordinate value varies.
FloatingAxes alias of mpl_toolkits.axisartist.floating_axes.FloatingAxesHostAxes
FloatingAxesBase(*args, **kwargs)
FloatingAxisArtistHelper(grid_helper, ...[, ...]) nth_coord = along which coordinate value varies.
GridHelperCurveLinear(aux_trans, extremes[, ...]) aux_trans : a transform from the source (curved) coordinate to target (rectilinear) coordinate. Functions
floatingaxes_class_factory(axes_class) | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes |
mpl_toolkits.axisartist.floating_axes.ExtremeFinderFixed classmpl_toolkits.axisartist.floating_axes.ExtremeFinderFixed(extremes)[source]
Bases: mpl_toolkits.axisartist.grid_finder.ExtremeFinderSimple This subclass always returns the same bounding box. Parameters
extremes(float, float, float, float)
The bounding box that this helper always returns. __call__(transform_xy, x1, y1, x2, y2)[source]
Compute an approximation of the bounding box obtained by applying transform_xy to the box delimited by (x1, y1, x2, y2). The intended use is to have (x1, y1, x2, y2) in axes coordinates, and have transform_xy be the transform from axes coordinates to data coordinates; this method then returns the range of data coordinates that span the actual axes. The computation is done by sampling nx * ny equispaced points in the (x1, y1, x2, y2) box and finding the resulting points with extremal coordinates; then adding some padding to take into account the finite sampling. As each sampling step covers a relative range of 1/nx or 1/ny, the padding is computed by expanding the span covered by the extremal coordinates by these fractions. | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.extremefinderfixed |
__call__(transform_xy, x1, y1, x2, y2)[source]
Compute an approximation of the bounding box obtained by applying transform_xy to the box delimited by (x1, y1, x2, y2). The intended use is to have (x1, y1, x2, y2) in axes coordinates, and have transform_xy be the transform from axes coordinates to data coordinates; this method then returns the range of data coordinates that span the actual axes. The computation is done by sampling nx * ny equispaced points in the (x1, y1, x2, y2) box and finding the resulting points with extremal coordinates; then adding some padding to take into account the finite sampling. As each sampling step covers a relative range of 1/nx or 1/ny, the padding is computed by expanding the span covered by the extremal coordinates by these fractions. | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.extremefinderfixed#mpl_toolkits.axisartist.floating_axes.ExtremeFinderFixed.__call__ |
mpl_toolkits.axisartist.floating_axes.FixedAxisArtistHelper classmpl_toolkits.axisartist.floating_axes.FixedAxisArtistHelper(grid_helper, side, nth_coord_ticks=None)[source]
Bases: mpl_toolkits.axisartist.grid_helper_curvelinear.FloatingAxisArtistHelper nth_coord = along which coordinate value varies.
nth_coord = 0 -> x axis, nth_coord = 1 -> y axis get_line(axes)[source]
get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label, (optionally) tick_label
update_lim(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.fixedaxisartisthelper |
get_line(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.fixedaxisartisthelper#mpl_toolkits.axisartist.floating_axes.FixedAxisArtistHelper.get_line |
get_tick_iterators(axes)[source]
tick_loc, tick_angle, tick_label, (optionally) tick_label | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.fixedaxisartisthelper#mpl_toolkits.axisartist.floating_axes.FixedAxisArtistHelper.get_tick_iterators |
update_lim(axes)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.fixedaxisartisthelper#mpl_toolkits.axisartist.floating_axes.FixedAxisArtistHelper.update_lim |
mpl_toolkits.axisartist.floating_axes.FloatingAxes mpl_toolkits.axisartist.floating_axes.FloatingAxes[source]
alias of mpl_toolkits.axisartist.floating_axes.FloatingAxesHostAxes | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.floatingaxes |
mpl_toolkits.axisartist.floating_axes.floatingaxes_class_factory mpl_toolkits.axisartist.floating_axes.floatingaxes_class_factory(axes_class)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.floatingaxes_class_factory |
mpl_toolkits.axisartist.floating_axes.FloatingAxesBase classmpl_toolkits.axisartist.floating_axes.FloatingAxesBase(*args, **kwargs)[source]
Bases: object adjust_axes_lim()[source]
cla()[source]
Examples using mpl_toolkits.axisartist.floating_axes.FloatingAxesBase
mpl_toolkits.axisartist.floating_axes features | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.floatingaxesbase |
adjust_axes_lim()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.floatingaxesbase#mpl_toolkits.axisartist.floating_axes.FloatingAxesBase.adjust_axes_lim |
cla()[source] | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.floatingaxesbase#mpl_toolkits.axisartist.floating_axes.FloatingAxesBase.cla |
mpl_toolkits.axisartist.floating_axes.FloatingAxisArtistHelper classmpl_toolkits.axisartist.floating_axes.FloatingAxisArtistHelper(grid_helper, nth_coord, value, axis_direction=None)[source]
Bases: mpl_toolkits.axisartist.grid_helper_curvelinear.FloatingAxisArtistHelper nth_coord = along which coordinate value varies.
nth_coord = 0 -> x axis, nth_coord = 1 -> y axis | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.floatingaxisartisthelper |
mpl_toolkits.axisartist.floating_axes.GridHelperCurveLinear classmpl_toolkits.axisartist.floating_axes.GridHelperCurveLinear(aux_trans, extremes, grid_locator1=None, grid_locator2=None, tick_formatter1=None, tick_formatter2=None)[source]
Bases: mpl_toolkits.axisartist.grid_helper_curvelinear.GridHelperCurveLinear aux_trans : a transform from the source (curved) coordinate to target (rectilinear) coordinate. An instance of MPL's Transform (inverse transform should be defined) or a tuple of two callable objects which defines the transform and its inverse. The callables need take two arguments of array of source coordinates and should return two target coordinates. e.g., x2, y2 = trans(x1, y1) get_boundary()[source]
[Deprecated] Return (N, 2) array of (x, y) coordinate of the boundary. Notes Deprecated since version 3.5.
get_data_boundary(side)[source]
Return v=0, nth=1.
get_gridlines(which='major', axis='both')[source]
Return list of grid lines as a list of paths (list of points). which : "major" or "minor" axis : "both", "x" or "y"
new_fixed_axis(loc, nth_coord=None, axis_direction=None, offset=None, axes=None)[source]
Examples using mpl_toolkits.axisartist.floating_axes.GridHelperCurveLinear
mpl_toolkits.axisartist.floating_axes features | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.gridhelpercurvelinear |
get_boundary()[source]
[Deprecated] Return (N, 2) array of (x, y) coordinate of the boundary. Notes Deprecated since version 3.5. | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.gridhelpercurvelinear#mpl_toolkits.axisartist.floating_axes.GridHelperCurveLinear.get_boundary |
get_data_boundary(side)[source]
Return v=0, nth=1. | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.gridhelpercurvelinear#mpl_toolkits.axisartist.floating_axes.GridHelperCurveLinear.get_data_boundary |
get_gridlines(which='major', axis='both')[source]
Return list of grid lines as a list of paths (list of points). which : "major" or "minor" axis : "both", "x" or "y" | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.gridhelpercurvelinear#mpl_toolkits.axisartist.floating_axes.GridHelperCurveLinear.get_gridlines |
new_fixed_axis(loc, nth_coord=None, axis_direction=None, offset=None, axes=None)[source] | matplotlib._as_gen.mpl_toolkits.axisartist.floating_axes.gridhelpercurvelinear#mpl_toolkits.axisartist.floating_axes.GridHelperCurveLinear.new_fixed_axis |
mpl_toolkits.axisartist.grid_finder Classes
DictFormatter(format_dict[, formatter]) format_dict : dictionary for format strings to be used.
ExtremeFinderSimple(nx, ny) A helper class to figure out the range of grid lines that need to be drawn.
FixedLocator(locs)
FormatterPrettyPrint([useMathText])
GridFinder(transform[, extreme_finder, ...]) transform : transform from the image coordinate (which will be the transData of the axes to the world coordinate.
MaxNLocator([nbins, steps, trim, integer, ...])
Parameters | matplotlib._as_gen.mpl_toolkits.axisartist.grid_finder |
mpl_toolkits.axisartist.grid_finder.DictFormatter classmpl_toolkits.axisartist.grid_finder.DictFormatter(format_dict, formatter=None)[source]
Bases: object format_dict : dictionary for format strings to be used. formatter : fall-back formatter __call__(direction, factor, values)[source]
factor is ignored if value is found in the dictionary
Examples using mpl_toolkits.axisartist.grid_finder.DictFormatter
mpl_toolkits.axisartist.floating_axes features | matplotlib._as_gen.mpl_toolkits.axisartist.grid_finder.dictformatter |
__call__(direction, factor, values)[source]
factor is ignored if value is found in the dictionary | matplotlib._as_gen.mpl_toolkits.axisartist.grid_finder.dictformatter#mpl_toolkits.axisartist.grid_finder.DictFormatter.__call__ |
mpl_toolkits.axisartist.grid_finder.ExtremeFinderSimple classmpl_toolkits.axisartist.grid_finder.ExtremeFinderSimple(nx, ny)[source]
Bases: object A helper class to figure out the range of grid lines that need to be drawn. Parameters
nx, nyint
The number of samples in each direction. __call__(transform_xy, x1, y1, x2, y2)[source]
Compute an approximation of the bounding box obtained by applying transform_xy to the box delimited by (x1, y1, x2, y2). The intended use is to have (x1, y1, x2, y2) in axes coordinates, and have transform_xy be the transform from axes coordinates to data coordinates; this method then returns the range of data coordinates that span the actual axes. The computation is done by sampling nx * ny equispaced points in the (x1, y1, x2, y2) box and finding the resulting points with extremal coordinates; then adding some padding to take into account the finite sampling. As each sampling step covers a relative range of 1/nx or 1/ny, the padding is computed by expanding the span covered by the extremal coordinates by these fractions.
Examples using mpl_toolkits.axisartist.grid_finder.ExtremeFinderSimple
axis_direction demo
Curvilinear grid demo
Demo CurveLinear Grid2
floating_axis demo
Simple Axis Pad | matplotlib._as_gen.mpl_toolkits.axisartist.grid_finder.extremefindersimple |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.