matplotlib.artist.ArtistInspector   classmatplotlib.artist.ArtistInspector(o)[source]

A helper class to inspect an Artist and return information about its settable properties and their current values. Initialize the artist inspector with an Artist or an iterable of Artists. If an iterable is used, we assume it is a homogeneous sequence (all Artists are of the same type) and it is your responsibility to make sure this is so.   __init__(o)[source]

Initialize the artist inspector with an Artist or an iterable of Artists. If an iterable is used, we assume it is a homogeneous sequence (all Artists are of the same type) and it is your responsibility to make sure this is so.
 Methods
__init__(o) Initialize the artist inspector with an Artist or an iterable of Artists.
aliased_name(s) Return 'PROPNAME or alias' if s has an alias, else return 'PROPNAME'.
aliased_name_rest(s, target) Return 'PROPNAME or alias' if s has an alias, else return 'PROPNAME', formatted for reST.
get_aliases() Get a dict mapping property fullnames to sets of aliases for each alias in the ArtistInspector.
get_setters() Get the attribute strings with setters for object.
get_valid_values(attr) Get the legal arguments for the setter associated with attr.
is_alias(o) Return whether method object o is an alias for another method.
pprint_getters() Return the getters and actual values as list of strings.
pprint_setters([prop, leadingspace]) If prop is None, return a list of strings of all settable properties and their valid values.
pprint_setters_rest([prop, leadingspace]) If prop is None, return a list of reST-formatted strings of all settable properties and their valid values.
properties() Return a dictionary mapping property name -> value.     aliased_name(s)[source]

Return 'PROPNAME or alias' if s has an alias, else return 'PROPNAME'. e.g., for the line markerfacecolor property, which has an alias, return 'markerfacecolor or mfc' and for the transform property, which does not, return 'transform'.
   aliased_name_rest(s, target)[source]

Return 'PROPNAME or alias' if s has an alias, else return 'PROPNAME', formatted for reST. e.g., for the line markerfacecolor property, which has an alias, return 'markerfacecolor or mfc' and for the transform property, which does not, return 'transform'.
   get_aliases()[source]

Get a dict mapping property fullnames to sets of aliases for each alias in the ArtistInspector. e.g., for lines: {'markerfacecolor': {'mfc'},
 'linewidth'      : {'lw'},
}

   get_setters()[source]

Get the attribute strings with setters for object. For example, for a line, return ['markerfacecolor', 'linewidth',
....].
   get_valid_values(attr)[source]

Get the legal arguments for the setter associated with attr. This is done by querying the docstring of the setter for a line that begins with "ACCEPTS:" or ".. ACCEPTS:", and then by looking for a numpydoc-style documentation for the setter's first argument.
   is_alias(o)[source]

Return whether method object o is an alias for another method.
   pprint_getters()[source]

Return the getters and actual values as list of strings.
   pprint_setters(prop=None, leadingspace=2)[source]

If prop is None, return a list of strings of all settable properties and their valid values. If prop is not None, it is a valid property name and that property will be returned as a string of property : valid values.
   pprint_setters_rest(prop=None, leadingspace=4)[source]

If prop is None, return a list of reST-formatted strings of all settable properties and their valid values. If prop is not None, it is a valid property name and that property will be returned as a string of "property : valid" values.
   properties()[source]

Return a dictionary mapping property name -> value.


__init__(o)[source]

Initialize the artist inspector with an Artist or an iterable of Artists. If an iterable is used, we assume it is a homogeneous sequence (all Artists are of the same type) and it is your responsibility to make sure this is so.


aliased_name(s)[source]

Return 'PROPNAME or alias' if s has an alias, else return 'PROPNAME'. e.g., for the line markerfacecolor property, which has an alias, return 'markerfacecolor or mfc' and for the transform property, which does not, return 'transform'.


aliased_name_rest(s, target)[source]

Return 'PROPNAME or alias' if s has an alias, else return 'PROPNAME', formatted for reST. e.g., for the line markerfacecolor property, which has an alias, return 'markerfacecolor or mfc' and for the transform property, which does not, return 'transform'.


get_aliases()[source]

Get a dict mapping property fullnames to sets of aliases for each alias in the ArtistInspector. e.g., for lines: {'markerfacecolor': {'mfc'},
 'linewidth'      : {'lw'},
}


get_setters()[source]

Get the attribute strings with setters for object. For example, for a line, return ['markerfacecolor', 'linewidth',
....].


get_valid_values(attr)[source]

Get the legal arguments for the setter associated with attr. This is done by querying the docstring of the setter for a line that begins with "ACCEPTS:" or ".. ACCEPTS:", and then by looking for a numpydoc-style documentation for the setter's first argument.


is_alias(o)[source]

Return whether method object o is an alias for another method.


pprint_getters()[source]

Return the getters and actual values as list of strings.


pprint_setters(prop=None, leadingspace=2)[source]

If prop is None, return a list of strings of all settable properties and their valid values. If prop is not None, it is a valid property name and that property will be returned as a string of property : valid values.


pprint_setters_rest(prop=None, leadingspace=4)[source]

If prop is None, return a list of reST-formatted strings of all settable properties and their valid values. If prop is not None, it is a valid property name and that property will be returned as a string of "property : valid" values.


properties()[source]

Return a dictionary mapping property name -> value.


matplotlib.artist.get   matplotlib.artist.get(obj, property=None)[source]

Return the value of an Artist's property, or print all of them.  Parameters

objArtist

The queried artist; e.g., a Line2D, a Text, or an Axes.
propertystr or None, default: None

If property is 'somename', this function returns obj.get_somename(). If it's None (or unset), it prints all gettable properties from obj. Many properties have aliases for shorter typing, e.g. 'lw' is an alias for 'linewidth'. In the output, aliases and full property names will be listed as: property or alias = value e.g.: linewidth or lw = 2      See also  setp


matplotlib.artist.getp   matplotlib.artist.getp(obj, property=None)[source]

Return the value of an Artist's property, or print all of them.  Parameters

objArtist

The queried artist; e.g., a Line2D, a Text, or an Axes.
propertystr or None, default: None

If property is 'somename', this function returns obj.get_somename(). If it's None (or unset), it prints all gettable properties from obj. Many properties have aliases for shorter typing, e.g. 'lw' is an alias for 'linewidth'. In the output, aliases and full property names will be listed as: property or alias = value e.g.: linewidth or lw = 2      See also  setp


matplotlib.artist.kwdoc   matplotlib.artist.kwdoc(artist)[source]

Inspect an Artist class (using ArtistInspector) and return information about its settable properties and their current values.  Parameters

artistArtist or an iterable of Artists

  Returns
 str

The settable properties of artist, as plain text if rcParams["docstring.hardcopy"] (default: False) is False and as a rst table (intended for use in Sphinx) if it is True.


matplotlib.artist.setp   matplotlib.artist.setp(obj, *args, file=None, **kwargs)[source]

Set one or more properties on an Artist, or list allowed values.  Parameters

objArtist or list of Artist

The artist(s) whose properties are being set or queried. When setting properties, all artists are affected; when querying the allowed values, only the first instance in the sequence is queried. For example, two lines can be made thicker and red with a single call: >>> x = arange(0, 1, 0.01)
>>> lines = plot(x, sin(2*pi*x), x, sin(4*pi*x))
>>> setp(lines, linewidth=2, color='r')

filefile-like, default: sys.stdout

Where setp writes its output when asked to list allowed values. >>> with open('output.log') as file:
...     setp(line, file=file)
 The default, None, means sys.stdout.  *args, **kwargs

The properties to set. The following combinations are supported:
Set the linestyle of a line to be dashed: >>> line, = plot([1, 2, 3])
>>> setp(line, linestyle='--')

Set multiple properties at once: >>> setp(line, linewidth=2, color='r')

List allowed values for a line's linestyle: >>> setp(line, 'linestyle')
linestyle: {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

List all properties that can be set, and their allowed values: >>> setp(line)
agg_filter: a filter function, ...
[long output listing omitted]
   setp also supports MATLAB style string/value pairs. For example, the following are equivalent: >>> setp(lines, 'linewidth', 2, 'color', 'r')  # MATLAB style
>>> setp(lines, linewidth=2, color='r')        # Python style
      See also  getp


matplotlib.axes Table of Contents  Inheritance The Axes class Subplots
Plotting  Basic Spans Spectral Statistics Binned Contours 2D arrays Unstructured triangles Text and annotations Vector fields   Clearing Appearance Property cycle
Axis / limits  Axis limits and direction Axis labels, title, and legend Axis scales Autoscaling and margins Aspect ratio Ticks and tick labels   Units Adding artists Twinning and sharing Axes position Async/event based Interactive Children Drawing Projection Other   Inheritance       The Axes class   classmatplotlib.axes.Axes(fig, rect, *, facecolor=None, frameon=True, sharex=None, sharey=None, label='', xscale=None, yscale=None, box_aspect=None, **kwargs)[source]

Bases: matplotlib.axes._base._AxesBase The Axes contains most of the figure elements: Axis, Tick, Line2D, Text, Polygon, etc., and sets the coordinate system. The Axes instance supports callbacks through a callbacks attribute which is a CallbackRegistry instance. The events you can connect to are 'xlim_changed' and 'ylim_changed' and the callback will be called with func(ax) where ax is the Axes instance.  Attributes

dataLimBbox

The bounding box enclosing all data displayed in the Axes.
viewLimBbox

The view limits in data coordinates.     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.
   Subplots
SubplotBase Base class for subplots, which are Axes instances with additional methods to facilitate generating and manipulating a set of Axes within a figure.
subplot_class_factory      Plotting  Basic
Axes.plot Plot y versus x as lines and/or markers.
Axes.errorbar Plot y versus x as lines and/or markers with attached errorbars.
Axes.scatter A scatter plot of y vs.
Axes.plot_date Plot coercing the axis to treat floats as dates.
Axes.step Make a step plot.
Axes.loglog Make a plot with log scaling on both the x and y axis.
Axes.semilogx Make a plot with log scaling on the x axis.
Axes.semilogy Make a plot with log scaling on the y axis.
Axes.fill_between Fill the area between two horizontal curves.
Axes.fill_betweenx Fill the area between two vertical curves.
Axes.bar Make a bar plot.
Axes.barh Make a horizontal bar plot.
Axes.bar_label Label a bar plot.
Axes.stem Create a stem plot.
Axes.eventplot Plot identical parallel lines at the given positions.
Axes.pie Plot a pie chart.
Axes.stackplot Draw a stacked area plot.
Axes.broken_barh Plot a horizontal sequence of rectangles.
Axes.vlines Plot vertical lines at each x from ymin to ymax.
Axes.hlines Plot horizontal lines at each y from xmin to xmax.
Axes.fill Plot filled polygons.     Spans
Axes.axhline Add a horizontal line across the axis.
Axes.axhspan Add a horizontal span (rectangle) across the Axes.
Axes.axvline Add a vertical line across the Axes.
Axes.axvspan Add a vertical span (rectangle) across the Axes.
Axes.axline Add an infinitely long straight line.     Spectral
Axes.acorr Plot the autocorrelation of x.
Axes.angle_spectrum Plot the angle spectrum.
Axes.cohere Plot the coherence between x and y.
Axes.csd Plot the cross-spectral density.
Axes.magnitude_spectrum Plot the magnitude spectrum.
Axes.phase_spectrum Plot the phase spectrum.
Axes.psd Plot the power spectral density.
Axes.specgram Plot a spectrogram.
Axes.xcorr Plot the cross correlation between x and y.     Statistics
Axes.boxplot Draw a box and whisker plot.
Axes.violinplot Make a violin plot.
Axes.violin Drawing function for violin plots.
Axes.bxp Drawing function for box and whisker plots.     Binned
Axes.hexbin Make a 2D hexagonal binning plot of points x, y.
Axes.hist Plot a histogram.
Axes.hist2d Make a 2D histogram plot.
Axes.stairs A stepwise constant function as a line with bounding edges or a filled plot.     Contours
Axes.clabel Label a contour plot.
Axes.contour Plot contour lines.
Axes.contourf Plot filled contours.     2D arrays
Axes.imshow Display data as an image, i.e., on a 2D regular raster.
Axes.matshow Plot the values of a 2D matrix or array as color-coded image.
Axes.pcolor Create a pseudocolor plot with a non-regular rectangular grid.
Axes.pcolorfast Create a pseudocolor plot with a non-regular rectangular grid.
Axes.pcolormesh Create a pseudocolor plot with a non-regular rectangular grid.
Axes.spy Plot the sparsity pattern of a 2D array.     Unstructured triangles
Axes.tripcolor Create a pseudocolor plot of an unstructured triangular grid.
Axes.triplot Draw a unstructured triangular grid as lines and/or markers.
Axes.tricontour Draw contour lines on an unstructured triangular grid.
Axes.tricontourf Draw contour regions on an unstructured triangular grid.     Text and annotations
Axes.annotate Annotate the point xy with text text.
Axes.text Add text to the Axes.
Axes.table Add a table to an Axes.
Axes.arrow Add an arrow to the Axes.
Axes.inset_axes Add a child inset Axes to this existing Axes.
Axes.indicate_inset Add an inset indicator to the Axes.
Axes.indicate_inset_zoom Add an inset indicator rectangle to the Axes based on the axis limits for an inset_ax and draw connectors between inset_ax and the rectangle.
Axes.secondary_xaxis Add a second x-axis to this Axes.
Axes.secondary_yaxis Add a second y-axis to this Axes.     Vector fields
Axes.barbs Plot a 2D field of barbs.
Axes.quiver Plot a 2D field of arrows.
Axes.quiverkey Add a key to a quiver plot.
Axes.streamplot Draw streamlines of a vector flow.      Clearing
Axes.cla Clear the Axes.
Axes.clear Clear the Axes.     Appearance
Axes.axis Convenience method to get or set some axis properties.
Axes.set_axis_off Turn the x- and y-axis off.
Axes.set_axis_on Turn the x- and y-axis on.
Axes.set_frame_on Set whether the Axes rectangle patch is drawn.
Axes.get_frame_on Get whether the Axes rectangle patch is drawn.
Axes.set_axisbelow Set whether axis ticks and gridlines are above or below most artists.
Axes.get_axisbelow Get whether axis ticks and gridlines are above or below most artists.
Axes.grid Configure the grid lines.
Axes.get_facecolor Get the facecolor of the Axes.
Axes.set_facecolor Set the facecolor of the Axes.     Property cycle
Axes.set_prop_cycle Set the property cycle of the Axes.     Axis / limits
Axes.get_xaxis Return the XAxis instance.
Axes.get_yaxis Return the YAxis instance.    Axis limits and direction
Axes.invert_xaxis Invert the x-axis.
Axes.xaxis_inverted Return whether the xaxis is oriented in the "inverse" direction.
Axes.invert_yaxis Invert the y-axis.
Axes.yaxis_inverted Return whether the yaxis is oriented in the "inverse" direction.
Axes.set_xlim Set the x-axis view limits.
Axes.get_xlim Return the x-axis view limits.
Axes.set_ylim Set the y-axis view limits.
Axes.get_ylim Return the y-axis view limits.
Axes.update_datalim Extend the dataLim Bbox to include the given points.
Axes.set_xbound Set the lower and upper numerical bounds of the x-axis.
Axes.get_xbound Return the lower and upper x-axis bounds, in increasing order.
Axes.set_ybound Set the lower and upper numerical bounds of the y-axis.
Axes.get_ybound Return the lower and upper y-axis bounds, in increasing order.     Axis labels, title, and legend
Axes.set_xlabel Set the label for the x-axis.
Axes.get_xlabel Get the xlabel text string.
Axes.set_ylabel Set the label for the y-axis.
Axes.get_ylabel Get the ylabel text string.
Axes.set_title Set a title for the Axes.
Axes.get_title Get an Axes title.
Axes.legend Place a legend on the Axes.
Axes.get_legend Return the Legend instance, or None if no legend is defined.
Axes.get_legend_handles_labels Return handles and labels for legend     Axis scales
Axes.set_xscale Set the x-axis scale.
Axes.get_xscale Return the xaxis' scale (as a str).
Axes.set_yscale Set the y-axis scale.
Axes.get_yscale Return the yaxis' scale (as a str).     Autoscaling and margins
Axes.use_sticky_edges When autoscaling, whether to obey all Artist.sticky_edges.
Axes.margins Set or retrieve autoscaling margins.
Axes.set_xmargin Set padding of X data limits prior to autoscaling.
Axes.set_ymargin Set padding of Y data limits prior to autoscaling.
Axes.relim Recompute the data limits based on current artists.
Axes.autoscale Autoscale the axis view to the data (toggle).
Axes.autoscale_view Autoscale the view limits using the data limits.
Axes.set_autoscale_on Set whether autoscaling is applied to each axis on the next draw or call to Axes.autoscale_view.
Axes.get_autoscale_on Return True if each axis is autoscaled, False otherwise.
Axes.set_autoscalex_on Set whether the x-axis is autoscaled on the next draw or call to Axes.autoscale_view.
Axes.get_autoscalex_on Return whether the x-axis is autoscaled.
Axes.set_autoscaley_on Set whether the y-axis is autoscaled on the next draw or call to Axes.autoscale_view.
Axes.get_autoscaley_on Return whether the y-axis is autoscaled.     Aspect ratio
Axes.apply_aspect Adjust the Axes for a specified data aspect ratio.
Axes.set_aspect Set the aspect ratio of the axes scaling, i.e. y/x-scale.
Axes.get_aspect Return the aspect ratio of the axes scaling.
Axes.set_box_aspect Set the Axes box aspect, i.e. the ratio of height to width.
Axes.get_box_aspect Return the Axes box aspect, i.e. the ratio of height to width.
Axes.set_adjustable Set how the Axes adjusts to achieve the required aspect ratio.
Axes.get_adjustable Return whether the Axes will adjust its physical dimension ('box') or its data limits ('datalim') to achieve the desired aspect ratio.     Ticks and tick labels
Axes.set_xticks Set the xaxis' tick locations and optionally labels.
Axes.get_xticks Return the xaxis' tick locations in data coordinates.
Axes.set_xticklabels Set the xaxis' labels with list of string labels.
Axes.get_xticklabels Get the xaxis' tick labels.
Axes.get_xmajorticklabels Return the xaxis' major tick labels, as a list of Text.
Axes.get_xminorticklabels Return the xaxis' minor tick labels, as a list of Text.
Axes.get_xgridlines Return the xaxis' grid lines as a list of Line2Ds.
Axes.get_xticklines Return the xaxis' tick lines as a list of Line2Ds.
Axes.xaxis_date Set up axis ticks and labels to treat data along the xaxis as dates.
Axes.set_yticks Set the yaxis' tick locations and optionally labels.
Axes.get_yticks Return the yaxis' tick locations in data coordinates.
Axes.set_yticklabels Set the yaxis' labels with list of string labels.
Axes.get_yticklabels Get the yaxis' tick labels.
Axes.get_ymajorticklabels Return the yaxis' major tick labels, as a list of Text.
Axes.get_yminorticklabels Return the yaxis' minor tick labels, as a list of Text.
Axes.get_ygridlines Return the yaxis' grid lines as a list of Line2Ds.
Axes.get_yticklines Return the yaxis' tick lines as a list of Line2Ds.
Axes.yaxis_date Set up axis ticks and labels to treat data along the yaxis as dates.
Axes.minorticks_off Remove minor ticks from the Axes.
Axes.minorticks_on Display minor ticks on the Axes.
Axes.ticklabel_format Configure the ScalarFormatter used by default for linear axes.
Axes.tick_params Change the appearance of ticks, tick labels, and gridlines.
Axes.locator_params Control behavior of major tick locators.      Units
Axes.convert_xunits Convert x using the unit type of the xaxis.
Axes.convert_yunits Convert y using the unit type of the yaxis.
Axes.have_units Return whether units are set on any axis.     Adding artists
Axes.add_artist Add an Artist to the Axes; return the artist.
Axes.add_child_axes Add an AxesBase to the Axes' children; return the child Axes.
Axes.add_collection Add a Collection to the Axes; return the collection.
Axes.add_container Add a Container to the axes' containers; return the container.
Axes.add_image Add an AxesImage to the Axes; return the image.
Axes.add_line Add a Line2D to the Axes; return the line.
Axes.add_patch Add a Patch to the Axes; return the patch.
Axes.add_table Add a Table to the Axes; return the table.     Twinning and sharing
Axes.twinx Create a twin Axes sharing the xaxis.
Axes.twiny Create a twin Axes sharing the yaxis.
Axes.sharex Share the x-axis with other.
Axes.sharey Share the y-axis with other.
Axes.get_shared_x_axes Return a reference to the shared axes Grouper object for x axes.
Axes.get_shared_y_axes Return a reference to the shared axes Grouper object for y axes.     Axes position
Axes.get_anchor Get the anchor location.
Axes.set_anchor Define the anchor location.
Axes.get_axes_locator Return the axes_locator.
Axes.set_axes_locator Set the Axes locator.
Axes.reset_position Reset the active position to the original position.
Axes.get_position Return the position of the Axes within the figure as a Bbox.
Axes.set_position Set the Axes position.     Async/event based
Axes.stale Whether the artist is 'stale' and needs to be re-drawn for the output to match the internal state of the artist.
Axes.pchanged Call all of the registered callbacks.
Axes.add_callback Add a callback function that will be called whenever one of the Artist's properties changes.
Axes.remove_callback Remove a callback based on its observer id.     Interactive
Axes.can_pan Return whether this Axes supports any pan/zoom button functionality.
Axes.can_zoom Return whether this Axes supports the zoom box button functionality.
Axes.get_navigate Get whether the Axes responds to navigation commands.
Axes.set_navigate Set whether the Axes responds to navigation toolbar commands.
Axes.get_navigate_mode Get the navigation toolbar button status: 'PAN', 'ZOOM', or None.
Axes.set_navigate_mode Set the navigation toolbar button status.
Axes.start_pan Called when a pan operation has started.
Axes.drag_pan Called when the mouse moves during a pan operation.
Axes.end_pan Called when a pan operation completes (when the mouse button is up.)
Axes.format_coord Return a format string formatting the x, y coordinates.
Axes.format_cursor_data Return a string representation of data.
Axes.format_xdata Return x formatted as an x-value.
Axes.format_ydata Return y formatted as an y-value.
Axes.mouseover If this property is set to True, the artist will be queried for custom context information when the mouse cursor moves over it.
Axes.in_axes Return whether the given event (in display coords) is in the Axes.
Axes.contains Test whether the artist contains the mouse event.
Axes.contains_point Return whether point (pair of pixel coordinates) is inside the axes patch.
Axes.get_cursor_data Return the cursor data for a given event.     Children
Axes.get_children Return a list of the child Artists of this Artist.
Axes.get_images Return a list of AxesImages contained by the Axes.
Axes.get_lines Return a list of lines contained by the Axes.
Axes.findobj Find artist objects.     Drawing
Axes.draw Draw the Artist (and its children) using the given renderer.
Axes.draw_artist Efficiently redraw a single artist.
Axes.redraw_in_frame Efficiently redraw Axes data, but not axis ticks, labels, etc.
Axes.get_renderer_cache
Axes.get_rasterization_zorder Return the zorder value below which artists will be rasterized.
Axes.set_rasterization_zorder Set the zorder threshold for rasterization for vector graphics output.
Axes.get_window_extent Return the Axes bounding box in display space; args and kwargs are empty.
Axes.get_tightbbox Return the tight bounding box of the axes, including axis and their decorators (xlabel, title, etc).     Projection Methods used by Axis that must be overridden for non-rectilinear Axes.
Axes.name
Axes.get_xaxis_transform Get the transformation used for drawing x-axis labels, ticks and gridlines.
Axes.get_yaxis_transform Get the transformation used for drawing y-axis labels, ticks and gridlines.
Axes.get_data_ratio Return the aspect ratio of the scaled data.
Axes.get_xaxis_text1_transform
 Returns
Axes.get_xaxis_text2_transform
 Returns
Axes.get_yaxis_text1_transform
 Returns
Axes.get_yaxis_text2_transform
 Returns       Other
Axes.zorder
Axes.get_default_bbox_extra_artists Return a default list of artists that are used for the bounding box calculation.
Axes.get_transformed_clip_path_and_affine Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.
Axes.has_data Return whether any artists have been added to the Axes.
Axes.set Set multiple properties at once.


classmatplotlib.axes.Axes(fig, rect, *, facecolor=None, frameon=True, sharex=None, sharey=None, label='', xscale=None, yscale=None, box_aspect=None, **kwargs)[source]

Bases: matplotlib.axes._base._AxesBase The Axes contains most of the figure elements: Axis, Tick, Line2D, Text, Polygon, etc., and sets the coordinate system. The Axes instance supports callbacks through a callbacks attribute which is a CallbackRegistry instance. The events you can connect to are 'xlim_changed' and 'ylim_changed' and the callback will be called with func(ax) where ax is the Axes instance.  Attributes

dataLimBbox

The bounding box enclosing all data displayed in the Axes.
viewLimBbox

The view limits in data coordinates.     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.


matplotlib.axes.Axes.acorr   Axes.acorr(x, *, data=None, **kwargs)[source]

Plot the autocorrelation of x.  Parameters

xarray-like

detrendcallable, default: mlab.detrend_none (no detrending)

A detrending function applied to x. It must have the signature detrend(x: np.ndarray) -> np.ndarray

normedbool, default: True

If True, input vectors are normalised to unit length.
usevlinesbool, default: True

Determines the plot style. If True, vertical lines are plotted from 0 to the acorr value using Axes.vlines. Additionally, a horizontal line is plotted at y=0 using Axes.axhline. If False, markers are plotted at the acorr values using Axes.plot.
maxlagsint, default: 10

Number of lags to show. If None, will return all 2 * len(x) - 1 lags.    Returns

lagsarray (length 2*maxlags+1)

The lag vector.
carray (length 2*maxlags+1)

The auto correlation vector.
lineLineCollection or Line2D

Artist added to the Axes of the correlation:
LineCollection if usevlines is True.
Line2D if usevlines is False.
bLine2D or None

Horizontal line at 0 if usevlines is True None usevlines is False.    Other Parameters

linestyleLine2D property, optional

The linestyle for plotting the data points. Only used if usevlines is False.
markerstr, default: 'o'

The marker for plotting the data points. Only used if usevlines is False.
dataindexable object, optional

If given, the following parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception): x  **kwargs

Additional parameters are passed to Axes.vlines and Axes.axhline if usevlines is True; otherwise they are passed to Axes.plot.     Notes The cross correlation is performed with numpy.correlate with mode = "full".
  Examples using matplotlib.axes.Axes.acorr

   Cross- and Auto-Correlation Demo


matplotlib.axes.Axes.add_artist   Axes.add_artist(a)[source]

Add an Artist to the Axes; return the artist. Use add_artist only for artists for which there is no dedicated "add" method; and if necessary, use a method such as update_datalim to manually update the dataLim if the artist is to be included in autoscaling. If no transform has been specified when creating the artist (e.g. artist.get_transform() == None) then the transform is set to ax.transData.
  Examples using matplotlib.axes.Axes.add_artist

   Scatter plots with a legend

   BboxImage Demo

   Bar of pie

   Annotating Plots

   AnnotationBbox demo

   Using a text as a Path

   Ellipse Demo

   Anchored Direction Arrow

   Axes Grid2

   Inset Locator Demo2

   Simple Anchored Artists

   Anatomy of a figure

   Anchored Artists

   Artist tests

   Anchored Box04

   Annotate Explain

   Connect Simple01

   Simple Annotate01

   Simple Legend02

   Legend guide

   Annotations


matplotlib.axes.Axes.add_callback   Axes.add_callback(func)[source]

Add a callback function that will be called whenever one of the Artist's properties changes.  Parameters

funccallable

The callback function. It must have the signature: def func(artist: Artist) -> Any
 where artist is the calling Artist. Return values may exist but are ignored.    Returns
 int

The observer id associated with the callback. This id can be used for removing the callback with remove_callback later.      See also  remove_callback


matplotlib.axes.Axes.add_child_axes   Axes.add_child_axes(ax)[source]

Add an AxesBase to the Axes' children; return the child Axes. This is the lowlevel version. See axes.Axes.inset_axes.


matplotlib.axes.Axes.add_collection   Axes.add_collection(collection, autolim=True)[source]

Add a Collection to the Axes; return the collection.
  Examples using matplotlib.axes.Axes.add_collection

   EventCollection Demo

   Using span_where

   Creating boxes from error bars using PatchCollection

   Reference for Matplotlib artists

   Line, Poly and RegularPoly Collection with autoscaling

   Ellipse Collection

   Line Collection

   Circles, Wedges and Polygons

   Lasso Demo

   MRI With EEG

   Artist tests

   Autoscaling


matplotlib.axes.Axes.add_container   Axes.add_container(container)[source]

Add a Container to the axes' containers; return the container.


matplotlib.axes.Axes.add_image   Axes.add_image(image)[source]

Add an AxesImage to the Axes; return the image.
  Examples using matplotlib.axes.Axes.add_image

   Image Nonuniform


matplotlib.axes.Axes.add_line   Axes.add_line(line)[source]

Add a Line2D to the Axes; return the line.
  Examples using matplotlib.axes.Axes.add_line

   Artist within an artist

   Reference for Matplotlib artists

   Artist tests

   Artist tutorial


matplotlib.axes.Axes.add_patch   Axes.add_patch(p)[source]

Add a Patch to the Axes; return the patch.
  Examples using matplotlib.axes.Axes.add_patch

   Curve with error band

   Image Demo

   Axes box aspect

   Controlling view limits using margins and sticky_edges

   Boxplots

   Plot a confidence ellipse of a two-dimensional dataset

   Annotating Plots

   Precise text layout

   Compound path

   Dolphins

   Mmh Donuts!!!

   Drawing fancy boxes

   Hatch style reference

   PathPatch object

   Bezier Curve

   ggplot style sheet

   Inset Locator Demo

   Firefox

   Integral as the area under a curve

   Looking Glass

   Path Editor

   Poly Editor

   Trifinder Event Demo

   Viewlims

   Changing colors of lines intersecting a box

   Building histograms using Rectangles and PolyCollections

   Packed-bubble chart

   SVG Filter Pie

   TickedStroke patheffect

   Draw flat objects in 3D plot

   Artist tests

   Ellipse With Units

   Artist tutorial

   Legend guide

   Path Tutorial

   Transformations Tutorial

   Specifying Colors

   Text properties and layout


matplotlib.axes.Axes.add_table   Axes.add_table(tab)[source]

Add a Table to the Axes; return the table.


matplotlib.axes.Axes.angle_spectrum   Axes.angle_spectrum(x, Fs=None, Fc=None, window=None, pad_to=None, sides=None, *, data=None, **kwargs)[source]

Plot the angle spectrum. Compute the angle spectrum (wrapped phase spectrum) of x. Data is padded to a length of pad_to and the windowing function window is applied to the signal.  Parameters

x1-D array or sequence

Array or sequence containing the data.
Fsfloat, default: 2

The sampling frequency (samples per time unit). It is used to calculate the Fourier frequencies, freqs, in cycles per time unit.
windowcallable or ndarray, default: window_hanning

A function or a vector of length NFFT. To create window vectors see window_hanning, window_none, numpy.blackman, numpy.hamming, numpy.bartlett, scipy.signal, scipy.signal.get_window, etc. If a function is passed as the argument, it must take a data segment as an argument and return the windowed version of the segment.
sides{'default', 'onesided', 'twosided'}, optional

Which sides of the spectrum to return. 'default' is one-sided for real data and two-sided for complex data. 'onesided' forces the return of a one-sided spectrum, while 'twosided' forces two-sided.
pad_toint, optional

The number of points to which the data segment is padded when performing the FFT. While not increasing the actual resolution of the spectrum (the minimum distance between resolvable peaks), this can give more points in the plot, allowing for more detail. This corresponds to the n parameter in the call to fft(). The default is None, which sets pad_to equal to the length of the input signal (i.e. no padding).
Fcint, default: 0

The center frequency of x, which offsets the x extents of the plot to reflect the frequency range used when a signal is acquired and then filtered and downsampled to baseband.    Returns

spectrum1-D array

The values for the angle spectrum in radians (real valued).
freqs1-D array

The frequencies corresponding to the elements in spectrum.
lineLine2D

The line created by this function.    Other Parameters

dataindexable object, optional

If given, the following parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception): x  **kwargs

Keyword arguments control the Line2D properties:
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 color
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
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'}
transform unknown
url str
visible bool
xdata 1D array
ydata 1D array
zorder float        See also  magnitude_spectrum

Plots the magnitudes of the corresponding frequencies.  phase_spectrum

Plots the unwrapped version of this function.  specgram

Can plot the angle spectrum of segments within the signal in a colormap.


matplotlib.axes.Axes.annotate   Axes.annotate(text, xy, *args, **kwargs)[source]

Annotate the point xy with text text. In the simplest form, the text is placed at xy. Optionally, the text can be displayed in another position xytext. An arrow pointing from the text to the annotated point xy can then be added by defining arrowprops.  Parameters

textstr

The text of the annotation.
xy(float, float)

The point (x, y) to annotate. The coordinate system is determined by xycoords.
xytext(float, float), default: xy

The position (x, y) to place the text at. The coordinate system is determined by textcoords.
xycoordsstr or Artist or Transform or callable or (float, float), default: 'data'

The coordinate system that xy is given in. The following types of values are supported:
One of the following strings:
Value Description
'figure points' Points from the lower left of the figure
'figure pixels' Pixels from the lower left of the figure
'figure fraction' Fraction of figure from lower left
'subfigure points' Points from the lower left of the subfigure
'subfigure pixels' Pixels from the lower left of the subfigure
'subfigure fraction' Fraction of subfigure from lower left
'axes points' Points from lower left corner of axes
'axes pixels' Pixels from lower left corner of axes
'axes fraction' Fraction of axes from lower left
'data' Use the coordinate system of the object being annotated (default)
'polar' (theta, r) if not native 'data' coordinates   Note that 'subfigure pixels' and 'figure pixels' are the same for the parent figure, so users who want code that is usable in a subfigure can use 'subfigure pixels'.  An Artist: xy is interpreted as a fraction of the artist's Bbox. E.g. (0, 0) would be the lower left corner of the bounding box and (0.5, 1) would be the center top of the bounding box. A Transform to transform xy to screen coordinates.
A function with one of the following signatures: def transform(renderer) -> Bbox
def transform(renderer) -> Transform
 where renderer is a RendererBase subclass. The result of the function is interpreted like the Artist and Transform cases above.  A tuple (xcoords, ycoords) specifying separate coordinate systems for x and y. xcoords and ycoords must each be of one of the above described types.  See Advanced Annotations for more details.
textcoordsstr or Artist or Transform or callable or (float, float), default: value of xycoords

The coordinate system that xytext is given in. All xycoords values are valid as well as the following strings:
Value Description
'offset points' Offset (in points) from the xy value
'offset pixels' Offset (in pixels) from the xy value
arrowpropsdict, optional

The properties used to draw a FancyArrowPatch arrow between the positions xy and xytext. Defaults to None, i.e. no arrow is drawn. For historical reasons there are two different ways to specify arrows, "simple" and "fancy": Simple arrow: If arrowprops does not contain the key 'arrowstyle' the allowed keys are:
Key Description
width The width of the arrow in points
headwidth The width of the base of the arrow head in points
headlength The length of the arrow head in points
shrink Fraction of total length to shrink from both ends
? Any key to matplotlib.patches.FancyArrowPatch   The arrow is attached to the edge of the text box, the exact position (corners or centers) depending on where it's pointing to. Fancy arrow: This is used if 'arrowstyle' is provided in the arrowprops. Valid keys are the following FancyArrowPatch parameters:
Key Description
arrowstyle the arrow style
connectionstyle the connection style
relpos see below; default is (0.5, 0.5)
patchA default is bounding box of the text
patchB default is None
shrinkA default is 2 points
shrinkB default is 2 points
mutation_scale default is text size (in points)
mutation_aspect default is 1.
? any key for matplotlib.patches.PathPatch   The exact starting point position of the arrow is defined by relpos. It's a tuple of relative coordinates of the text box, where (0, 0) is the lower left corner and (1, 1) is the upper right corner. Values <0 and >1 are supported and specify points outside the text box. By default (0.5, 0.5) the starting point is centered in the text box.
annotation_clipbool or None, default: None

Whether to draw the annotation when the annotation point xy is outside the axes area.  If True, the annotation will only be drawn when xy is within the axes. If False, the annotation will always be drawn. If None, the annotation will only be drawn when xy is within the axes and xycoords is 'data'.   **kwargs

Additional kwargs are passed to Text.    Returns
 Annotation
    See also  Advanced Annotations

  Examples using matplotlib.axes.Axes.annotate

   Broken Barh

   Hat graph

   Creating a timeline with lines, dates, and text

   Combining two subplots using subplots and GridSpec

   Labeling a pie and a donut

   Scale invariant angle label

   Annotating Plots

   Annotation arrow style reference

   Rendering math equations using TeX

   Annotate Transform

   Annotating a plot

   Annotation Polar

   Text Commands

   Mmh Donuts!!!

   axis_direction demo

   Simple Axis Pad

   XKCD

   Patheffect Demo

   Annotation with units

   Annotate Explain

   Annotate Simple01

   Annotate Simple02

   Annotate Simple03

   Annotate Simple04

   Annotate Simple Coord01

   Annotate Simple Coord02

   Annotate Simple Coord03

   Connection styles for annotations

   Simple Annotate01

   Basic Usage

   Faster rendering by using blitting

   Transformations Tutorial

   Text in Matplotlib Plots

   Annotations


matplotlib.axes.Axes.apply_aspect   Axes.apply_aspect(position=None)[source]

Adjust the Axes for a specified data aspect ratio. Depending on get_adjustable this will modify either the Axes box (position) or the view limits. In the former case, get_anchor will affect the position.  See also  matplotlib.axes.Axes.set_aspect

For a description of aspect ratio handling.  matplotlib.axes.Axes.set_adjustable

Set how the Axes adjusts to achieve the required aspect ratio.  matplotlib.axes.Axes.set_anchor

Set the position in case of extra space.    Notes This is called automatically when each Axes is drawn. You may need to call it yourself if you need to update the Axes position and/or view limits before the Figure is drawn.


matplotlib.axes.Axes.arrow   Axes.arrow(x, y, dx, dy, **kwargs)[source]

Add an arrow to the Axes. This draws an arrow from (x, y) to (x+dx, y+dy).  Parameters

x, yfloat

The x and y coordinates of the arrow base.
dx, dyfloat

The length of the arrow along x and y direction.
widthfloat, default: 0.001

Width of full arrow tail.
length_includes_headbool, default: False

True if head is to be counted in calculating the length.
head_widthfloat or None, default: 3*width

Total width of the full arrow head.
head_lengthfloat or None, default: 1.5*head_width

Length of arrow head.
shape{'full', 'left', 'right'}, default: 'full'

Draw the left-half, right-half, or full arrow.
overhangfloat, default: 0

Fraction that the arrow is swept back (0 overhang means triangular shape). Can be negative or greater than one.
head_starts_at_zerobool, default: False

If True, the head starts being drawn at coordinate 0 instead of ending at coordinate 0.  **kwargs

Patch properties:
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 unknown
animated bool
antialiased or aa bool or None
capstyle CapStyle or {'butt', 'projecting', 'round'}
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color color
edgecolor or ec color or None
facecolor or fc color or None
figure Figure
fill bool
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float or None
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
zorder float      Returns
 FancyArrow

The created FancyArrow object.     Notes The resulting arrow is affected by the Axes aspect ratio and limits. This may produce an arrow whose head is not square with its stem. To create an arrow whose head is square with its stem, use annotate() for example: >>> ax.annotate("", xy=(0.5, 0.5), xytext=(0, 0),
...             arrowprops=dict(arrowstyle="->"))

  Examples using matplotlib.axes.Axes.arrow

   Arrow Demo


matplotlib.axes.Axes.autoscale   Axes.autoscale(enable=True, axis='both', tight=None)[source]

Autoscale the axis view to the data (toggle). Convenience method for simple axis view autoscaling. It turns autoscaling on or off, and then, if autoscaling for either axis is on, it performs the autoscaling on the specified axis or Axes.  Parameters

enablebool or None, default: True

True turns autoscaling on, False turns it off. None leaves the autoscaling state unchanged.
axis{'both', 'x', 'y'}, default: 'both'

Which axis to operate on.
tightbool or None, default: None

If True, first set the margins to zero. Then, this argument is forwarded to autoscale_view (regardless of its value); see the description of its behavior there.
  Examples using matplotlib.axes.Axes.autoscale

   Axes box aspect

   Autoscaling


matplotlib.axes.Axes.autoscale_view   Axes.autoscale_view(tight=None, scalex=True, scaley=True)[source]

Autoscale the view limits using the data limits.  Parameters

tightbool or None

If True, only expand the axis limits using the margins. Note that unlike for autoscale, tight=True does not set the margins to zero. If False and rcParams["axes.autolimit_mode"] (default: 'data') is 'round_numbers', then after expansion by the margins, further expand the axis limits using the axis major locator. If None (the default), reuse the value set in the previous call to autoscale_view (the initial value is False, but the default style sets rcParams["axes.autolimit_mode"] (default: 'data') to 'data', in which case this behaves like True).
scalexbool, default: True

Whether to autoscale the x axis.
scaleybool, default: True

Whether to autoscale the y axis.     Notes The autoscaling preserves any preexisting axis direction reversal. The data limits are not updated automatically when artist data are changed after the artist has been added to an Axes instance. In that case, use matplotlib.axes.Axes.relim() prior to calling autoscale_view. If the views of the Axes are fixed, e.g. via set_xlim, they will not be changed by autoscale_view(). See matplotlib.axes.Axes.autoscale() for an alternative.
  Examples using matplotlib.axes.Axes.autoscale_view

   Line, Poly and RegularPoly Collection with autoscaling

   Compound path

   Ellipse Collection

   Packed-bubble chart

   Group barchart with units

   Textbox

   Autoscaling


matplotlib.axes.Axes.axhline   Axes.axhline(y=0, xmin=0, xmax=1, **kwargs)[source]

Add a horizontal line across the axis.  Parameters

yfloat, default: 0

y position in data coordinates of the horizontal line.
xminfloat, default: 0

Should be between 0 and 1, 0 being the far left of the plot, 1 the far right of the plot.
xmaxfloat, default: 1

Should be between 0 and 1, 0 being the far left of the plot, 1 the far right of the plot.    Returns
 Line2D
  Other Parameters
 **kwargs

Valid keyword arguments are Line2D properties, with the exception of 'transform':
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 color
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
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'}
transform unknown
url str
visible bool
xdata 1D array
ydata 1D array
zorder float        See also  hlines

Add horizontal lines in data coordinates.  axhspan

Add a horizontal span (rectangle) across the axis.  axline

Add a line with an arbitrary slope.    Examples
draw a thick red hline at 'y' = 0 that spans the xrange: >>> axhline(linewidth=4, color='r')

draw a default hline at 'y' = 1 that spans the xrange: >>> axhline(y=1)

draw a default hline at 'y' = .5 that spans the middle half of the xrange: >>> axhline(y=.5, xmin=0.25, xmax=0.75)

  Examples using matplotlib.axes.Axes.axhline

   Bar Label Demo

   Filling the area between lines

   Using span_where

   axhspan Demo

   Plot a confidence ellipse of a two-dimensional dataset

   Multiline

   Usetex Baseline Test

   Cross hair cursor

   Transformations Tutorial


matplotlib.axes.Axes.axhspan   Axes.axhspan(ymin, ymax, xmin=0, xmax=1, **kwargs)[source]

Add a horizontal span (rectangle) across the Axes. The rectangle spans from ymin to ymax vertically, and, by default, the whole x-axis horizontally. The x-span can be set using xmin (default: 0) and xmax (default: 1) which are in axis units; e.g. xmin = 0.5 always refers to the middle of the x-axis regardless of the limits set by set_xlim.  Parameters

yminfloat

Lower y-coordinate of the span, in data units.
ymaxfloat

Upper y-coordinate of the span, in data units.
xminfloat, default: 0

Lower x-coordinate of the span, in x-axis (0-1) units.
xmaxfloat, default: 1

Upper x-coordinate of the span, in x-axis (0-1) units.    Returns
 Polygon

Horizontal span (rectangle) from (xmin, ymin) to (xmax, ymax).    Other Parameters

**kwargsPolygon properties

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 or None
capstyle CapStyle or {'butt', 'projecting', 'round'}
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
closed bool
color color
edgecolor or ec color or None
facecolor or fc color or None
figure Figure
fill bool
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float or None
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
xy (N, 2) array-like
zorder float        See also  axvspan

Add a vertical span across the Axes.
  Examples using matplotlib.axes.Axes.axhspan

   axhspan Demo

   Transformations Tutorial


matplotlib.axes.Axes.axis   Axes.axis(*args, emit=True, **kwargs)[source]

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

  Examples using matplotlib.axes.Axes.axis

   Clipping images with patches

   Basic pie chart

   Bar of pie

   Hatch style reference

   PathPatch object

   ggplot style sheet

   Parasite Simple2

   Simple Axisline4

   Axis Direction

   axis_direction demo

   Axis line styles

   mpl_toolkits.axisartist.floating_axes features

   Parasite Axes demo

   Parasite axis demo

   Ticklabel alignment

   Ticklabel direction

   Simple Axis Direction01

   Simple Axis Direction03

   Simple Axis Pad

   Custom spines with axisartist

   Simple Axisline

   Simple Axisline3

   Packed-bubble chart

   TickedStroke patheffect

   MRI

   MRI With EEG

   Basic Usage

   Specifying Colors

   Text in Matplotlib Plots


matplotlib.axes.Axes.axline   Axes.axline(xy1, xy2=None, *, slope=None, **kwargs)[source]

Add an infinitely long straight line. The line can be defined either by two points xy1 and xy2, or by one point xy1 and a slope. This draws a straight line "on the screen", regardless of the x and y scales, and is thus also suitable for drawing exponential decays in semilog plots, power laws in loglog plots, etc. However, slope should only be used with linear scales; It has no clear meaning for all other scales, and thus the behavior is undefined. Please specify the line using the points xy1, xy2 for non-linear scales. The transform keyword argument only applies to the points xy1, xy2. The slope (if given) is always in data coordinates. This can be used e.g. with ax.transAxes for drawing grid lines with a fixed slope.  Parameters

xy1, xy2(float, float)

Points for the line to pass through. Either xy2 or slope has to be given.
slopefloat, optional

The slope of the line. Either xy2 or slope has to be given.    Returns
 Line2D
  Other Parameters
 **kwargs

Valid kwargs are Line2D properties
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 color
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
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'}
transform unknown
url str
visible bool
xdata 1D array
ydata 1D array
zorder float        See also  axhline

for horizontal lines  axvline

for vertical lines    Examples Draw a thick red line passing through (0, 0) and (1, 1): >>> axline((0, 0), (1, 1), linewidth=4, color='r')

  Examples using matplotlib.axes.Axes.axline

   axhspan Demo

   Anscombe's quartet


matplotlib.axes.Axes.axvline   Axes.axvline(x=0, ymin=0, ymax=1, **kwargs)[source]

Add a vertical line across the Axes.  Parameters

xfloat, default: 0

x position in data coordinates of the vertical line.
yminfloat, default: 0

Should be between 0 and 1, 0 being the bottom of the plot, 1 the top of the plot.
ymaxfloat, default: 1

Should be between 0 and 1, 0 being the bottom of the plot, 1 the top of the plot.    Returns
 Line2D
  Other Parameters
 **kwargs

Valid keyword arguments are Line2D properties, with the exception of 'transform':
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 color
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
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'}
transform unknown
url str
visible bool
xdata 1D array
ydata 1D array
zorder float        See also  vlines

Add vertical lines in data coordinates.  axvspan

Add a vertical span (rectangle) across the axis.  axline

Add a line with an arbitrary slope.    Examples
draw a thick red vline at x = 0 that spans the yrange: >>> axvline(linewidth=4, color='r')

draw a default vline at x = 1 that spans the yrange: >>> axvline(x=1)

draw a default vline at x = .5 that spans the middle half of the yrange: >>> axvline(x=.5, ymin=0.25, ymax=0.75)

  Examples using matplotlib.axes.Axes.axvline

   axhspan Demo

   Plot a confidence ellipse of a two-dimensional dataset

   Usetex Baseline Test

   Cross hair cursor

   SkewT-logP diagram: using transforms and custom projections

   The Lifecycle of a Plot

   Transformations Tutorial


matplotlib.axes.Axes.axvspan   Axes.axvspan(xmin, xmax, ymin=0, ymax=1, **kwargs)[source]

Add a vertical span (rectangle) across the Axes. The rectangle spans from xmin to xmax horizontally, and, by default, the whole y-axis vertically. The y-span can be set using ymin (default: 0) and ymax (default: 1) which are in axis units; e.g. ymin = 0.5 always refers to the middle of the y-axis regardless of the limits set by set_ylim.  Parameters

xminfloat

Lower x-coordinate of the span, in data units.
xmaxfloat

Upper x-coordinate of the span, in data units.
yminfloat, default: 0

Lower y-coordinate of the span, in y-axis units (0-1).
ymaxfloat, default: 1

Upper y-coordinate of the span, in y-axis units (0-1).    Returns
 Polygon

Vertical span (rectangle) from (xmin, ymin) to (xmax, ymax).    Other Parameters

**kwargsPolygon properties

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 or None
capstyle CapStyle or {'butt', 'projecting', 'round'}
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
closed bool
color color
edgecolor or ec color or None
facecolor or fc color or None
figure Figure
fill bool
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float or None
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
xy (N, 2) array-like
zorder float        See also  axhspan

Add a horizontal span across the Axes.    Examples Draw a vertical, green, translucent rectangle from x = 1.25 to x = 1.55 that spans the yrange of the Axes. >>> axvspan(1.25, 1.55, facecolor='g', alpha=0.5)

  Examples using matplotlib.axes.Axes.axvspan

   axhspan Demo

   Transformations Tutorial


matplotlib.axes.Axes.bar   Axes.bar(x, height, width=0.8, bottom=None, *, align='center', data=None, **kwargs)[source]

Make a bar plot. The bars are positioned at x with the given alignment. Their dimensions are given by height and width. The vertical baseline is bottom (default 0). Many parameters can take either a single value applying to all bars or a sequence of values, one for each bar.  Parameters

xfloat or array-like

The x coordinates of the bars. See also align for the alignment of the bars to the coordinates.
heightfloat or array-like

The height(s) of the bars.
widthfloat or array-like, default: 0.8

The width(s) of the bars.
bottomfloat or array-like, default: 0

The y coordinate(s) of the bars bases.
align{'center', 'edge'}, default: 'center'

Alignment of the bars to the x coordinates:  'center': Center the base on the x positions. 'edge': Align the left edges of the bars with the x positions.  To align the bars on the right edge pass a negative width and align='edge'.    Returns
 BarContainer

Container with all the bars and optionally errorbars.    Other Parameters

colorcolor or list of color, optional

The colors of the bar faces.
edgecolorcolor or list of color, optional

The colors of the bar edges.
linewidthfloat or array-like, optional

Width of the bar edge(s). If 0, don't draw edges.
tick_labelstr or list of str, optional

The tick labels of the bars. Default: None (Use default numeric labels.)
xerr, yerrfloat or array-like of shape(N,) or shape(2, N), optional

If not None, add horizontal / vertical errorbars to the bar tips. The values are +/- sizes relative to the data:  scalar: symmetric +/- values for all bars shape(N,): symmetric +/- values for each bar shape(2, N): Separate - and + values for each bar. First row contains the lower errors, the second row contains the upper errors.
None: No errorbar. (Default)  See Different ways of specifying error bars for an example on the usage of xerr and yerr.
ecolorcolor or list of color, default: 'black'

The line color of the errorbars.
capsizefloat, default: rcParams["errorbar.capsize"] (default: 0.0)

The length of the error bar caps in points.
error_kwdict, optional

Dictionary of kwargs to be passed to the errorbar method. Values of ecolor or capsize defined here take precedence over the independent kwargs.
logbool, default: False

If True, set the y-axis to be log scale.
dataindexable object, optional

If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).
**kwargsRectangle properties

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
angle unknown
animated bool
antialiased or aa bool or None
bounds (left, bottom, width, height)
capstyle CapStyle or {'butt', 'projecting', 'round'}
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color color
edgecolor or ec color or None
facecolor or fc color or None
figure Figure
fill bool
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
height unknown
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float or None
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width unknown
x unknown
xy (float, float)
y unknown
zorder float        See also  barh

Plot a horizontal bar plot.    Notes Stacked bars can be achieved by passing individual bottom values per bar. See Stacked bar chart.
  Examples using matplotlib.axes.Axes.bar

   Bar Label Demo

   Stacked bar chart

   Grouped bar chart with labels

   Hat graph

   Bar of pie

   Nested pie charts

   Bar chart on polar axis

   Legend Demo

   ggplot style sheet

   mpl_toolkits.axisartist.floating_axes features

   XKCD

   Create 2D bar graphs in different planes

   Log Bar

   Custom Ticker1

   Group barchart with units

   Basic Usage

   Artist tutorial

   Path Tutorial

   bar(x, height) / barh(y, width)


matplotlib.axes.Axes.bar_label   Axes.bar_label(container, labels=None, *, fmt='%g', label_type='edge', padding=0, **kwargs)[source]

Label a bar plot. Adds labels to bars in the given BarContainer. You may need to adjust the axis limits to fit the labels.  Parameters

containerBarContainer

Container with all the bars and optionally errorbars, likely returned from bar or barh.
labelsarray-like, optional

A list of label texts, that should be displayed. If not given, the label texts will be the data values formatted with fmt.
fmtstr, default: '%g'

A format string for the label.
label_type{'edge', 'center'}, default: 'edge'

The label type. Possible values:  'edge': label placed at the end-point of the bar segment, and the value displayed will be the position of that end-point. 'center': label placed in the center of the bar segment, and the value displayed will be the length of that segment. (useful for stacked bars, i.e., Bar Label Demo)
paddingfloat, default: 0

Distance of label from the end of the bar, in points.  **kwargs

Any remaining keyword arguments are passed through to Axes.annotate.    Returns
 list of Text

A list of Text instances for the labels.
  Examples using matplotlib.axes.Axes.bar_label

   Bar Label Demo

   Grouped bar chart with labels


matplotlib.axes.Axes.barbs   Axes.barbs(*args, data=None, **kwargs)[source]

Plot a 2D field of barbs. Call signature: barbs([X, Y], U, V, [C], **kw)
 Where X, Y define the barb locations, U, V define the barb directions, and C optionally sets the color. All arguments may be 1D or 2D. U, V, C may be masked arrays, but masked X, Y are not supported at present. Barbs are traditionally used in meteorology as a way to plot the speed and direction of wind observations, but can technically be used to plot any two dimensional vector quantity. As opposed to arrows, which give vector magnitude by the length of the arrow, the barbs give more quantitative information about the vector magnitude by putting slanted lines or a triangle for various increments in magnitude, as show schematically below: :                   /\    \
:                  /  \    \
:                 /    \    \    \
:                /      \    \    \
:               ------------------------------
 The largest increment is given by a triangle (or "flag"). After those come full lines (barbs). The smallest increment is a half line. There is only, of course, ever at most 1 half line. If the magnitude is small and only needs a single half-line and no full lines or triangles, the half-line is offset from the end of the barb so that it can be easily distinguished from barbs with a single full line. The magnitude for the barb shown above would nominally be 65, using the standard increments of 50, 10, and 5. See also https://en.wikipedia.org/wiki/Wind_barb.  Parameters

X, Y1D or 2D array-like, optional

The x and y coordinates of the barb locations. See pivot for how the barbs are drawn to the x, y positions. If not given, they will be generated as a uniform integer meshgrid based on the dimensions of U and V. If X and Y are 1D but U, V are 2D, X, Y are expanded to 2D using X, Y = np.meshgrid(X, Y). In this case len(X) and len(Y) must match the column and row dimensions of U and V.
U, V1D or 2D array-like

The x and y components of the barb shaft.
C1D or 2D array-like, optional

Numeric data that defines the barb colors by colormapping via norm and cmap. This does not support explicit colors. If you want to set colors directly, use barbcolor instead.
lengthfloat, default: 7

Length of the barb in points; the other parts of the barb are scaled against this.
pivot{'tip', 'middle'} or float, default: 'tip'

The part of the arrow that is anchored to the X, Y grid. The barb rotates about this point. This can also be a number, which shifts the start of the barb that many points away from grid point.
barbcolorcolor or color sequence

The color of all parts of the barb except for the flags. This parameter is analogous to the edgecolor parameter for polygons, which can be used instead. However this parameter will override facecolor.
flagcolorcolor or color sequence

The color of any flags on the barb. This parameter is analogous to the facecolor parameter for polygons, which can be used instead. However, this parameter will override facecolor. If this is not set (and C has not either) then flagcolor will be set to match barbcolor so that the barb has a uniform color. If C has been set, flagcolor has no effect.
sizesdict, optional

A dictionary of coefficients specifying the ratio of a given feature to the length of the barb. Only those values one wishes to override need to be included. These features include:  'spacing' - space between features (flags, full/half barbs) 'height' - height (distance from shaft to top) of a flag or full barb 'width' - width of a flag, twice the width of a full barb 'emptybarb' - radius of the circle used for low magnitudes
fill_emptybool, default: False

Whether the empty barbs (circles) that are drawn should be filled with the flag color. If they are not filled, the center is transparent.
roundingbool, default: True

Whether the vector magnitude should be rounded when allocating barb components. If True, the magnitude is rounded to the nearest multiple of the half-barb increment. If False, the magnitude is simply truncated to the next lowest multiple.
barb_incrementsdict, optional

A dictionary of increments specifying values to associate with different parts of the barb. Only those values one wishes to override need to be included.  'half' - half barbs (Default is 5) 'full' - full barbs (Default is 10) 'flag' - flags (default is 50)
flip_barbbool or array-like of bool, default: False

Whether the lines and flags should point opposite to normal. Normal behavior is for the barbs and lines to point right (comes from wind barbs having these features point towards low pressure in the Northern Hemisphere). A single value is applied to all barbs. Individual barbs can be flipped by passing a bool array of the same size as U and V.    Returns

barbsBarbs

  Other Parameters

dataindexable object, optional

If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).  **kwargs

The barbs can further be customized using PolyCollection keyword arguments:
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 array-like or scalar or None
animated bool
antialiased or aa or antialiaseds bool or list of bools
array array-like or None
capstyle CapStyle or {'butt', 'projecting', 'round'}
clim (vmin: float, vmax: float)
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
cmap Colormap or str or None
color color or list of rgba tuples
edgecolor or ec or edgecolors color or list of colors or 'face'
facecolor or facecolors or fc color or list of colors
figure Figure
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or dashes or linestyles or ls str or tuple or list thereof
linewidth or linewidths or lw float or list of floats
norm Normalize or None
offset_transform Transform
offsets (N, 2) or (2,) array-like
path_effects AbstractPathEffect
paths list of array-like
picker None or bool or float or callable
pickradius float
rasterized bool
sizes ndarray or None
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
urls list of str or None
verts list of array-like
verts_and_codes unknown
visible bool
zorder float
  Examples using matplotlib.axes.Axes.barbs

   Wind Barbs

   barbs(X, Y, U, V)


matplotlib.axes.Axes.barh   Axes.barh(y, width, height=0.8, left=None, *, align='center', **kwargs)[source]

Make a horizontal bar plot. The bars are positioned at y with the given alignment. Their dimensions are given by width and height. The horizontal baseline is left (default 0). Many parameters can take either a single value applying to all bars or a sequence of values, one for each bar.  Parameters

yfloat or array-like

The y coordinates of the bars. See also align for the alignment of the bars to the coordinates.
widthfloat or array-like

The width(s) of the bars.
heightfloat or array-like, default: 0.8

The heights of the bars.
leftfloat or array-like, default: 0

The x coordinates of the left sides of the bars.
align{'center', 'edge'}, default: 'center'

Alignment of the base to the y coordinates*:  'center': Center the bars on the y positions. 'edge': Align the bottom edges of the bars with the y positions.  To align the bars on the top edge pass a negative height and align='edge'.    Returns
 BarContainer

Container with all the bars and optionally errorbars.    Other Parameters

colorcolor or list of color, optional

The colors of the bar faces.
edgecolorcolor or list of color, optional

The colors of the bar edges.
linewidthfloat or array-like, optional

Width of the bar edge(s). If 0, don't draw edges.
tick_labelstr or list of str, optional

The tick labels of the bars. Default: None (Use default numeric labels.)
xerr, yerrfloat or array-like of shape(N,) or shape(2, N), optional

If not None, add horizontal / vertical errorbars to the bar tips. The values are +/- sizes relative to the data:  scalar: symmetric +/- values for all bars shape(N,): symmetric +/- values for each bar shape(2, N): Separate - and + values for each bar. First row contains the lower errors, the second row contains the upper errors.
None: No errorbar. (default)  See Different ways of specifying error bars for an example on the usage of xerr and yerr.
ecolorcolor or list of color, default: 'black'

The line color of the errorbars.
capsizefloat, default: rcParams["errorbar.capsize"] (default: 0.0)

The length of the error bar caps in points.
error_kwdict, optional

Dictionary of kwargs to be passed to the errorbar method. Values of ecolor or capsize defined here take precedence over the independent kwargs.
logbool, default: False

If True, set the x-axis to be log scale.
**kwargsRectangle properties

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
angle unknown
animated bool
antialiased or aa bool or None
bounds (left, bottom, width, height)
capstyle CapStyle or {'butt', 'projecting', 'round'}
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color color
edgecolor or ec color or None
facecolor or fc color or None
figure Figure
fill bool
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
height unknown
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or ls {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth or lw float or None
path_effects AbstractPathEffect
picker None or bool or float or callable
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
visible bool
width unknown
x unknown
xy (float, float)
y unknown
zorder float        See also  bar

Plot a vertical bar plot.    Notes Stacked bars can be achieved by passing individual left values per bar. See Discrete distribution as horizontal bar chart .
  Examples using matplotlib.axes.Axes.barh

   Bar Label Demo

   Horizontal bar chart

   Producing multiple histograms side by side

   The Lifecycle of a Plot


matplotlib.axes.Axes.boxplot   Axes.boxplot(x, notch=None, sym=None, vert=None, whis=None, positions=None, widths=None, patch_artist=None, bootstrap=None, usermedians=None, conf_intervals=None, meanline=None, showmeans=None, showcaps=None, showbox=None, showfliers=None, boxprops=None, labels=None, flierprops=None, medianprops=None, meanprops=None, capprops=None, whiskerprops=None, manage_ticks=True, autorange=False, zorder=None, *, data=None)[source]

Draw a box and whisker plot. The box extends from the first quartile (Q1) to the third quartile (Q3) of the data, with a line at the median. The whiskers extend from the box by 1.5x the inter-quartile range (IQR). Flier points are those past the end of the whiskers. See https://en.wikipedia.org/wiki/Box_plot for reference.      Q1-1.5IQR   Q1   median  Q3   Q3+1.5IQR
                  |-----:-----|
  o      |--------|     :     |--------|    o  o
                  |-----:-----|
flier             <----------->            fliers
                       IQR
  Parameters

xArray or a sequence of vectors.

The input data. If a 2D array, a boxplot is drawn for each column in x. If a sequence of 1D arrays, a boxplot is drawn for each array in x.
notchbool, default: False

Whether to draw a notched boxplot (True), or a rectangular boxplot (False). The notches represent the confidence interval (CI) around the median. The documentation for bootstrap describes how the locations of the notches are computed by default, but their locations may also be overridden by setting the conf_intervals parameter.  Note In cases where the values of the CI are less than the lower quartile or greater than the upper quartile, the notches will extend beyond the box, giving it a distinctive "flipped" appearance. This is expected behavior and consistent with other statistical visualization packages.
symstr, optional

The default symbol for flier points. An empty string ('') hides the fliers. If None, then the fliers default to 'b+'. More control is provided by the flierprops parameter.
vertbool, default: True

If True, draws vertical boxes. If False, draw horizontal boxes.
whisfloat or (float, float), default: 1.5

The position of the whiskers. If a float, the lower whisker is at the lowest datum above Q1 - whis*(Q3-Q1), and the upper whisker at the highest datum below Q3 + whis*(Q3-Q1), where Q1 and Q3 are the first and third quartiles. The default value of whis = 1.5 corresponds to Tukey's original definition of boxplots. If a pair of floats, they indicate the percentiles at which to draw the whiskers (e.g., (5, 95)). In particular, setting this to (0, 100) results in whiskers covering the whole range of the data. In the edge case where Q1 == Q3, whis is automatically set to (0, 100) (cover the whole range of the data) if autorange is True. Beyond the whiskers, data are considered outliers and are plotted as individual points.
bootstrapint, optional

Specifies whether to bootstrap the confidence intervals around the median for notched boxplots. If bootstrap is None, no bootstrapping is performed, and notches are calculated using a Gaussian-based asymptotic approximation (see McGill, R., Tukey, J.W., and Larsen, W.A., 1978, and Kendall and Stuart, 1967). Otherwise, bootstrap specifies the number of times to bootstrap the median to determine its 95% confidence intervals. Values between 1000 and 10000 are recommended.
usermedians1D array-like, optional

A 1D array-like of length len(x). Each entry that is not None forces the value of the median for the corresponding dataset. For entries that are None, the medians are computed by Matplotlib as normal.
conf_intervalsarray-like, optional

A 2D array-like of shape (len(x), 2). Each entry that is not None forces the location of the corresponding notch (which is only drawn if notch is True). For entries that are None, the notches are computed by the method specified by the other parameters (e.g., bootstrap).
positionsarray-like, optional

The positions of the boxes. The ticks and limits are automatically set to match the positions. Defaults to range(1, N+1) where N is the number of boxes to be drawn.
widthsfloat or array-like

The widths of the boxes. The default is 0.5, or 0.15*(distance
between extreme positions), if that is smaller.
patch_artistbool, default: False

If False produces boxes with the Line2D artist. Otherwise, boxes are drawn with Patch artists.
labelssequence, optional

Labels for each dataset (one per dataset).
manage_ticksbool, default: True

If True, the tick locations and labels will be adjusted to match the boxplot positions.
autorangebool, default: False

When True and the data are distributed such that the 25th and 75th percentiles are equal, whis is set to (0, 100) such that the whisker ends are at the minimum and maximum of the data.
meanlinebool, default: False

If True (and showmeans is True), will try to render the mean as a line spanning the full width of the box according to meanprops (see below). Not recommended if shownotches is also True. Otherwise, means will be shown as points.
zorderfloat, default: Line2D.zorder = 2

The zorder of the boxplot.    Returns
 dict

A dictionary mapping each component of the boxplot to a list of the Line2D instances created. That dictionary has the following keys (assuming vertical boxplots):
boxes: the main body of the boxplot showing the quartiles and the median's confidence intervals if enabled.
medians: horizontal lines at the median of each box.
whiskers: the vertical lines extending to the most extreme, non-outlier data points.
caps: the horizontal lines at the ends of the whiskers.
fliers: points representing data that extend beyond the whiskers (fliers).
means: points or lines representing the means.     Other Parameters

showcapsbool, default: True

Show the caps on the ends of whiskers.
showboxbool, default: True

Show the central box.
showfliersbool, default: True

Show the outliers beyond the caps.
showmeansbool, default: False

Show the arithmetic means.
cappropsdict, default: None

The style of the caps.
boxpropsdict, default: None

The style of the box.
whiskerpropsdict, default: None

The style of the whiskers.
flierpropsdict, default: None

The style of the fliers.
medianpropsdict, default: None

The style of the median.
meanpropsdict, default: None

The style of the mean.
dataindexable object, optional

If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).      See also  violinplot

Draw an estimate of the probability density function.
  Examples using matplotlib.axes.Axes.boxplot

   Box plots with custom fill colors

   Boxplots

   Boxplot Demo

   boxplot(X)


matplotlib.axes.Axes.broken_barh   Axes.broken_barh(xranges, yrange, *, data=None, **kwargs)[source]

Plot a horizontal sequence of rectangles. A rectangle is drawn for each element of xranges. All rectangles have the same vertical position and size defined by yrange. This is a convenience function for instantiating a BrokenBarHCollection, adding it to the Axes and autoscaling the view.  Parameters

xrangessequence of tuples (xmin, xwidth)

The x-positions and extends of the rectangles. For each tuple (xmin, xwidth) a rectangle is drawn from xmin to xmin + xwidth.
yrange(ymin, yheight)

The y-position and extend for all the rectangles.    Returns
 BrokenBarHCollection
  Other Parameters

dataindexable object, optional

If given, all parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception).
**kwargsBrokenBarHCollection properties

Each kwarg can be either a single argument applying to all rectangles, e.g.: facecolors='black'
 or a sequence of arguments over which is cycled, e.g.: facecolors=('black', 'blue')
 would create interleaving black and blue rectangles. Supported keywords:
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 array-like or scalar or None
animated bool
antialiased or aa or antialiaseds bool or list of bools
array array-like or None
capstyle CapStyle or {'butt', 'projecting', 'round'}
clim (vmin: float, vmax: float)
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
cmap Colormap or str or None
color color or list of rgba tuples
edgecolor or ec or edgecolors color or list of colors or 'face'
facecolor or facecolors or fc color or list of colors
figure Figure
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or dashes or linestyles or ls str or tuple or list thereof
linewidth or linewidths or lw float or list of floats
norm Normalize or None
offset_transform Transform
offsets (N, 2) or (2,) array-like
path_effects AbstractPathEffect
paths list of array-like
picker None or bool or float or callable
pickradius float
rasterized bool
sizes ndarray or None
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
urls list of str or None
verts list of array-like
verts_and_codes unknown
visible bool
zorder float
  Examples using matplotlib.axes.Axes.broken_barh

   Broken Barh


matplotlib.axes.Axes.bxp   Axes.bxp(bxpstats, positions=None, widths=None, vert=True, patch_artist=False, shownotches=False, showmeans=False, showcaps=True, showbox=True, showfliers=True, boxprops=None, whiskerprops=None, flierprops=None, medianprops=None, capprops=None, meanprops=None, meanline=False, manage_ticks=True, zorder=None)[source]

Drawing function for box and whisker plots. Make a box and whisker plot for each column of x or each vector in sequence x. The box extends from the lower to upper quartile values of the data, with a line at the median. The whiskers extend from the box to show the range of the data. Flier points are those past the end of the whiskers.  Parameters

bxpstatslist of dicts

A list of dictionaries containing stats for each boxplot. Required keys are:
med: Median (scalar).
q1, q3: First & third quartiles (scalars).
whislo, whishi: Lower & upper whisker positions (scalars).  Optional keys are:
mean: Mean (scalar). Needed if showmeans=True.
fliers: Data beyond the whiskers (array-like). Needed if showfliers=True.
cilo, cihi: Lower & upper confidence intervals about the median. Needed if shownotches=True.
label: Name of the dataset (str). If available, this will be used a tick label for the boxplot
positionsarray-like, default: [1, 2, ..., n]

The positions of the boxes. The ticks and limits are automatically set to match the positions.
widthsfloat or array-like, default: None

The widths of the boxes. The default is clip(0.15*(distance between extreme positions), 0.15, 0.5).
vertbool, default: True

If True (default), makes the boxes vertical. If False, makes horizontal boxes.
patch_artistbool, default: False

If False produces boxes with the Line2D artist. If True produces boxes with the Patch artist.
shownotches, showmeans, showcaps, showbox, showfliersbool

Whether to draw the CI notches, the mean value (both default to False), the caps, the box, and the fliers (all three default to True).
boxprops, whiskerprops, capprops, flierprops, medianprops, meanpropsdict, optional

Artist properties for the boxes, whiskers, caps, fliers, medians, and means.
meanlinebool, default: False

If True (and showmeans is True), will try to render the mean as a line spanning the full width of the box according to meanprops. Not recommended if shownotches is also True. Otherwise, means will be shown as points.
manage_ticksbool, default: True

If True, the tick locations and labels will be adjusted to match the boxplot positions.
zorderfloat, default: Line2D.zorder = 2

The zorder of the resulting boxplot.    Returns
 dict

A dictionary mapping each component of the boxplot to a list of the Line2D instances created. That dictionary has the following keys (assuming vertical boxplots):
boxes: main bodies of the boxplot showing the quartiles, and the median's confidence intervals if enabled.
medians: horizontal lines at the median of each box.
whiskers: vertical lines up to the last non-outlier data.
caps: horizontal lines at the ends of the whiskers.
fliers: points representing data beyond the whiskers (fliers).
means: points or lines representing the means.      Examples (Source code, png, pdf)    (png, pdf)


matplotlib.axes.Axes.can_pan   Axes.can_pan()[source]

Return whether this Axes supports any pan/zoom button functionality.


matplotlib.axes.Axes.can_zoom   Axes.can_zoom()[source]

Return whether this Axes supports the zoom box button functionality.


matplotlib.axes.Axes.cla   Axes.cla()[source]

Clear the Axes.
  Examples using matplotlib.axes.Axes.cla

   pyplot animation

   Data Browser


matplotlib.axes.Axes.clabel   Axes.clabel(CS, levels=None, **kwargs)[source]

Label a contour plot. Adds labels to line contours in given ContourSet.  Parameters

CSContourSet instance

Line contours to label.
levelsarray-like, optional

A list of level values, that should be labeled. The list must be a subset of CS.levels. If not given, all levels are labeled.  **kwargs

All other parameters are documented in clabel.
  Examples using matplotlib.axes.Axes.clabel

   Contour Demo

   Contour Label Demo

   Contourf Demo

   Contouring the solution space of optimizations

   Patheffect Demo

   TickedStroke patheffect


matplotlib.axes.Axes.clear   Axes.clear()[source]

Clear the Axes.


matplotlib.axes.Axes.cohere   Axes.cohere(x, y, NFFT=256, Fs=2, Fc=0, detrend=<function detrend_none>, window=<function window_hanning>, noverlap=0, pad_to=None, sides='default', scale_by_freq=None, *, data=None, **kwargs)[source]

Plot the coherence between x and y. Plot the coherence between x and y. Coherence is the normalized cross spectral density:  \[C_{xy} = \frac{|P_{xy}|^2}{P_{xx}P_{yy}}\]  Parameters

Fsfloat, default: 2

The sampling frequency (samples per time unit). It is used to calculate the Fourier frequencies, freqs, in cycles per time unit.
windowcallable or ndarray, default: window_hanning

A function or a vector of length NFFT. To create window vectors see window_hanning, window_none, numpy.blackman, numpy.hamming, numpy.bartlett, scipy.signal, scipy.signal.get_window, etc. If a function is passed as the argument, it must take a data segment as an argument and return the windowed version of the segment.
sides{'default', 'onesided', 'twosided'}, optional

Which sides of the spectrum to return. 'default' is one-sided for real data and two-sided for complex data. 'onesided' forces the return of a one-sided spectrum, while 'twosided' forces two-sided.
pad_toint, optional

The number of points to which the data segment is padded when performing the FFT. This can be different from NFFT, which specifies the number of data points used. While not increasing the actual resolution of the spectrum (the minimum distance between resolvable peaks), this can give more points in the plot, allowing for more detail. This corresponds to the n parameter in the call to fft(). The default is None, which sets pad_to equal to NFFT
NFFTint, default: 256

The number of data points used in each block for the FFT. A power 2 is most efficient. This should NOT be used to get zero padding, or the scaling of the result will be incorrect; use pad_to for this instead.
detrend{'none', 'mean', 'linear'} or callable, default: 'none'

The function applied to each segment before fft-ing, designed to remove the mean or linear trend. Unlike in MATLAB, where the detrend parameter is a vector, in Matplotlib it is a function. The mlab module defines detrend_none, detrend_mean, and detrend_linear, but you can use a custom function as well. You can also use a string to choose one of the functions: 'none' calls detrend_none. 'mean' calls detrend_mean. 'linear' calls detrend_linear.
scale_by_freqbool, default: True

Whether the resulting density values should be scaled by the scaling frequency, which gives density in units of Hz^-1. This allows for integration over the returned frequency values. The default is True for MATLAB compatibility.
noverlapint, default: 0 (no overlap)

The number of points of overlap between blocks.
Fcint, default: 0

The center frequency of x, which offsets the x extents of the plot to reflect the frequency range used when a signal is acquired and then filtered and downsampled to baseband.    Returns

Cxy1-D array

The coherence vector.
freqs1-D array

The frequencies for the elements in Cxy.    Other Parameters

dataindexable object, optional

If given, the following parameters also accept a string s, which is interpreted as data[s] (unless this raises an exception): x, y  **kwargs

Keyword arguments control the Line2D properties:
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 color
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
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'}
transform unknown
url str
visible bool
xdata 1D array
ydata 1D array
zorder float       References Bendat & Piersol -- Random Data: Analysis and Measurement Procedures, John Wiley & Sons (1986)