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 results will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly. | 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>, title=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
bbox_to_anchor BboxBase or tuple
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
draggable bool
figure Figure
frame_on bool
gid str
in_layout bool
label object
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
title unknown
transform Transform
url str
visible bool
zorder float | 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 tuple of (left, bottom) where the width and height will be assumed to be zero.
None, to remove the bbox anchoring, and use the parent bbox.
transformTransform, optional
A transform to apply to the bounding box. If not specified, this will use a transform to the bounding box of the parent. | 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 legend parameter to be changed when dragged: 'loc': update the loc parameter of the legend 'bbox': update the bbox_to_anchor parameter of the legend Returns
DraggableLegend or None
If state is True this returns the DraggableLegend helper instance. Otherwise this returns None. | 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(legend, orig_handle, fontsize, handlebox)
Where legend is the legend itself, orig_handle is the original plot, fontsize is the fontsize in pixels, and handlebox is a OffsetBox instance. Within the call, you should create relevant artists (using relevant properties from the legend and/or orig_handle) and add them into the handlebox. The artists needs to be scaled according to the fontsize (note that the size is in pixel, i.e., this is dpi-scaled value). This module includes definition of several legend handler classes derived from the base class (HandlerBase) with the following method: def legend_artist(self, legend, orig_handle, fontsize, handlebox)
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, width, height, fontsize,
trans):
The overridden method needs to create artists of the given transform that fits in the given dimension (xdescent, ydescent, width, height) that are scaled by fontsize if necessary. adjust_drawing_area(legend, orig_handle, xdescent, ydescent, width, height, fontsize)[source]
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
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 these legend artists are being created.
fontsizeint
The fontsize in pixels. The artists being created should be scaled according to the given fontsize.
handleboxmatplotlib.offsetbox.OffsetBox
The box which has been created to hold this legend entry's artists. Artists created in the legend_artist method must be added to this handlebox inside this method.
update_prop(legend_handle, orig_handle, legend)[source]
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 arguments forwarded to HandlerNpoints. create_collection(orig_handle, sizes, offsets, transOffset)[source]
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 forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
get_err_size(legend, xdescent, ydescent, width, height, fontsize)[source]
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 legend entry.
numpointsint
Number of points to show in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
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.
numpointsint
Number of points to show in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
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 HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
get_numpoints(legend)[source]
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 arguments forwarded to HandlerBase. get_numpoints(legend)[source]
get_xdata(legend, xdescent, ydescent, width, height, fontsize)[source]
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
Length numpoints list of y offsets for each point in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. get_ydata(legend, xdescent, ydescent, width, height, fontsize)[source]
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,
xdescent=xdescent, ydescent=ydescent,
width=width, height=height, fontsize=fontsize)
Subsequently the created artist will have its update_prop method called and the appropriate transform will be applied. **kwargs
Keyword arguments forwarded to HandlerBase. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
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 entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. create_collection(orig_handle, sizes, offsets, transOffset)[source]
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]
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
Keyword arguments forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
create_collection(orig_handle, sizes, offsets, transOffset)[source]
get_numpoints(legend)[source]
get_sizes(legend, orig_handle, xdescent, ydescent, width, height, fontsize)[source]
update_prop(legend_handle, orig_handle, legend)[source]
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.
bottomfloat, optional
yoffsetsarray of floats, optional
Length numpoints list of y offsets for each point in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpointsYoffsets. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
get_ydata(legend, xdescent, ydescent, width, height, fontsize)[source]
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]
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 units of fraction of font size. **kwargs
Keyword arguments forwarded to HandlerBase. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
matplotlib.legend_handler.update_from_first_child(tgt, src)[source] | 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, width, height, fontsize,
trans):
The overridden method needs to create artists of the given transform that fits in the given dimension (xdescent, ydescent, width, height) that are scaled by fontsize if necessary. adjust_drawing_area(legend, orig_handle, xdescent, ydescent, width, height, fontsize)[source]
create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
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 these legend artists are being created.
fontsizeint
The fontsize in pixels. The artists being created should be scaled according to the given fontsize.
handleboxmatplotlib.offsetbox.OffsetBox
The box which has been created to hold this legend entry's artists. Artists created in the legend_artist method must be added to this handlebox inside this method.
update_prop(legend_handle, orig_handle, legend)[source] | 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 these legend artists are being created.
fontsizeint
The fontsize in pixels. The artists being created should be scaled according to the given fontsize.
handleboxmatplotlib.offsetbox.OffsetBox
The box which has been created to hold this legend entry's artists. Artists created in the legend_artist method must be added to this handlebox inside this method. | 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 arguments forwarded to HandlerNpoints. create_collection(orig_handle, sizes, offsets, transOffset)[source] | 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 forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
get_err_size(legend, xdescent, ydescent, width, height, fontsize)[source] | 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 legend entry.
numpointsint
Number of points to show in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | 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.
numpointsint
Number of points to show in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | 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 HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
get_numpoints(legend)[source] | 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 arguments forwarded to HandlerBase. get_numpoints(legend)[source]
get_xdata(legend, xdescent, ydescent, width, height, fontsize)[source] | 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
Length numpoints list of y offsets for each point in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. get_ydata(legend, xdescent, ydescent, width, height, fontsize)[source] | 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,
xdescent=xdescent, ydescent=ydescent,
width=width, height=height, fontsize=fontsize)
Subsequently the created artist will have its update_prop method called and the appropriate transform will be applied. **kwargs
Keyword arguments forwarded to HandlerBase. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | 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 entry. **kwargs
Keyword arguments forwarded to HandlerNpoints. create_collection(orig_handle, sizes, offsets, transOffset)[source] | 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
Keyword arguments forwarded to HandlerNpoints. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
create_collection(orig_handle, sizes, offsets, transOffset)[source]
get_numpoints(legend)[source]
get_sizes(legend, orig_handle, xdescent, ydescent, width, height, fontsize)[source]
update_prop(legend_handle, orig_handle, legend)[source] | 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.
bottomfloat, optional
yoffsetsarray of floats, optional
Length numpoints list of y offsets for each point in legend entry. **kwargs
Keyword arguments forwarded to HandlerNpointsYoffsets. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source]
get_ydata(legend, xdescent, ydescent, width, height, fontsize)[source] | 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 units of fraction of font size. **kwargs
Keyword arguments forwarded to HandlerBase. create_artists(legend, orig_handle, xdescent, ydescent, width, height, fontsize, trans)[source] | 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 list of selected vertices for Line2D. Functions
segment_hits(cx, cy, x, y, radius) Return the indices of the segments in the polyline with coordinates (cx, cy) that are within a distance radius of the point (x, y). | 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_joinstyle=None, solid_joinstyle=None, pickradius=5, drawstyle=None, markevery=None, **kwargs)[source]
Bases: matplotlib.artist.Artist A line - the line can have both a solid linestyle connecting all the vertices, and a marker at each vertex. Additionally, the drawing of the solid line is influenced by the drawstyle, e.g., one can create "stepped" lines in various styles. Create a Line2D instance with x and y data in sequences of xdata, ydata. Additional keyword arguments 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 set_linestyle() for a description of the line styles, set_marker() for a description of the markers, and set_drawstyle() for a description of the draw styles. 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.MouseEvent
Returns
containsbool
Whether any values are within the radius.
detailsdict
A dictionary {'ind': pointlist}, where pointlist is a list of points of the line that are within the pickradius around the event position. TODO: sort returned indices by distance
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.
drawStyleKeys=['default', 'steps-mid', 'steps-pre', 'steps-post', 'steps']
drawStyles={'default': '_draw_lines', 'steps': '_draw_steps_pre', 'steps-mid': '_draw_steps_mid', 'steps-post': '_draw_steps_post', 'steps-pre': '_draw_steps_pre'}
fillStyles=('full', 'left', 'right', 'bottom', 'top', 'none')
filled_markers=('o', 'v', '^', '<', '>', '8', 's', 'p', '*', 'h', 'H', 'D', 'd', 'P', 'X')
get_aa()[source]
Alias for get_antialiased.
get_antialiased()[source]
Return whether antialiased rendering is used.
get_c()[source]
Alias for get_color.
get_color()[source]
Return the line color. See also set_color.
get_dash_capstyle()[source]
Return the CapStyle for dashed lines. See also set_dash_capstyle.
get_dash_joinstyle()[source]
Return the JoinStyle for dashed lines. See also set_dash_joinstyle.
get_data(orig=True)[source]
Return the line data as an (xdata, ydata) pair. If orig is True, return the original data.
get_drawstyle()[source]
Return the drawstyle. See also set_drawstyle.
get_ds()[source]
Alias for get_drawstyle.
get_fillstyle()[source]
Return the marker fill style. See also set_fillstyle.
get_linestyle()[source]
Return the linestyle. See also set_linestyle.
get_linewidth()[source]
Return the linewidth in points. See also set_linewidth.
get_ls()[source]
Alias for get_linestyle.
get_lw()[source]
Alias for get_linewidth.
get_marker()[source]
Return the line marker. See also set_marker.
get_markeredgecolor()[source]
Return the marker edge color. See also set_markeredgecolor.
get_markeredgewidth()[source]
Return the marker edge width in points. See also set_markeredgewidth.
get_markerfacecolor()[source]
Return the marker face color. See also set_markerfacecolor.
get_markerfacecoloralt()[source]
Return the alternate marker face color. See also set_markerfacecoloralt.
get_markersize()[source]
Return the marker size in points. See also set_markersize.
get_markevery()[source]
Return the markevery setting for marker subsampling. See also set_markevery.
get_mec()[source]
Alias for get_markeredgecolor.
get_mew()[source]
Alias for get_markeredgewidth.
get_mfc()[source]
Alias for get_markerfacecolor.
get_mfcalt()[source]
Alias for get_markerfacecoloralt.
get_ms()[source]
Alias for get_markersize.
get_path()[source]
Return the Path associated with this line.
get_pickradius()[source]
Return the pick radius used for containment tests. See contains for more details.
get_solid_capstyle()[source]
Return the CapStyle for solid lines. See also set_solid_capstyle.
get_solid_joinstyle()[source]
Return the JoinStyle for solid lines. See also set_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 will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly.
get_xdata(orig=True)[source]
Return the xdata. If orig is True, return the original data, else the processed data.
get_xydata()[source]
Return the xy data as a Nx2 numpy array.
get_ydata(orig=True)[source]
Return the ydata. If orig is True, return the original data, else the processed data.
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.
lineStyles={'': '_draw_nothing', ' ': '_draw_nothing', '-': '_draw_solid', '--': '_draw_dashed', '-.': '_draw_dash_dot', ':': '_draw_dotted', 'None': '_draw_nothing'}
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': 'x', 'D': 'diamond', 'd': 'thin_diamond', '|': 'vline', '_': 'hline', 'P': 'plus_filled', 'X': 'x_filled', 0: 'tickleft', 1: 'tickright', 2: 'tickup', 3: 'tickdown', 4: 'caretleft', 5: 'caretright', 6: 'caretup', 7: 'caretdown', 8: 'caretleftbase', 9: 'caretrightbase', 10: 'caretupbase', 11: 'caretdownbase', 'None': 'nothing', None: 'nothing', ' ': 'nothing', '': 'nothing'}
propertypickradius
Return the pick radius used for containment tests. See contains for more details.
recache(always=False)[source]
recache_always()[source]
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, dash_capstyle=<UNSET>, dash_joinstyle=<UNSET>, dashes=<UNSET>, data=<UNSET>, drawstyle=<UNSET>, fillstyle=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, marker=<UNSET>, markeredgecolor=<UNSET>, markeredgewidth=<UNSET>, markerfacecolor=<UNSET>, markerfacecoloralt=<UNSET>, markersize=<UNSET>, markevery=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, solid_capstyle=<UNSET>, solid_joinstyle=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, xdata=<UNSET>, ydata=<UNSET>, zorder=<UNSET>)[source]
Set multiple properties at once. Supported properties are
Property Description
agg_filter a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array
alpha scalar or None
animated bool
antialiased bool
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
color 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 {'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 {'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
linewidth float
marker marker style string, Path or MarkerStyle
markeredgecolor color
markeredgewidth float
markerfacecolor color
markerfacecoloralt color
markersize 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
set_aa(b)[source]
Alias for set_antialiased.
set_antialiased(b)[source]
Set whether to use antialiased rendering. Parameters
bbool
set_c(color)[source]
Alias for set_color.
set_color(color)[source]
Set the color of the line. Parameters
colorcolor
set_dash_capstyle(s)[source]
How to draw the end caps if the line is is_dashed. Parameters
sCapStyle or {'butt', 'projecting', 'round'}
set_dash_joinstyle(s)[source]
How to join segments of the line if it is_dashed. Parameters
sJoinStyle or {'miter', 'round', 'bevel'}
set_dashes(seq)[source]
Set the dash sequence. The dash sequence is a sequence of floats of even length describing the length of dashes and spaces in points. For example, (5, 2, 1, 2) describes a sequence of 5 point and 1 point dashes separated by 2 point spaces. Parameters
seqsequence of floats (on/off ink in points) or (None, None)
If seq is empty or (None, None), the linestyle will be set to solid.
set_data(*args)[source]
Set the x and y data. Parameters
*args(2, N) array or two 1D arrays
set_drawstyle(drawstyle)[source]
Set the drawstyle of the plot. The drawstyle determines how the points are connected. Parameters
drawstyle{'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'}, default: 'default'
For 'default', the points are connected with straight lines. The steps variants connect the points with step-like lines, i.e. horizontal lines with vertical steps. They differ in the location of the step: 'steps-pre': The step is at the beginning of the line segment, i.e. the line will be at the y-value of point to the right. 'steps-mid': The step is halfway between the points. 'steps-post: The step is at the end of the line segment, i.e. the line will be at the y-value of the point to the left. 'steps' is equal to 'steps-pre' and is maintained for backward-compatibility. For examples see Step Demo.
set_ds(drawstyle)[source]
Alias for set_drawstyle.
set_fillstyle(fs)[source]
Set the marker fill style. Parameters
fs{'full', 'left', 'right', 'bottom', 'top', 'none'}
Possible values: 'full': Fill the whole marker with the markerfacecolor. 'left', 'right', 'bottom', 'top': Fill the marker half at the given side with the markerfacecolor. The other half of the marker is filled with markerfacecoloralt. 'none': No filling. For examples see Marker fill styles.
set_linestyle(ls)[source]
Set the linestyle of the line. Parameters
ls{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}
Possible values:
A string:
linestyle description
'-' or 'solid' solid line
'--' or 'dashed' dashed line
'-.' or 'dashdot' dash-dotted line
':' or 'dotted' dotted line
'none', 'None', ' ', or '' draw nothing
Alternatively a dash tuple of the following form can be provided: (offset, onoffseq)
where onoffseq is an even length tuple of on and off ink in points. See also set_dashes(). For examples see Linestyles.
set_linewidth(w)[source]
Set the line width in points. Parameters
wfloat
Line width, in points.
set_ls(ls)[source]
Alias for set_linestyle.
set_lw(w)[source]
Alias for set_linewidth.
set_marker(marker)[source]
Set the line marker. Parameters
markermarker style string, Path or MarkerStyle
See markers for full description of possible arguments.
set_markeredgecolor(ec)[source]
Set the marker edge color. Parameters
eccolor
set_markeredgewidth(ew)[source]
Set the marker edge width in points. Parameters
ewfloat
Marker edge width, in points.
set_markerfacecolor(fc)[source]
Set the marker face color. Parameters
fccolor
set_markerfacecoloralt(fc)[source]
Set the alternate marker face color. Parameters
fccolor
set_markersize(sz)[source]
Set the marker size in points. Parameters
szfloat
Marker size, in points.
set_markevery(every)[source]
Set the markevery property to subsample the plot when using markers. e.g., if every=5, every 5-th marker will be plotted. Parameters
everyNone or int or (int, int) or slice or list[int] or float or (float, float) or list[bool]
Which markers to plot.
every=None: every point will be plotted.
every=N: every N-th marker will be plotted starting with marker 0.
every=(start, N): every N-th marker, starting at index start, will be plotted.
every=slice(start, end, N): every N-th marker, starting at index start, up to but not including index end, will be plotted.
every=[i, j, m, ...]: only markers at the given indices will be plotted.
every=[True, False, True, ...]: only positions that are True will be plotted. The list must have the same length as the data points.
every=0.1, (i.e. a float): markers will be spaced at approximately equal visual distances along the line; the distance along the line between markers is determined by multiplying the display-coordinate distance of the axes bounding-box diagonal by the value of every.
every=(0.5, 0.1) (i.e. a length-2 tuple of float): similar to every=0.1 but the first marker will be offset along the line by 0.5 multiplied by the display-coordinate-diagonal-distance along the line. For examples see Markevery Demo. Notes Setting markevery will still only draw markers at actual data points. While the float argument form aims for uniform visual spacing, it has to coerce from the ideal spacing to the nearest available data point. Depending on the number and distribution of data points, the result may still not look evenly spaced. When using a start offset to specify the first marker, the offset will be from the first data point which may be different from the first the visible data point if the plot is zoomed in. If zooming in on a plot when using float arguments then the actual data points that have markers will change because the distance between markers is always determined from the display-coordinates axes-bounding-box-diagonal regardless of the actual axes data limits.
set_mec(ec)[source]
Alias for set_markeredgecolor.
set_mew(ew)[source]
Alias for set_markeredgewidth.
set_mfc(fc)[source]
Alias for set_markerfacecolor.
set_mfcalt(fc)[source]
Alias for set_markerfacecoloralt.
set_ms(sz)[source]
Alias for set_markersize.
set_picker(p)[source]
Set the event picker details for the line. Parameters
pfloat or callable[[Artist, Event], tuple[bool, dict]]
If a float, it is used as the pick radius in points.
set_pickradius(d)[source]
Set the pick radius used for containment tests. See contains for more details. Parameters
dfloat
Pick radius, in points.
set_solid_capstyle(s)[source]
How to draw the end caps if the line is solid (not is_dashed) Parameters
sCapStyle or {'butt', 'projecting', 'round'}
set_solid_joinstyle(s)[source]
How to join segments if the line is solid (not is_dashed). Parameters
sJoinStyle or {'miter', 'round', 'bevel'}
set_transform(t)[source]
Set the artist transform. Parameters
tTransform
set_xdata(x)[source]
Set the data array for x. Parameters
x1D array
set_ydata(y)[source]
Set the data array for y. Parameters
y1D array
update_from(other)[source]
Copy properties from other to self.
validCap=('butt', 'projecting', 'round')
validJoin=('miter', 'round', 'bevel')
zorder=2
Examples using matplotlib.lines.Line2D
Customizing dashed line styles
Stem Plot
Figure labels: suptitle, supxlabel, supylabel
Boxplots
Scale invariant angle label
Annotating Plots
Composing Custom Legends
Annotation arrow style reference
Figure legend demo
Legend Demo
Artist within an artist
Annotating a plot
Annotation Polar
Fig Axes Customize Simple
Simple axes labels
Adding lines to figures
Reference for Matplotlib artists
PathPatch object
Parasite Simple
Parasite Axes demo
Parasite axis demo
Bachelor's degrees by gender
Decay
The double pendulum problem
Animated line plot
Oscilloscope
MATPLOTLIB UNCHAINED
Data Browser
Legend Picking
Looking Glass
Pick Event Demo
Pick Event Demo2
Poly Editor
Resampling Data
Anchored Artists
Cross hair cursor
Patheffect Demo
Set and get properties
SVG Filter Line
SkewT-logP diagram: using transforms and custom projections
Multiple Yaxis With Spines
Artist tests
Simple Legend02
Annotated Cursor
Buttons
Check Buttons
Radio Buttons
Thresholding an Image with RangeSlider
Slider
Snapping Sliders to Discrete Values
Span Selector
Textbox
Basic Usage
Pyplot tutorial
Artist tutorial
Legend guide
Faster rendering by using blitting
Transformations Tutorial | 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.MouseEvent
Returns
containsbool
Whether any values are within the radius.
detailsdict
A dictionary {'ind': pointlist}, where pointlist is a list of points of the line that are within the pickradius around the event position. TODO: sort returned indices by distance | 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 will not update if the artist window extent of the artist changes. The extent can change due to any changes in the transform stack, such as changing the axes limits, the figure size, or the canvas used (as is done when saving a figure). This can lead to unexpected behavior where interactive figures will look fine on the screen, but will save incorrectly. | 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': 'x', 'D': 'diamond', 'd': 'thin_diamond', '|': 'vline', '_': 'hline', 'P': 'plus_filled', 'X': 'x_filled', 0: 'tickleft', 1: 'tickright', 2: 'tickup', 3: 'tickdown', 4: 'caretleft', 5: 'caretright', 6: 'caretup', 7: 'caretdown', 8: 'caretleftbase', 9: 'caretrightbase', 10: 'caretupbase', 11: 'caretdownbase', 'None': 'nothing', None: 'nothing', ' ': 'nothing', '': 'nothing'} | 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.