class matplotlib.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 xdata, ydata.
The kwargs are Line2D
properties:
Property | Description |
---|---|
agg_filter | a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array |
alpha | float |
animated | bool |
antialiased | bool |
clip_box | Bbox |
clip_on | bool |
clip_path | [(Path , Transform ) | Patch | None] |
color | color |
contains | callable |
dash_capstyle | {'butt', 'round', 'projecting'} |
dash_joinstyle | {'miter', 'round', 'bevel'} |
dashes | sequence of floats (on/off ink in points) or (None, None) |
drawstyle | {'default', 'steps', 'steps-pre', 'steps-mid', 'steps-post'} |
figure | Figure |
fillstyle | {'full', 'left', 'right', 'bottom', 'top', 'none'} |
gid | str |
in_layout | bool |
label | object |
linestyle | {'-', '--', '-.', ':', '', (offset, on-off-seq), ...} |
linewidth | float |
marker | unknown |
markeredgecolor | color |
markeredgewidth | float |
markerfacecolor | color |
markerfacecoloralt | color |
markersize | float |
markevery | unknown |
path_effects | AbstractPathEffect |
picker | float or callable[[Artist, Event], Tuple[bool, dict]] |
pickradius | float |
rasterized | bool or None |
sketch_params | (scale: float, length: float, randomness: float) |
snap | bool or None |
solid_capstyle | {'butt', 'round', 'projecting'} |
solid_joinstyle | {'miter', 'round', 'bevel'} |
transform | matplotlib.transforms.Transform |
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.
axes
The Axes
instance the artist resides in, or None.
contains(mouseevent)
[source]
Test whether the mouse event occurred on the line. The pick radius determines the precision of the location test (usually within five points of the value). Use get_pickradius()
or set_pickradius()
to view or modify it.
Returns True if any values are within the radius along with {'ind': pointlist}
, where pointlist is the set of points within the radius.
TODO: sort returned indices by distance
draw(renderer)
[source]
draw the Line with renderer
unless visibility is False
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(*args, **kwargs)
alias for get_antialiased
get_antialiased()
[source]
get_c(*args, **kwargs)
alias for get_color
get_color()
[source]
get_dash_capstyle()
[source]
Get the cap style for dashed linestyles
get_dash_joinstyle()
[source]
Get the join style for dashed linestyles
get_data(orig=True)
[source]
Return the xdata, ydata.
If orig is True, return the original data.
get_drawstyle()
[source]
get_fillstyle()
[source]
return the marker fillstyle
get_linestyle()
[source]
get_linewidth()
[source]
get_ls(*args, **kwargs)
alias for get_linestyle
get_lw(*args, **kwargs)
alias for get_linewidth
get_marker()
[source]
get_markeredgecolor()
[source]
get_markeredgewidth()
[source]
get_markerfacecolor()
[source]
get_markerfacecoloralt()
[source]
get_markersize()
[source]
get_markevery()
[source]
return the markevery setting
get_mec(*args, **kwargs)
alias for get_markeredgecolor
get_mew(*args, **kwargs)
alias for get_markeredgewidth
get_mfc(*args, **kwargs)
alias for get_markerfacecolor
get_mfcalt(*args, **kwargs)
alias for get_markerfacecoloralt
get_ms(*args, **kwargs)
alias for get_markersize
get_pickradius()
[source]
return the pick radius used for containment tests
get_solid_capstyle()
[source]
Get the cap style for solid linestyles
get_solid_joinstyle()
[source]
Get the join style for solid linestyles
get_window_extent(renderer)
[source]
Get the axes bounding box in display space. 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 True if line is dashstyle
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'}
recache(always=False)
[source]
recache_always()
[source]
set_aa(*args, **kwargs)
alias for set_antialiased
set_antialiased(b)
[source]
Set whether to use antialiased rendering.
Parameters: |
|
---|
set_c(*args, **kwargs)
alias for set_color
set_color(color)
[source]
Set the color of the line
Parameters: |
|
---|
set_dash_capstyle(s)
[source]
Set the cap style for dashed linestyles.
Parameters: |
|
---|
set_dash_joinstyle(s)
[source]
Set the join style for dashed linestyles.
Parameters: |
|
---|
set_dashes(seq)
[source]
Set the dash sequence, sequence of dashes with on off ink in points. If seq is empty or if seq = (None, None), the linestyle will be set to solid.
Parameters: |
|
---|
set_data(*args)
[source]
Set the x and y data
ACCEPTS: 2D array (rows are x, y) or two 1D arrays
set_drawstyle(drawstyle)
[source]
Set the drawstyle of the plot
'default' connects the points with lines. The steps variants produce step-plots. 'steps' is equivalent to 'steps-pre' and is maintained for backward-compatibility.
Parameters: |
|
---|
set_fillstyle(fs)
[source]
Set the marker fill style; 'full' means fill the whole marker. 'none' means no filling; other options are for half-filled markers.
Parameters: |
|
---|
set_linestyle(ls)
[source]
Set the linestyle of the line (also accepts drawstyles, e.g., 'steps--'
)
linestyle | description |
---|---|
'-' or 'solid'
| solid line |
'--' or 'dashed'
| dashed line |
'-.' or 'dashdot'
| dash-dotted line |
':' or 'dotted'
| dotted line |
'None' | draw nothing |
' ' | draw nothing |
'' | draw nothing |
'steps' is equivalent to 'steps-pre' and is maintained for backward-compatibility.
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_drawstyle()
Parameters: |
|
---|
set_linewidth(w)
[source]
Set the line width in points
Parameters: |
|
---|
set_ls(*args, **kwargs)
alias for set_linestyle
set_lw(*args, **kwargs)
alias for set_linewidth
set_marker(marker)
[source]
Set the line marker.
Parameters: |
|
---|
set_markeredgecolor(ec)
[source]
Set the marker edge color.
Parameters: |
|
---|
set_markeredgewidth(ew)
[source]
Set the marker edge width in points.
Parameters: |
|
---|
set_markerfacecolor(fc)
[source]
Set the marker face color.
Parameters: |
|
---|
set_markerfacecoloralt(fc)
[source]
Set the alternate marker face color.
Parameters: |
|
---|
set_markersize(sz)
[source]
Set the marker size in points.
Parameters: |
|
---|
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: |
|
---|
Setting the markevery property will only show markers at actual data points. When using float arguments to set the markevery property on irregularly spaced data, the markers will likely not appear evenly spaced because the actual data points do not coincide with the theoretical spacing between markers.
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(*args, **kwargs)
alias for set_markeredgecolor
set_mew(*args, **kwargs)
alias for set_markeredgewidth
set_mfc(*args, **kwargs)
alias for set_markerfacecolor
set_mfcalt(*args, **kwargs)
alias for set_markerfacecoloralt
set_ms(*args, **kwargs)
alias for set_markersize
set_picker(p)
[source]
Sets the event picker details for the line.
Parameters: |
|
---|
set_pickradius(d)
[source]
Set the pick radius used for containment tests.
Parameters: |
|
---|
set_solid_capstyle(s)
[source]
Set the cap style for solid linestyles.
Parameters: |
|
---|
set_solid_joinstyle(s)
[source]
Set the join style for solid linestyles.
Parameters: |
|
---|
set_transform(t)
[source]
set the Transformation instance used by this artist
Parameters: |
|
---|
set_xdata(x)
[source]
Set the data array for x.
Parameters: |
|
---|
set_ydata(y)
[source]
Set the data array for y.
Parameters: |
|
---|
update_from(other)
[source]
copy properties from other to self
validCap = ('butt', 'round', 'projecting')
validJoin = ('miter', 'round', 'bevel')
zorder = 2
matplotlib.lines.Line2D
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.0.0/api/_as_gen/matplotlib.lines.Line2D.html