doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
get_tightbbox(renderer)[source]
Like Artist.get_window_extent, but includes any clipping. Parameters
rendererRendererBase subclass
renderer that will be used to draw the figures (i.e. fig.canvas.get_renderer()) Returns
Bbox
The enclosing bounding box (in figure pixel coordinates). | matplotlib.legend_api#matplotlib.legend.Legend.get_tightbbox |
get_title()[source]
Return the Text instance for the legend title. | matplotlib.legend_api#matplotlib.legend.Legend.get_title |
get_window_extent(renderer=None)[source]
Get the artist's bounding box in display space. The bounding box' width and height are nonnegative. Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0. Be careful when using this function, the re... | matplotlib.legend_api#matplotlib.legend.Legend.get_window_extent |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, bbox_to_anchor=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, draggable=<UNSET>, frame_on=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, tit... | matplotlib.legend_api#matplotlib.legend.Legend.set |
set_bbox_to_anchor(bbox, transform=None)[source]
Set the bbox that the legend will be anchored to. Parameters
bboxBboxBase or tuple
The bounding box can be specified in the following ways: A BboxBase instance A tuple of (left, bottom, width, height) in the given transform (normalized axes coordinate if None) A... | matplotlib.legend_api#matplotlib.legend.Legend.set_bbox_to_anchor |
classmethodset_default_handler_map(handler_map)[source]
A class method to set the default handler map. | matplotlib.legend_api#matplotlib.legend.Legend.set_default_handler_map |
set_draggable(state, use_blit=False, update='loc')[source]
Enable or disable mouse dragging support of the legend. Parameters
statebool
Whether mouse dragging is enabled.
use_blitbool, optional
Use blitting for faster image composition. For details see FuncAnimation.
update{'loc', 'bbox'}, optional
The ... | matplotlib.legend_api#matplotlib.legend.Legend.set_draggable |
set_frame_on(b)[source]
Set whether the legend box patch is drawn. Parameters
bbool | matplotlib.legend_api#matplotlib.legend.Legend.set_frame_on |
set_title(title, prop=None)[source]
Set the legend title. Fontproperties can be optionally set with prop parameter. | matplotlib.legend_api#matplotlib.legend.Legend.set_title |
classmethodupdate_default_handler_map(handler_map)[source]
A class method to update the default handler map. | matplotlib.legend_api#matplotlib.legend.Legend.update_default_handler_map |
zorder=5 | matplotlib.legend_api#matplotlib.legend.Legend.zorder |
matplotlib.legend_handler Default legend handlers. Important This is a low-level legend API, which most end users do not need. We recommend that you are familiar with the legend guide before reading this documentation. Legend handlers are expected to be a callable object with a following signature. legend_handler(leg... | matplotlib.legend_handler_api |
classmatplotlib.legend_handler.HandlerBase(xpad=0.0, ypad=0.0, update_func=None)[source]
A Base class for default legend handlers. The derived classes are meant to override create_artists method, which has a following signature.: def create_artists(self, legend, orig_handle,
xdescent, ydescent, wid... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerBase |
adjust_drawing_area(legend, orig_handle, xdescent, ydescent, width, height, fontsize)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerBase.adjust_drawing_area |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerBase.create_artists |
legend_artist(legend, orig_handle, fontsize, handlebox)[source]
Return the artist that this HandlerBase generates for the given original artist/handle. Parameters
legendLegend
The legend for which these legend artists are being created.
orig_handlematplotlib.artist.Artist or similar
The object for which the... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerBase.legend_artist |
update_prop(legend_handle, orig_handle, legend)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerBase.update_prop |
classmatplotlib.legend_handler.HandlerCircleCollection(yoffsets=None, sizes=None, **kwargs)[source]
Handler for CircleCollections. Parameters
numpointsint
Number of points to show in legend entry.
yoffsetsarray of floats
Length numpoints list of y offsets for each point in legend entry. **kwargs
Keyword a... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerCircleCollection |
create_collection(orig_handle, sizes, offsets, transOffset)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerCircleCollection.create_collection |
classmatplotlib.legend_handler.HandlerErrorbar(xerr_size=0.5, yerr_size=None, marker_pad=0.3, numpoints=None, **kwargs)[source]
Handler for Errorbars. Parameters
marker_padfloat
Padding between points in legend entry.
numpointsint
Number of points to show in legend entry. **kwargs
Keyword arguments forwar... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerErrorbar |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerErrorbar.create_artists |
get_err_size(legend, xdescent, ydescent, width, height, fontsize)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerErrorbar.get_err_size |
classmatplotlib.legend_handler.HandlerLine2D(marker_pad=0.3, numpoints=None, **kw)[source]
Handler for Line2D instances. See also HandlerLine2DCompound
An earlier handler implementation, which used one artist for the line and another for the marker(s). Parameters
marker_padfloat
Padding between points in ... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerLine2D |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerLine2D.create_artists |
classmatplotlib.legend_handler.HandlerLine2DCompound(marker_pad=0.3, numpoints=None, **kwargs)[source]
Original handler for Line2D instances, that relies on combining a line-only with a marker-only artist. May be deprecated in the future. Parameters
marker_padfloat
Padding between points in legend entry.
nump... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerLine2DCompound |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerLine2DCompound.create_artists |
classmatplotlib.legend_handler.HandlerLineCollection(marker_pad=0.3, numpoints=None, **kw)[source]
Handler for LineCollection instances. Parameters
marker_padfloat
Padding between points in legend entry.
numpointsint
Number of points to show in legend entry. **kwargs
Keyword arguments forwarded to Handler... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerLineCollection |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerLineCollection.create_artists |
get_numpoints(legend)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerLineCollection.get_numpoints |
classmatplotlib.legend_handler.HandlerNpoints(marker_pad=0.3, numpoints=None, **kwargs)[source]
A legend handler that shows numpoints points in the legend entry. Parameters
marker_padfloat
Padding between points in legend entry.
numpointsint
Number of points to show in legend entry. **kwargs
Keyword argum... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerNpoints |
get_numpoints(legend)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerNpoints.get_numpoints |
get_xdata(legend, xdescent, ydescent, width, height, fontsize)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerNpoints.get_xdata |
classmatplotlib.legend_handler.HandlerNpointsYoffsets(numpoints=None, yoffsets=None, **kwargs)[source]
A legend handler that shows numpoints in the legend, and allows them to be individually offset in the y-direction. Parameters
numpointsint
Number of points to show in legend entry.
yoffsetsarray of floats
... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerNpointsYoffsets |
get_ydata(legend, xdescent, ydescent, width, height, fontsize)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerNpointsYoffsets.get_ydata |
classmatplotlib.legend_handler.HandlerPatch(patch_func=None, **kwargs)[source]
Handler for Patch instances. Parameters
patch_funccallable, optional
The function that creates the legend key artist. patch_func should have the signature: def patch_func(legend=legend, orig_handle=orig_handle,
xdescen... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerPatch |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerPatch.create_artists |
classmatplotlib.legend_handler.HandlerPathCollection(yoffsets=None, sizes=None, **kwargs)[source]
Handler for PathCollections, which are used by scatter. Parameters
numpointsint
Number of points to show in legend entry.
yoffsetsarray of floats
Length numpoints list of y offsets for each point in legend entr... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerPathCollection |
create_collection(orig_handle, sizes, offsets, transOffset)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerPathCollection.create_collection |
classmatplotlib.legend_handler.HandlerPolyCollection(xpad=0.0, ypad=0.0, update_func=None)[source]
Handler for PolyCollection used in fill_between and stackplot. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerPolyCollection |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerPolyCollection.create_artists |
classmatplotlib.legend_handler.HandlerRegularPolyCollection(yoffsets=None, sizes=None, **kwargs)[source]
Handler for RegularPolyCollections. Parameters
numpointsint
Number of points to show in legend entry.
yoffsetsarray of floats
Length numpoints list of y offsets for each point in legend entry. **kwargs
... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerRegularPolyCollection |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerRegularPolyCollection.create_artists |
create_collection(orig_handle, sizes, offsets, transOffset)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerRegularPolyCollection.create_collection |
get_numpoints(legend)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerRegularPolyCollection.get_numpoints |
get_sizes(legend, orig_handle, xdescent, ydescent, width, height, fontsize)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerRegularPolyCollection.get_sizes |
update_prop(legend_handle, orig_handle, legend)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerRegularPolyCollection.update_prop |
classmatplotlib.legend_handler.HandlerStem(marker_pad=0.3, numpoints=None, bottom=None, yoffsets=None, **kwargs)[source]
Handler for plots produced by stem. Parameters
marker_padfloat, default: 0.3
Padding between points in legend entry.
numpointsint, optional
Number of points to show in legend entry.
bot... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerStem |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerStem.create_artists |
get_ydata(legend, xdescent, ydescent, width, height, fontsize)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerStem.get_ydata |
classmatplotlib.legend_handler.HandlerStepPatch(xpad=0.0, ypad=0.0, update_func=None)[source]
Handler for StepPatch instances. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerStepPatch |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerStepPatch.create_artists |
classmatplotlib.legend_handler.HandlerTuple(ndivide=1, pad=None, **kwargs)[source]
Handler for Tuple. Parameters
ndivideint, default: 1
The number of sections to divide the legend area into. If None, use the length of the input tuple.
padfloat, default: rcParams["legend.borderpad"] (default: 0.4)
Padding in... | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerTuple |
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.HandlerTuple.create_artists |
matplotlib.legend_handler.update_from_first_child(tgt, src)[source] | matplotlib.legend_handler_api#matplotlib.legend_handler.update_from_first_child |
matplotlib.lines 2D lines with support for a variety of line styles, markers, colors, etc. Classes
Line2D(xdata, ydata[, linewidth, linestyle, ...]) A line - the line can have both a solid linestyle connecting all the vertices, and a marker at each vertex.
VertexSelector(line) Manage the callbacks to maintain a li... | matplotlib.lines_api |
matplotlib.lines.Line2D classmatplotlib.lines.Line2D(xdata, ydata, linewidth=None, linestyle=None, color=None, marker=None, markersize=None, markeredgewidth=None, markeredgecolor=None, markerfacecolor=None, markerfacecoloralt='none', fillstyle=None, antialiased=None, dash_capstyle=None, solid_capstyle=None, dash_join... | matplotlib._as_gen.matplotlib.lines.line2d |
contains(mouseevent)[source]
Test whether mouseevent occurred on the line. An event is deemed to have occurred "on" the line if it is less than self.pickradius (default: 5 points) away from it. Use get_pickradius or set_pickradius to get or set the pick radius. Parameters
mouseeventmatplotlib.backend_bases.MouseE... | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.contains |
draw(renderer)[source]
Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False). Parameters
rendererRendererBase subclass.
Notes This method is overridden in the Artist subclasses. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.draw |
drawStyleKeys=['default', 'steps-mid', 'steps-pre', 'steps-post', 'steps'] | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.drawStyleKeys |
drawStyles={'default': '_draw_lines', 'steps': '_draw_steps_pre', 'steps-mid': '_draw_steps_mid', 'steps-post': '_draw_steps_post', 'steps-pre': '_draw_steps_pre'} | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.drawStyles |
filled_markers=('o', 'v', '^', '<', '>', '8', 's', 'p', '*', 'h', 'H', 'D', 'd', 'P', 'X') | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.filled_markers |
fillStyles=('full', 'left', 'right', 'bottom', 'top', 'none') | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.fillStyles |
get_aa()[source]
Alias for get_antialiased. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_aa |
get_antialiased()[source]
Return whether antialiased rendering is used. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_antialiased |
get_c()[source]
Alias for get_color. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_c |
get_color()[source]
Return the line color. See also set_color. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_color |
get_dash_capstyle()[source]
Return the CapStyle for dashed lines. See also set_dash_capstyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_dash_capstyle |
get_dash_joinstyle()[source]
Return the JoinStyle for dashed lines. See also set_dash_joinstyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_dash_joinstyle |
get_data(orig=True)[source]
Return the line data as an (xdata, ydata) pair. If orig is True, return the original data. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_data |
get_drawstyle()[source]
Return the drawstyle. See also set_drawstyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_drawstyle |
get_ds()[source]
Alias for get_drawstyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_ds |
get_fillstyle()[source]
Return the marker fill style. See also set_fillstyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_fillstyle |
get_linestyle()[source]
Return the linestyle. See also set_linestyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_linestyle |
get_linewidth()[source]
Return the linewidth in points. See also set_linewidth. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_linewidth |
get_ls()[source]
Alias for get_linestyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_ls |
get_lw()[source]
Alias for get_linewidth. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_lw |
get_marker()[source]
Return the line marker. See also set_marker. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_marker |
get_markeredgecolor()[source]
Return the marker edge color. See also set_markeredgecolor. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_markeredgecolor |
get_markeredgewidth()[source]
Return the marker edge width in points. See also set_markeredgewidth. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_markeredgewidth |
get_markerfacecolor()[source]
Return the marker face color. See also set_markerfacecolor. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_markerfacecolor |
get_markerfacecoloralt()[source]
Return the alternate marker face color. See also set_markerfacecoloralt. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_markerfacecoloralt |
get_markersize()[source]
Return the marker size in points. See also set_markersize. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_markersize |
get_markevery()[source]
Return the markevery setting for marker subsampling. See also set_markevery. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_markevery |
get_mec()[source]
Alias for get_markeredgecolor. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_mec |
get_mew()[source]
Alias for get_markeredgewidth. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_mew |
get_mfc()[source]
Alias for get_markerfacecolor. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_mfc |
get_mfcalt()[source]
Alias for get_markerfacecoloralt. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_mfcalt |
get_ms()[source]
Alias for get_markersize. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_ms |
get_path()[source]
Return the Path associated with this line. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_path |
get_pickradius()[source]
Return the pick radius used for containment tests. See contains for more details. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_pickradius |
get_solid_capstyle()[source]
Return the CapStyle for solid lines. See also set_solid_capstyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_solid_capstyle |
get_solid_joinstyle()[source]
Return the JoinStyle for solid lines. See also set_solid_joinstyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_solid_joinstyle |
get_window_extent(renderer)[source]
Get the artist's bounding box in display space. The bounding box' width and height are nonnegative. Subclasses should override for inclusion in the bounding box "tight" calculation. Default is to return an empty bounding box at 0, 0. Be careful when using this function, the results... | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_window_extent |
get_xdata(orig=True)[source]
Return the xdata. If orig is True, return the original data, else the processed data. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_xdata |
get_xydata()[source]
Return the xy data as a Nx2 numpy array. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_xydata |
get_ydata(orig=True)[source]
Return the ydata. If orig is True, return the original data, else the processed data. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.get_ydata |
is_dashed()[source]
Return whether line has a dashed linestyle. A custom linestyle is assumed to be dashed, we do not inspect the onoffseq directly. See also set_linestyle. | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.is_dashed |
lineStyles={'': '_draw_nothing', ' ': '_draw_nothing', '-': '_draw_solid', '--': '_draw_dashed', '-.': '_draw_dash_dot', ':': '_draw_dotted', 'None': '_draw_nothing'} | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.lineStyles |
markers={'.': 'point', ',': 'pixel', 'o': 'circle', 'v': 'triangle_down', '^': 'triangle_up', '<': 'triangle_left', '>': 'triangle_right', '1': 'tri_down', '2': 'tri_up', '3': 'tri_left', '4': 'tri_right', '8': 'octagon', 's': 'square', 'p': 'pentagon', '*': 'star', 'h': 'hexagon1', 'H': 'hexagon2', '+': 'plus', 'x': '... | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.markers |
recache(always=False)[source] | matplotlib._as_gen.matplotlib.lines.line2d#matplotlib.lines.Line2D.recache |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.