matplotlib API reference

400 public APIs from matplotlib (matplotlib/matplotlib) — 178 classes, 28 functions, 194 methods. Signatures extracted by static analysis of the actual source.

Repository: matplotlib/matplotlib

Kind	Count
Classes	178
Functions	28
Methods	194

API list

classgalleries.users_explain.text.annotations.MyStyle

A simple box.

funcgalleries.users_explain.text.text_intro.formatoddticks(x, pos)

Format odd tick positions.

classlib.matplotlib._afm.CharMetrics

Represents the character metrics of a single character.

funclib.matplotlib._api.deprecation.empty_with_docstring()

doc

classlib.matplotlib._enums.JoinStyle

Define how the connection between two line segments is drawn.

methodlib.matplotlib._layoutgrid.LayoutGrid.reset_margins()

Reset all the margins to zero.

classlib.matplotlib._mathtext.AutoWidthChar

A character as close to the given width as possible.

classlib.matplotlib._mathtext.BakomaFonts

Use the Bakoma TrueType fonts for rendering.

classlib.matplotlib._mathtext.Box

A node with a physical location.

classlib.matplotlib._mathtext.Char

A single character.

funclib.matplotlib._mathtext.Error(msg:str) -> ParserElement

Helper class to raise parser errors.

classlib.matplotlib._mathtext.FontMetrics

Metrics of a font.

classlib.matplotlib._mathtext.Hbox

A box with only width (zero height and depth).

classlib.matplotlib._mathtext.Hlist

A horizontal list of boxes.

methodlib.matplotlib._mathtext.Hlist.kern() -> None

Insert `Kern` nodes between `Char` nodes to set kerning.

classlib.matplotlib._mathtext.Hrule

Convenience class to create a horizontal rule.

classlib.matplotlib._mathtext.List

A list of nodes (either horizontal or vertical).

classlib.matplotlib._mathtext.Node

A node in the TeX box model.

methodlib.matplotlib._mathtext.Node.render(output:Output, x:float, y:float) -> None

Render this node.

methodlib.matplotlib._mathtext.Node.shrink() -> None

Shrinks one level smaller.

methodlib.matplotlib._mathtext.Parser.get_state() -> ParserState

Get the current `State` of the parser.

methodlib.matplotlib._mathtext.Parser.pop_state() -> None

Pop a `State` off of the stack.

classlib.matplotlib._mathtext.ParserState

Parser state.

methodlib.matplotlib._mathtext.ParserState.get_current_underline_thickness() -> float

Return the underline thickness for this state.

classlib.matplotlib._mathtext.Rule

A solid black rectangle.

classlib.matplotlib._mathtext.StixFonts

A font handling class for the STIX fonts.

classlib.matplotlib._mathtext.UnicodeFonts

An abstract base class for handling Unicode fonts.

classlib.matplotlib._mathtext.Vbox

A box with only height (zero width).

classlib.matplotlib._mathtext.Vlist

A vertical list of boxes.

classlib.matplotlib._mathtext.Vrule

Convenience class to create a vertical rule.

funclib.matplotlib._mathtext.cmd(expr:str, args:ParserElement) -> ParserElement

Helper to define TeX commands.

funclib.matplotlib._mathtext.get_unicode_index(symbol:str) -> CharacterCodeType

Return the integer index (from the Unicode table) of *symbol*.

funclib.matplotlib._mathtext.ship(box:Box, xy:tuple[float, float]=(0, 0)) -> Output

Ship out *box* at offset *xy*, converting it to an `Output`.

func

lib.matplotlib._text_helpers.layout(string:str, font:FT2Font, *features:tuple[str] | None=None, *language:str | tuple[tuple[str, int, int], ...] | None=None) -> Iterator[LayoutItem]

Render *string* with *font*.

classlib.matplotlib._type1font.Type1Font

A class representing a Type-1 font, for use by backends.

methodlib.matplotlib._type1font.Type1Font.transform(effects)

Return a new font that is slanted and/or extended.

classlib.matplotlib.animation.Animation

Abstract base class for Animations.

methodlib.matplotlib.animation.Animation.pause()

Pause the animation.

methodlib.matplotlib.animation.Animation.resume()

Resume the animation.

classlib.matplotlib.animation.FFMpegBase

Mixin class for FFMpeg output.

classlib.matplotlib.animation.FFMpegFileWriter

File-based ffmpeg writer.

classlib.matplotlib.animation.FFMpegWriter

Pipe-based ffmpeg writer.

classlib.matplotlib.animation.HTMLWriter

Writer for JavaScript-based HTML movies.

classlib.matplotlib.animation.ImageMagickBase

Mixin class for ImageMagick output.

classlib.matplotlib.animation.ImageMagickFileWriter

File-based animated gif writer.

classlib.matplotlib.animation.ImageMagickWriter

Pipe-based animated gif writer.

classlib.matplotlib.animation.MovieWriter

Base class for writing movies.

classlib.matplotlib.animation.TimedAnimation

Abstract `Animation` subclass for time-based animation.

classlib.matplotlib.artist.Artist

Abstract base class for objects that render into a FigureCanvas.

methodlib.matplotlib.artist.Artist.findobj(match=None, include_self=True)

Find artist objects.

methodlib.matplotlib.artist.Artist.get_clip_box()

Return the clipbox.

methodlib.matplotlib.artist.Artist.get_clip_path()

Return the clip path.

methodlib.matplotlib.artist.Artist.get_gid()

Return the group id.

methodlib.matplotlib.artist.Artist.get_snap()

Return the snap setting.

methodlib.matplotlib.artist.Artist.get_url()

Return the url.

methodlib.matplotlib.artist.Artist.get_visible()

Return the visibility.

methodlib.matplotlib.artist.Artist.get_zorder()

Return the artist's zorder.

methodlib.matplotlib.artist.Artist.pchanged()

Call all of the registered callbacks.

methodlib.matplotlib.artist.Artist.pick(mouseevent)

Process a pick event.

methodlib.matplotlib.artist.Artist.pickable()

Return whether the artist is pickable.

methodlib.matplotlib.artist.Artist.remove()

Remove the artist from the figure if possible.

methodlib.matplotlib.artist.Artist.set_agg_filter(filter_func)

Set the agg filter.

methodlib.matplotlib.artist.Artist.set_clip_box(clipbox)

Set the artist's clip `.Bbox`.

methodlib.matplotlib.artist.Artist.set_clip_on(b)

Set whether the artist uses clipping.

methodlib.matplotlib.artist.Artist.set_clip_path(path, transform=None)

Set the artist's clip path.

methodlib.matplotlib.artist.Artist.set_gid(gid)

Set the (group) id for the artist.

methodlib.matplotlib.artist.Artist.set_path_effects(path_effects)

Set the path effects.

methodlib.matplotlib.artist.Artist.set_sketch_params(scale=None, length=None, randomness=None)

Set the sketch parameters.

methodlib.matplotlib.artist.Artist.set_snap(snap)

Set the snapping behavior.

methodlib.matplotlib.artist.Artist.set_transform(t)

Set the artist transform.

methodlib.matplotlib.artist.Artist.set_url(url)

Set the url for the artist.

methodlib.matplotlib.artist.Artist.set_visible(b)

Set the artist's visibility.

methodlib.matplotlib.artist.Artist.set_zorder(level)

Set the zorder for the artist.

classlib.matplotlib.artist.ArtistList

A sublist of Axes or Figure children based on their type.

funclib.matplotlib.artist.allow_rasterization(draw)

Decorator for Artist.draw method.

classlib.matplotlib.axes._secondary_axes.SecondaryAxis

General class to hold a Secondary_X/Yaxis.

methodlib.matplotlib.axes._secondary_axes.SecondaryAxis.draw(renderer)

Draw the secondary Axes.

classlib.matplotlib.axis.Axis

Base class for `.XAxis` and `.YAxis`.

methodlib.matplotlib.axis.Axis.clear()

Clear the axis.

methodlib.matplotlib.axis.Axis.get_converter()

Get the unit converter for axis.

methodlib.matplotlib.axis.Axis.get_label_text()

Get the text of the label.

methodlib.matplotlib.axis.Axis.get_major_formatter()

Get the formatter of the major ticker.

methodlib.matplotlib.axis.Axis.get_major_locator()

Get the locator of the major ticker.

methodlib.matplotlib.axis.Axis.get_minor_locator()

Get the locator of the minor ticker.

methodlib.matplotlib.axis.Axis.get_scale()

Return this Axis' scale (as a str).

methodlib.matplotlib.axis.Axis.get_ticklabels(minor=False, which=None)

Get this Axis' tick labels.

methodlib.matplotlib.axis.Axis.get_units()

Return the units for axis.

methodlib.matplotlib.axis.Axis.grid(visible=None, which='major', **kwargs)

Configure the grid lines.

methodlib.matplotlib.axis.Axis.minorticks_off()

Remove minor ticks from the Axis.

methodlib.matplotlib.axis.Axis.set_converter(converter)

Set the unit converter for axis.

methodlib.matplotlib.axis.Axis.set_data_interval(vmin, vmax, ignore=False)

Set the axis data limits.

methodlib.matplotlib.axis.Axis.set_major_locator(locator)

Set the locator of the major ticker.

methodlib.matplotlib.axis.Axis.set_minor_locator(locator)

Set the locator of the minor ticker.

methodlib.matplotlib.axis.Axis.set_units(u)

Set the units for axis.

methodlib.matplotlib.axis.Axis.set_view_interval(vmin, vmax, ignore=False)

Set the axis view limits.

classlib.matplotlib.axis.Tick

Abstract base class for the axis ticks, grid lines and labels.

methodlib.matplotlib.axis.Tick.set_url(url)

Set the url of label1 and label2.

classlib.matplotlib.axis.Ticker

A container for the objects defining tick position and format.

methodlib.matplotlib.axis.XAxis.set_ticks_position(position)

Set the ticks position.

methodlib.matplotlib.axis.YAxis.set_ticks_position(position)

Set the ticks position.

classlib.matplotlib.backend_bases.CloseEvent

An event triggered by a figure being closed.

classlib.matplotlib.backend_bases.DrawEvent

An event triggered by a draw operation on the canvas.

classlib.matplotlib.backend_bases.Event

A Matplotlib event.

classlib.matplotlib.backend_bases.FigureCanvasBase

The canvas the figure renders into.

methodlib.matplotlib.backend_bases.FigureCanvasBase.draw(*args, **kwargs)

Render the `.Figure`.

methodlib.matplotlib.backend_bases.FigureCanvasBase.mpl_connect(s, func)

Bind function *func* to event *s*.

methodlib.matplotlib.backend_bases.FigureCanvasBase.set_cursor(cursor)

Set the current cursor.

methodlib.matplotlib.backend_bases.FigureCanvasBase.start_event_loop(timeout=0)

Start a blocking event loop.

classlib.matplotlib.backend_bases.KeyEvent

A key event (key press, key release).

classlib.matplotlib.backend_bases.LocationEvent

An event that has a screen location.

classlib.matplotlib.backend_bases.NavigationToolbar2

Base class for the navigation cursor, version 2.

methodlib.matplotlib.backend_bases.NavigationToolbar2.back(*args)

Move back up the view lim stack.

methodlib.matplotlib.backend_bases.NavigationToolbar2.home(*args)

Restore the original view.

methodlib.matplotlib.backend_bases.NavigationToolbar2.pan(*args)

Toggle the pan/zoom tool.

methodlib.matplotlib.backend_bases.NavigationToolbar2.remove_rubberband()

Remove the rubberband.

methodlib.matplotlib.backend_bases.NavigationToolbar2.save_figure(*args)

Save the current figure.

methodlib.matplotlib.backend_bases.NavigationToolbar2.update()

Reset the Axes stack.

classlib.matplotlib.backend_bases.NonGuiException

Raised when trying show a figure in a non-GUI backend.

classlib.matplotlib.backend_bases.PickEvent

A pick event.

classlib.matplotlib.backend_bases.RendererBase

An abstract base class to handle drawing/rendering operations.

methodlib.matplotlib.backend_bases.RendererBase.draw_image(gc, x, y, im, transform=None)

Draw an RGBA image.

methodlib.matplotlib.backend_bases.RendererBase.draw_tex(gc, x, y, s, prop, angle, *mtext=None)

Draw a TeX instance.

methodlib.matplotlib.backend_bases.RendererBase.draw_text(gc, x, y, s, prop, angle, ismath=False, mtext=None)

Draw a text instance.

methodlib.matplotlib.backend_bases.RendererBase.points_to_pixels(points)

Convert points to display units.

methodlib.matplotlib.backend_bases.RendererBase.start_rasterizing()

Switch to the raster renderer.

classlib.matplotlib.backend_bases.ResizeEvent

An event triggered by a canvas resize.

classlib.matplotlib.backend_bases.ToolContainerBase

Base class for all tool containers, e.g.

methodlib.matplotlib.backend_bases.ToolContainerBase.trigger_tool(name)

Trigger the tool.

classlib.matplotlib.backend_managers.ToolEvent

Event for tool manipulation (add/remove).

methodlib.matplotlib.backend_managers.ToolManager.active_toggle()

Currently toggled tools.

methodlib.matplotlib.backend_managers.ToolManager.canvas()

Canvas managed by FigureManager.

methodlib.matplotlib.backend_managers.ToolManager.figure()

Figure that holds the canvas.

methodlib.matplotlib.backend_managers.ToolManager.remove_tool(name)

Remove tool named *name*.

classlib.matplotlib.backend_managers.ToolManagerMessageEvent

Event carrying messages from toolmanager.

classlib.matplotlib.backend_managers.ToolTriggerEvent

Event to inform that a tool has been triggered.

classlib.matplotlib.backend_tools.AxisScaleBase

Base Tool to toggle between linear and logarithmic.

classlib.matplotlib.backend_tools.ConfigureSubplotsBase

Base tool for the configuration of subplots.

classlib.matplotlib.backend_tools.Cursors

Backend-independent cursor types.

classlib.matplotlib.backend_tools.RubberbandBase

Draw and remove a rubberband.

methodlib.matplotlib.backend_tools.RubberbandBase.draw_rubberband(*data)

Draw rubberband.

methodlib.matplotlib.backend_tools.RubberbandBase.remove_rubberband()

Remove rubberband.

classlib.matplotlib.backend_tools.SaveFigureBase

Base tool for figure saving.

classlib.matplotlib.backend_tools.ToolBack

Move back up the view limits stack.

classlib.matplotlib.backend_tools.ToolBase

Base tool class.

methodlib.matplotlib.backend_tools.ToolBase.trigger(sender, event, data=None)

Called when this tool gets used.

classlib.matplotlib.backend_tools.ToolCopyToClipboardBase

Tool to copy the figure to the clipboard.

classlib.matplotlib.backend_tools.ToolCursorPosition

Send message with the current pointer position.

classlib.matplotlib.backend_tools.ToolForward

Move forward in the view lim stack.

classlib.matplotlib.backend_tools.ToolFullScreen

Tool to toggle full screen.

classlib.matplotlib.backend_tools.ToolGrid

Tool to toggle the major grids of the figure.

classlib.matplotlib.backend_tools.ToolHome

Restore the original view limits.

classlib.matplotlib.backend_tools.ToolMinorGrid

Tool to toggle the major and minor grids of the figure.

classlib.matplotlib.backend_tools.ToolPan

Pan Axes with left mouse, zoom with right.

classlib.matplotlib.backend_tools.ToolQuit

Tool to call the figure manager destroy method.

classlib.matplotlib.backend_tools.ToolQuitAll

Tool to call the figure manager destroy method.

classlib.matplotlib.backend_tools.ToolSetCursor

Change to the current cursor while inaxes.

classlib.matplotlib.backend_tools.ToolToggleBase

Toggleable tool.

methodlib.matplotlib.backend_tools.ToolToggleBase.disable(event=None)

Disable the toggle tool.

methodlib.matplotlib.backend_tools.ToolToggleBase.enable(event=None)

Enable the toggle tool.

methodlib.matplotlib.backend_tools.ToolToggleBase.toggled()

State of the toggled tool.

methodlib.matplotlib.backend_tools.ToolViewsPositions.clear(figure)

Reset the Axes stack.

classlib.matplotlib.backend_tools.ToolZoom

A Tool for zooming using a rectangle selector.

classlib.matplotlib.backend_tools.ViewsPositionsBase

Base class for `ToolHome`, `ToolBack` and `ToolForward`.

classlib.matplotlib.backend_tools.ZoomPanBase

Base class for `ToolZoom` and `ToolPan`.

classlib.matplotlib.backends._backend_gtk.TimerGTK

Subclass of `.TimerBase` using GTK timer events.

classlib.matplotlib.backends._backend_pdf_ps.GlyphMap

A two-way glyph mapping.

method

lib.matplotlib.backends._backend_pdf_ps.GlyphMap.add(charcode:str, glyph_index:GlyphIndexType, subset:int, subset_charcode:CharacterCodeType) -> None

Add a mapping to this instance.

method

lib.matplotlib.backends._backend_pdf_ps.GlyphMap.get(charcodes:str, glyph_index:GlyphIndexType) -> tuple[int, CharacterCodeType] | None

Get the forward mapping from a (character string, glyph index)-pair.

classlib.matplotlib.backends._backend_pdf_ps.SubsetResults

The results of a subsetting operation on a font.

func

lib.matplotlib.backends._backend_pdf_ps.get_glyphs_subset(fontfile:FontPath, glyphs:set[GlyphIndexType]) -> AbstractContextManager[SubsetResults]

Subset a TTF font.

funclib.matplotlib.backends._backend_tk.showtip(event)

Display text in tooltip window.

classlib.matplotlib.backends.backend_macosx.TimerMac

Subclass of `.TimerBase` using CFRunLoop timer events.

classlib.matplotlib.backends.backend_pdf.Name

PDF name object.

classlib.matplotlib.backends.backend_pdf.Op

PDF operators (not an exhaustive list).

classlib.matplotlib.backends.backend_pdf.PdfFile

PDF file object.

methodlib.matplotlib.backends.backend_pdf.PdfFile.writeTrailer()

Write out the PDF trailer.

methodlib.matplotlib.backends.backend_pdf.PdfFile.writeXref()

Write out the xref table.

classlib.matplotlib.backends.backend_pdf.PdfPages

A multi-page PDF file.

classlib.matplotlib.backends.backend_pdf.Reference

PDF reference object.

classlib.matplotlib.backends.backend_pdf.Stream

PDF stream object.

methodlib.matplotlib.backends.backend_pdf.Stream.end()

Finalize stream.

methodlib.matplotlib.backends.backend_pdf.Stream.write(data)

Write some data on the stream.

funclib.matplotlib.backends.backend_pdf.pdfRepr(obj)

Map Python objects to PDF syntax.

classlib.matplotlib.backends.backend_qt.TimerQT

Subclass of `.TimerBase` using QTimer events.

classlib.matplotlib.backends.backend_svg.XMLWriter

An XML writer class.

classlib.matplotlib.backends.backend_template.FigureCanvasTemplate

The canvas the figure renders into.

methodlib.matplotlib.backends.backend_template.FigureCanvasTemplate.print_foo(filename, **kwargs)

Write out format foo.

classlib.matplotlib.backends.backend_template.RendererTemplate

The renderer handles drawing/rendering operations.

classlib.matplotlib.backends.backend_wx.TimerWx

Subclass of `.TimerBase` using wx.Timer events.

classlib.matplotlib.backends.qt_editor._formlayout.ColorButton

Color choosing push button

classlib.matplotlib.backends.qt_editor._formlayout.ColorLayout

Color-specialized QLineEdit layout

classlib.matplotlib.backends.qt_editor._formlayout.FontLayout

Font selection

classlib.matplotlib.backends.qt_editor._formlayout.FormDialog

Form Dialog

methodlib.matplotlib.backends.qt_editor._formlayout.FormDialog.get()

Return form result

funclib.matplotlib.backends.qt_editor._formlayout.font_is_installed(font)

Check if font is installed

funclib.matplotlib.backends.qt_editor.figureoptions.apply_callback(data)

A callback to apply changes.

classlib.matplotlib.backends.registry.BackendRegistry

Registry of backends available within Matplotlib.

classlib.matplotlib.bezier.BezierSegment

A d-dimensional Bézier segment.

methodlib.matplotlib.bezier.BezierSegment.control_points()

The control points of the curve.

methodlib.matplotlib.bezier.BezierSegment.degree()

Degree of the polynomial.

methodlib.matplotlib.bezier.BezierSegment.dimension()

The dimension of the curve.

classlib.matplotlib.category.StrCategoryFormatter

String representation of the data at every tick.

classlib.matplotlib.category.StrCategoryLocator

Tick at every integer mapping of the string data.

classlib.matplotlib.cbook.Grouper

A disjoint-set data structure.

methodlib.matplotlib.cbook.Grouper.join(a, *args)

Join given arguments into the same set.

classlib.matplotlib.cbook.GrouperView

Immutable view over a `.Grouper`.

funclib.matplotlib.cbook.get_sample_data(fname, asfileobj=True)

Return a sample data file.

funclib.matplotlib.cbook.safe_first_element(obj)

Return the first element in *obj*.

funclib.matplotlib.cbook.sanitize_sequence(data)

Convert dictview objects to list.

classlib.matplotlib.cbook.silent_list

A list with a short ``repr()``.

funclib.matplotlib.cbook.strip_math(s)

Remove latex formatting from mathtext.

methodlib.matplotlib.cm.ColormapRegistry.register(cmap, *name=None, *force=False)

methodlib.matplotlib.cm.ColormapRegistry.unregister(name)

Remove a colormap from the registry.

classlib.matplotlib.collections.CircleCollection

A collection of circles, drawn using splines.

classlib.matplotlib.collections.Collection

Base class for Collections.

methodlib.matplotlib.collections.Collection.get_fill()

Return whether face is colored.

methodlib.matplotlib.collections.Collection.get_hatch_linewidth()

Return the hatch linewidth.

methodlib.matplotlib.collections.Collection.set_hatch_linewidth(lw)

Set the hatch linewidth.

classlib.matplotlib.collections.EllipseCollection

A collection of ellipses, drawn using splines.

classlib.matplotlib.collections.PatchCollection

A generic collection of patches.

classlib.matplotlib.collections.PathCollection

A collection of `~.path.Path`\s, as created by e.g.

classlib.matplotlib.collections.QuadMesh

Class for the efficient drawing of a quadrilateral mesh.

classlib.matplotlib.collections.RegularPolyCollection

A collection of n-sided regular polygons.

classlib.matplotlib.colorbar.Colorbar

Draw a colorbar in an existing Axes.

methodlib.matplotlib.colorbar.Colorbar.add_lines(*args, **kwargs)

Draw lines on the colorbar.

methodlib.matplotlib.colorbar.Colorbar.minorticks_on()

Turn on colorbar minor ticks.

methodlib.matplotlib.colorbar.Colorbar.remove()

Remove this colorbar from the figure.

methodlib.matplotlib.colorbar.Colorbar.set_ticks(ticks, *labels=None, *minor=False, **kwargs)

Set tick locations.

methodlib.matplotlib.colorbar.Colorbar.update_ticks()

Set up the ticks and ticklabels.

classlib.matplotlib.colorizer.Colorizer

Data to color pipeline.

classlib.matplotlib.colors.BivarColormap

Base class for all bivariate to RGBA mappings.

methodlib.matplotlib.colors.BivarColormap.copy()

Return a copy of the colormap.

methodlib.matplotlib.colors.BivarColormap.get_bad()

Get the color for masked values.

methodlib.matplotlib.colors.BivarColormap.lut()

For external access to the lut, i.e.

classlib.matplotlib.colors.BoundaryNorm

Generate a colormap index based on discrete intervals.

classlib.matplotlib.colors.ColorConverter

A class only kept for backwards compatibility.

classlib.matplotlib.colors.Colormap

Baseclass for all scalar to RGBA mappings.

methodlib.matplotlib.colors.Colormap.copy()

Return a copy of the colormap.

methodlib.matplotlib.colors.Colormap.get_bad()

Get the color for masked values.

methodlib.matplotlib.colors.Colormap.set_bad(color='k', alpha=None)

Set the color for masked values.

classlib.matplotlib.colors.ListedColormap

Colormap object generated from a list of colors.

classlib.matplotlib.colors.MultiNorm

A class which contains multiple scalar norms.

classlib.matplotlib.colors.Norm

Abstract base class for normalizations.

methodlib.matplotlib.colors.Norm.n_components()

The number of normalized components.

funclib.matplotlib.colors.hsv_to_rgb(hsv)

Convert HSV values to RGB.

funclib.matplotlib.colors.to_hex(c, keep_alpha=False)

Convert *c* to a hex color.

funclib.matplotlib.colors.to_rgba(c, alpha=None)

Convert *c* to an RGBA color.

classlib.matplotlib.container.BarContainer

Container for the artists of bar plots (e.g.

classlib.matplotlib.container.Container

Base class for containers.

classlib.matplotlib.container.ErrorbarContainer

Container for the artists of error bars (e.g.

classlib.matplotlib.container.PieContainer

Container for the artists of pie charts (e.g.

classlib.matplotlib.contour.ContourLabeler

Mixin to provide labelling capability to `.ContourSet`.

methodlib.matplotlib.contour.ContourLabeler.get_text(lev, fmt)

Get the text of the label.

classlib.matplotlib.contour.ContourSet

Store a set of contour lines or filled regions.

classlib.matplotlib.contour.QuadContourSet

Create and store a set of contour lines or filled regions.

classlib.matplotlib.dates.DateLocator

Determines the tick locations when plotting dates.

methodlib.matplotlib.dates.DateLocator.set_tzinfo(tz)

Set timezone info.

classlib.matplotlib.dates.DayLocator

Make ticks on occurrences of each day of the month.

classlib.matplotlib.dates.HourLocator

Make ticks on occurrences of each hour.

classlib.matplotlib.dates.MinuteLocator

Make ticks on occurrences of each minute.

classlib.matplotlib.dates.MonthLocator

Make ticks on occurrences of each month, e.g., 1, 3, 12.

classlib.matplotlib.dates.SecondLocator

Make ticks on occurrences of each second.

classlib.matplotlib.dates.WeekdayLocator

Make ticks on occurrences of each weekday.

funclib.matplotlib.dates.get_epoch()

Get the epoch used by `.dates`.

classlib.matplotlib.dviread.DviFont

Encapsulation of a font that a DVI file can refer to.

methodlib.matplotlib.dviread.DviFont.fname()

A fake filename

classlib.matplotlib.dviread.PsfontsMap

A psfonts.map formatted file, mapping TeX fonts to PS fonts.

classlib.matplotlib.dviread.TexMetrics

Metrics of a glyph, with TeX semantics.

classlib.matplotlib.dviread.Text

A glyph in the dvi file.

classlib.matplotlib.dviread.Tfm

A TeX Font Metric file.

classlib.matplotlib.figure.Figure

The top level container for all the plot elements.

methodlib.matplotlib.figure.Figure.axes()

List of Axes in the Figure.

methodlib.matplotlib.figure.Figure.draw_artist(a)

Draw `.Artist` *a* only.

methodlib.matplotlib.figure.Figure.draw_without_rendering()

Draw the figure with no output.

methodlib.matplotlib.figure.Figure.get_figheight()

Return the figure height in inches.

methodlib.matplotlib.figure.Figure.get_figwidth()

Return the figure width in inches.

methodlib.matplotlib.figure.Figure.set_size_inches(w, h=None, forward=True)

Set the figure size in inches.

classlib.matplotlib.figure.SubFigure

Logical figure that can be placed inside a figure.

methodlib.matplotlib.figure.SubFigure.axes()

List of Axes in the SubFigure.

classlib.matplotlib.font_manager.FontEntry

A class for storing Font properties.

methodlib.matplotlib.font_manager.FontManager.get_default_size()

Return the default font size.

methodlib.matplotlib.font_manager.FontManager.set_default_weight(weight)

Set the default font weight.

classlib.matplotlib.font_manager.FontPath

A class to describe a path to a font with a face index.

methodlib.matplotlib.font_manager.FontPath.face_index()

The face index in a font.

methodlib.matplotlib.font_manager.FontPath.path()

The path to a font.

classlib.matplotlib.font_manager.FontProperties

A class for storing and manipulating font properties.

methodlib.matplotlib.font_manager.FontProperties.copy()

Return a copy of self.

methodlib.matplotlib.font_manager.FontProperties.get_size()

Return the font size.

methodlib.matplotlib.font_manager.FontProperties.get_style()

Return the font style.

methodlib.matplotlib.font_manager.FontProperties.get_variant()

Return the font variant.

methodlib.matplotlib.font_manager.FontProperties.get_weight()

Get the font weight.

methodlib.matplotlib.font_manager.FontProperties.set_family(family)

Change the font family.

methodlib.matplotlib.font_manager.FontProperties.set_size(size)

Set the font size.

methodlib.matplotlib.font_manager.FontProperties.set_stretch(stretch)

Set the font stretch or width.

methodlib.matplotlib.font_manager.FontProperties.set_style(style)

Set the font style.

methodlib.matplotlib.font_manager.FontProperties.set_variant(variant)

Set the font variant.

methodlib.matplotlib.font_manager.FontProperties.set_weight(weight)

Set the font weight.

funclib.matplotlib.get_backend(*auto_select=True)

Return the name of the current backend.

funclib.matplotlib.get_data_path()

Return the path to Matplotlib data.

classlib.matplotlib.gridspec.GridSpec

A grid layout to place subplots within a figure.

classlib.matplotlib.gridspec.SubplotSpec

The location of a subplot in a `GridSpec`.

classlib.matplotlib.hatch.HatchPatternBase

The base class for a hatch pattern.

classlib.matplotlib.image.AxesImage

An image with pixels on a regular grid, attached to an Axes.

methodlib.matplotlib.image.AxesImage.set_extent(extent, **kwargs)

Set the image extent.

classlib.matplotlib.image.BboxImage

The Image class whose size is determined by the given bbox.

classlib.matplotlib.image.FigureImage

An image attached to a figure.

methodlib.matplotlib.image.FigureImage.set_data(A)

Set the image array.

classlib.matplotlib.image.NonUniformImage

An image with pixels on a rectilinear grid.

classlib.matplotlib.inset.InsetIndicator

An artist to highlight an area of interest.

methodlib.matplotlib.inset.InsetIndicator.rectangle()

`.Rectangle`: the indicator frame.

classlib.matplotlib.layout_engine.LayoutEngine

Base class for Matplotlib layout engines.

classlib.matplotlib.layout_engine.TightLayoutEngine

Implements the ``tight_layout`` geometry management.

methodlib.matplotlib.layout_engine.TightLayoutEngine.execute(fig)

Execute tight_layout.

classlib.matplotlib.legend.Legend

Place a legend on the figure/axes.

methodlib.matplotlib.legend.Legend.set_loc(loc=None)

Set the location of the legend.

methodlib.matplotlib.legend.Legend.set_ncols(ncols)

Set the number of columns.

methodlib.matplotlib.legend.Legend.set_title(title, prop=None)

Set legend title and title style.

classlib.matplotlib.legend_handler.HandlerBase

A base class for default legend handlers.

classlib.matplotlib.legend_handler.HandlerCircleCollection

Handler for `.CircleCollection`\s.

classlib.matplotlib.legend_handler.HandlerErrorbar

Handler for Errorbars.

classlib.matplotlib.legend_handler.HandlerLine2D

Handler for `.Line2D` instances.

classlib.matplotlib.legend_handler.HandlerLineCollection

Handler for `.LineCollection` instances.

classlib.matplotlib.legend_handler.HandlerPatch

Handler for `.Patch` instances.

classlib.matplotlib.legend_handler.HandlerRegularPolyCollection

Handler for `.RegularPolyCollection`\s.

classlib.matplotlib.legend_handler.HandlerStem

Handler for plots produced by `~.Axes.stem`.

classlib.matplotlib.legend_handler.HandlerStepPatch

Handler for `~.matplotlib.patches.StepPatch` instances.

classlib.matplotlib.legend_handler.HandlerTuple

Handler for Tuple.

methodlib.matplotlib.lines.Line2D.get_bbox()

Get the bounding box of this line.

methodlib.matplotlib.lines.Line2D.get_color()

Return the line color.

methodlib.matplotlib.lines.Line2D.get_drawstyle()

Return the drawstyle.

methodlib.matplotlib.lines.Line2D.get_fillstyle()

Return the marker fill style.

methodlib.matplotlib.lines.Line2D.get_gapcolor()

Return the line gapcolor.

methodlib.matplotlib.lines.Line2D.get_linestyle()

Return the linestyle.

methodlib.matplotlib.lines.Line2D.get_linewidth()

Return the linewidth in points.

methodlib.matplotlib.lines.Line2D.get_marker()

Return the line marker.

methodlib.matplotlib.lines.Line2D.get_markeredgecolor()

Return the marker edge color.

methodlib.matplotlib.lines.Line2D.get_markerfacecolor()

Return the marker face color.

methodlib.matplotlib.lines.Line2D.get_markersize()

Return the marker size in points.

methodlib.matplotlib.lines.Line2D.get_xdata(orig=True)

Return the xdata.

methodlib.matplotlib.lines.Line2D.get_xydata()

Return the *xy* data as a (N, 2) array.

methodlib.matplotlib.lines.Line2D.get_ydata(orig=True)

Return the ydata.

methodlib.matplotlib.lines.Line2D.set_color(color)

Set the color of the line.

methodlib.matplotlib.lines.Line2D.set_dashes(seq)

Set the dash sequence.

methodlib.matplotlib.lines.Line2D.set_data(*args)

Set the x and y data.

methodlib.matplotlib.lines.Line2D.set_drawstyle(drawstyle)

Set the drawstyle of the plot.

methodlib.matplotlib.lines.Line2D.set_fillstyle(fs)

Set the marker fill style.

methodlib.matplotlib.lines.Line2D.set_linestyle(ls)

Set the linestyle of the line.

methodlib.matplotlib.lines.Line2D.set_linewidth(w)

Set the line width in points.

methodlib.matplotlib.lines.Line2D.set_marker(marker)

Set the line marker.

methodlib.matplotlib.lines.Line2D.set_markeredgecolor(ec)

Set the marker edge color.

methodlib.matplotlib.lines.Line2D.set_markerfacecolor(fc)

Set the marker face color.

methodlib.matplotlib.lines.Line2D.set_markersize(sz)

Set the marker size in points.

methodlib.matplotlib.lines.Line2D.set_xdata(x)

Set the data array for x.

methodlib.matplotlib.lines.Line2D.set_ydata(y)

Set the data array for y.

classlib.matplotlib.markers.MarkerStyle

A class representing marker types.

funclib.matplotlib.matplotlib_fname()

Get the location of the config file.

funclib.matplotlib.mlab.detrend(x, key=None, axis=None)

Return *x* with its trend removed.

funclib.matplotlib.mlab.detrend_mean(x, axis=None)

Return *x* minus the mean(*x*).

funclib.matplotlib.mlab.detrend_none(x, axis=None)

Return *x*: no detrending.

funclib.matplotlib.mlab.window_none(x)

No window function; simply return *x*.

classlib.matplotlib.offsetbox.AnchoredOffsetbox

An OffsetBox placed according to location *loc*.

methodlib.matplotlib.offsetbox.AnchoredOffsetbox.get_child()

Return the child.

methodlib.matplotlib.offsetbox.AnchoredOffsetbox.get_children()

Return the list of children.

methodlib.matplotlib.offsetbox.AnchoredOffsetbox.set_child(child)

Set the child to be anchored.

classlib.matplotlib.offsetbox.AnchoredText

AnchoredOffsetbox with Text.

classlib.matplotlib.offsetbox.AuxTransformBox

An OffsetBox with an auxiliary transform.

methodlib.matplotlib.offsetbox.AuxTransformBox.get_offset()

Return offset of the container.

methodlib.matplotlib.offsetbox.AuxTransformBox.set_offset(xy)

Set the offset of the container.

methodlib.matplotlib.offsetbox.AuxTransformBox.set_transform(t)

set_transform is ignored.

classlib.matplotlib.offsetbox.DrawingArea

The DrawingArea can contain any Artist as a child.

methodlib.matplotlib.offsetbox.DrawingArea.get_offset()

Return offset of the container.

methodlib.matplotlib.offsetbox.DrawingArea.set_offset(xy)

Set the offset of the container.

methodlib.matplotlib.offsetbox.DrawingArea.set_transform(t)

set_transform is ignored.

classlib.matplotlib.offsetbox.OffsetBox

A simple container artist.

methodlib.matplotlib.offsetbox.OffsetBox.set_height(height)

Set the height of the box.

methodlib.matplotlib.offsetbox.OffsetBox.set_offset(xy)

Set the offset.

methodlib.matplotlib.offsetbox.OffsetBox.set_width(width)

Set the width of the box.

classlib.matplotlib.offsetbox.OffsetImage

Container artist for images.

methodlib.matplotlib.offsetbox.OffsetImage.get_offset()

Return offset of the container.

classlib.matplotlib.offsetbox.PaddedBox

A container to add a padding around an `.Artist`.

methodlib.matplotlib.offsetbox.TextArea.get_multilinebaseline()

Get multilinebaseline.

methodlib.matplotlib.offsetbox.TextArea.get_offset()

Return offset of the container.

methodlib.matplotlib.offsetbox.TextArea.set_multilinebaseline(t)

Set multilinebaseline.

methodlib.matplotlib.offsetbox.TextArea.set_offset(xy)

Set the offset of the container.

methodlib.matplotlib.offsetbox.TextArea.set_text(s)

Set the text of this area as a string.

methodlib.matplotlib.offsetbox.TextArea.set_transform(t)

set_transform is ignored.

classlib.matplotlib.patches.Annulus

An elliptical annulus.

methodlib.matplotlib.patches.Annulus.get_angle()

Return the angle of the annulus.

methodlib.matplotlib.patches.Annulus.get_center()

Return the center of the annulus.

methodlib.matplotlib.patches.Annulus.set_angle(angle)

Set the tilt angle of the annulus.

methodlib.matplotlib.patches.Annulus.set_center(xy)

Set the center of the annulus.

classlib.matplotlib.patches.Arc

An elliptical arc, i.e.

methodlib.matplotlib.patches.Arc.draw(renderer)

Draw the arc to the given *renderer*.

classlib.matplotlib.patches.Arrow

An arrow patch.

classlib.matplotlib.patches.ArrowStyle.BarAB

An arrow with vertical bars ``|`` at both ends.

classlib.matplotlib.patches.ArrowStyle.BracketA

An arrow with an outward square bracket at its start.

classlib.matplotlib.patches.ArrowStyle.BracketAB

An arrow with outward square brackets at both ends.

classlib.matplotlib.patches.ArrowStyle.BracketB

An arrow with an outward square bracket at its end.

classlib.matplotlib.patches.ArrowStyle.Curve

A simple curve without any arrow head.

classlib.matplotlib.patches.ArrowStyle.CurveA

An arrow with a head at its start point.

About this data

These signatures were extracted from the public source of matplotlib/matplotlib using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries