doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
format_cursor_data(data)[source]
Return a string representation of data. Note This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself. The default implementation converts ints and floats and arrays of ints and floats into a comma-separated string enclosed in square brackets, unless the artist has an associated colorbar, in which case scalar values are formatted using the colorbar's formatter. See also get_cursor_data | matplotlib.collections_api#matplotlib.collections.TriMesh.format_cursor_data |
get_agg_filter()[source]
Return filter function to be used for agg filter. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_agg_filter |
get_alpha()[source]
Return the alpha value used for blending - not supported on all backends. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_alpha |
get_animated()[source]
Return whether the artist is animated. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_animated |
get_array()[source]
Return the array of values, that are mapped to colors. The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the array. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_array |
get_capstyle()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_capstyle |
get_children()[source]
Return a list of the child Artists of this Artist. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_children |
get_clim()[source]
Return the values (min, max) that are mapped to the colormap limits. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_clim |
get_clip_box()[source]
Return the clipbox. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_clip_box |
get_clip_on()[source]
Return whether the artist uses clipping. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_clip_on |
get_clip_path()[source]
Return the clip path. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_clip_path |
get_cmap()[source]
Return the Colormap instance. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_cmap |
get_cursor_data(event)[source]
Return the cursor data for a given event. Note This method is intended to be overridden by artist subclasses. As an end-user of Matplotlib you will most likely not call this method yourself. Cursor data can be used by Artists to provide additional context information for a given event. The default implementation just returns None. Subclasses can override the method and return arbitrary data. However, when doing so, they must ensure that format_cursor_data can convert the data to a string representation. The only current use case is displaying the z-value of an AxesImage in the status bar of a plot window, while moving the mouse. Parameters
eventmatplotlib.backend_bases.MouseEvent
See also format_cursor_data | matplotlib.collections_api#matplotlib.collections.TriMesh.get_cursor_data |
get_dashes()[source]
Alias for get_linestyle. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_dashes |
get_datalim(transData)[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_datalim |
get_ec()[source]
Alias for get_edgecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_ec |
get_edgecolor()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_edgecolor |
get_edgecolors()[source]
Alias for get_edgecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_edgecolors |
get_facecolor()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_facecolor |
get_facecolors()[source]
Alias for get_facecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_facecolors |
get_fc()[source]
Alias for get_facecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_fc |
get_figure()[source]
Return the Figure instance the artist belongs to. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_figure |
get_fill()[source]
Return whether face is colored. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_fill |
get_gid()[source]
Return the group id. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_gid |
get_hatch()[source]
Return the current hatching pattern. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_hatch |
get_in_layout()[source]
Return boolean flag, True if artist is included in layout calculations. E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight'). | matplotlib.collections_api#matplotlib.collections.TriMesh.get_in_layout |
get_joinstyle()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_joinstyle |
get_label()[source]
Return the label used for this artist in the legend. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_label |
get_linestyle()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_linestyle |
get_linestyles()[source]
Alias for get_linestyle. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_linestyles |
get_linewidth()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_linewidth |
get_linewidths()[source]
Alias for get_linewidth. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_linewidths |
get_ls()[source]
Alias for get_linestyle. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_ls |
get_lw()[source]
Alias for get_linewidth. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_lw |
get_offset_transform()[source]
Return the Transform instance used by this artist offset. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_offset_transform |
get_offsets()[source]
Return the offsets for the collection. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_offsets |
get_path_effects()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_path_effects |
get_paths()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_paths |
get_picker()[source]
Return the picking behavior of the artist. The possible values are described in set_picker. See also
set_picker, pickable, pick | matplotlib.collections_api#matplotlib.collections.TriMesh.get_picker |
get_pickradius()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_pickradius |
get_rasterized()[source]
Return whether the artist is to be rasterized. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_rasterized |
get_sketch_params()[source]
Return the sketch parameters for the artist. Returns
tuple or None
A 3-tuple with the following elements:
scale: The amplitude of the wiggle perpendicular to the source line.
length: The length of the wiggle along the line.
randomness: The scale factor by which the length is shrunken or expanded. Returns None if no sketch parameters were set. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_sketch_params |
get_snap()[source]
Return the snap setting. See set_snap for details. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_snap |
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.collections_api#matplotlib.collections.TriMesh.get_tightbbox |
get_transform()[source]
Return the Transform instance used by this artist. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_transform |
get_transformed_clip_path_and_affine()[source]
Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_transformed_clip_path_and_affine |
get_transforms()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.get_transforms |
get_url()[source]
Return the url. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_url |
get_urls()[source]
Return a list of URLs, one for each element of the collection. The list contains None for elements without a URL. See Hyperlinks for an example. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_urls |
get_visible()[source]
Return the visibility. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_visible |
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.collections_api#matplotlib.collections.TriMesh.get_window_extent |
get_zorder()[source]
Return the artist's zorder. | matplotlib.collections_api#matplotlib.collections.TriMesh.get_zorder |
have_units()[source]
Return whether units are set on any axis. | matplotlib.collections_api#matplotlib.collections.TriMesh.have_units |
is_transform_set()[source]
Return whether the Artist has an explicitly set transform. This is True after set_transform has been called. | matplotlib.collections_api#matplotlib.collections.TriMesh.is_transform_set |
pchanged()[source]
Call all of the registered callbacks. This function is triggered internally when a property is changed. See also add_callback
remove_callback | matplotlib.collections_api#matplotlib.collections.TriMesh.pchanged |
pick(mouseevent)[source]
Process a pick event. Each child artist will fire a pick event if mouseevent is over the artist and the artist has picker set. See also
set_picker, get_picker, pickable | matplotlib.collections_api#matplotlib.collections.TriMesh.pick |
pickable()[source]
Return whether the artist is pickable. See also
set_picker, get_picker, pick | matplotlib.collections_api#matplotlib.collections.TriMesh.pickable |
properties()[source]
Return a dictionary of all the properties of the artist. | matplotlib.collections_api#matplotlib.collections.TriMesh.properties |
remove()[source]
Remove the artist from the figure if possible. The effect will not be visible until the figure is redrawn, e.g., with FigureCanvasBase.draw_idle. Call relim to update the axes limits if desired. Note: relim will not see collections even if the collection was added to the axes with autolim = True. Note: there is no support for removing the artist's legend entry. | matplotlib.collections_api#matplotlib.collections.TriMesh.remove |
remove_callback(oid)[source]
Remove a callback based on its observer id. See also add_callback | matplotlib.collections_api#matplotlib.collections.TriMesh.remove_callback |
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<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 array-like or scalar or None
animated bool
antialiased or aa or antialiaseds bool or list of bools
array array-like or None
capstyle CapStyle or {'butt', 'projecting', 'round'}
clim (vmin: float, vmax: float)
clip_box Bbox
clip_on bool
clip_path Patch or (Path, Transform) or None
cmap Colormap or str or None
color color or list of rgba tuples
edgecolor or ec or edgecolors color or list of colors or 'face'
facecolor or facecolors or fc color or list of colors
figure Figure
gid str
hatch {'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}
in_layout bool
joinstyle JoinStyle or {'miter', 'round', 'bevel'}
label object
linestyle or dashes or linestyles or ls str or tuple or list thereof
linewidth or linewidths or lw float or list of floats
norm Normalize or None
offset_transform Transform
offsets (N, 2) or (2,) array-like
path_effects AbstractPathEffect
picker None or bool or float or callable
pickradius float
rasterized bool
sketch_params (scale: float, length: float, randomness: float)
snap bool or None
transform Transform
url str
urls list of str or None
visible bool
zorder float | matplotlib.collections_api#matplotlib.collections.TriMesh.set |
set_aa(aa)[source]
Alias for set_antialiased. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_aa |
set_agg_filter(filter_func)[source]
Set the agg filter. Parameters
filter_funccallable
A filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_agg_filter |
set_alpha(alpha)[source]
Set the alpha value used for blending - not supported on all backends. Parameters
alphaarray-like or scalar or None
All values must be within the 0-1 range, inclusive. Masked values and nans are not supported. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_alpha |
set_animated(b)[source]
Set whether the artist is intended to be used in an animation. If True, the artist is excluded from regular drawing of the figure. You have to call Figure.draw_artist / Axes.draw_artist explicitly on the artist. This appoach is used to speed up animations using blitting. See also matplotlib.animation and Faster rendering by using blitting. Parameters
bbool | matplotlib.collections_api#matplotlib.collections.TriMesh.set_animated |
set_antialiased(aa)[source]
Set the antialiasing state for rendering. Parameters
aabool or list of bools | matplotlib.collections_api#matplotlib.collections.TriMesh.set_antialiased |
set_antialiaseds(aa)[source]
Alias for set_antialiased. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_antialiaseds |
set_array(A)[source]
Set the value array from array-like A. Parameters
Aarray-like or None
The values that are mapped to colors. The base class ScalarMappable does not make any assumptions on the dimensionality and shape of the value array A. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_array |
set_capstyle(cs)[source]
Set the CapStyle for the collection (for all its elements). Parameters
csCapStyle or {'butt', 'projecting', 'round'} | matplotlib.collections_api#matplotlib.collections.TriMesh.set_capstyle |
set_clim(vmin=None, vmax=None)[source]
Set the norm limits for image scaling. Parameters
vmin, vmaxfloat
The limits. The limits may also be passed as a tuple (vmin, vmax) as a single positional argument. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_clim |
set_clip_box(clipbox)[source]
Set the artist's clip Bbox. Parameters
clipboxBbox | matplotlib.collections_api#matplotlib.collections.TriMesh.set_clip_box |
set_clip_on(b)[source]
Set whether the artist uses clipping. When False artists will be visible outside of the axes which can lead to unexpected results. Parameters
bbool | matplotlib.collections_api#matplotlib.collections.TriMesh.set_clip_on |
set_clip_path(path, transform=None)[source]
Set the artist's clip path. Parameters
pathPatch or Path or TransformedPath or None
The clip path. If given a Path, transform must be provided as well. If None, a previously set clip path is removed.
transformTransform, optional
Only used if path is a Path, in which case the given Path is converted to a TransformedPath using transform. Notes For efficiency, if path is a Rectangle this method will set the clipping box to the corresponding rectangle and set the clipping path to None. For technical reasons (support of set), a tuple (path, transform) is also accepted as a single positional parameter. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_clip_path |
set_cmap(cmap)[source]
Set the colormap for luminance data. Parameters
cmapColormap or str or None | matplotlib.collections_api#matplotlib.collections.TriMesh.set_cmap |
set_color(c)[source]
Set both the edgecolor and the facecolor. Parameters
ccolor or list of rgba tuples
See also
Collection.set_facecolor, Collection.set_edgecolor
For setting the edge or face color individually. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_color |
set_dashes(ls)[source]
Alias for set_linestyle. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_dashes |
set_ec(c)[source]
Alias for set_edgecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_ec |
set_edgecolor(c)[source]
Set the edgecolor(s) of the collection. Parameters
ccolor or list of colors or 'face'
The collection edgecolor(s). If a sequence, the patches cycle through it. If 'face', match the facecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_edgecolor |
set_edgecolors(c)[source]
Alias for set_edgecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_edgecolors |
set_facecolor(c)[source]
Set the facecolor(s) of the collection. c can be a color (all patches have same color), or a sequence of colors; if it is a sequence the patches will cycle through the sequence. If c is 'none', the patch will not be filled. Parameters
ccolor or list of colors | matplotlib.collections_api#matplotlib.collections.TriMesh.set_facecolor |
set_facecolors(c)[source]
Alias for set_facecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_facecolors |
set_fc(c)[source]
Alias for set_facecolor. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_fc |
set_figure(fig)[source]
Set the Figure instance the artist belongs to. Parameters
figFigure | matplotlib.collections_api#matplotlib.collections.TriMesh.set_figure |
set_gid(gid)[source]
Set the (group) id for the artist. Parameters
gidstr | matplotlib.collections_api#matplotlib.collections.TriMesh.set_gid |
set_hatch(hatch)[source]
Set the hatching pattern hatch can be one of: / - diagonal hatching
\ - back diagonal
| - vertical
- - horizontal
+ - crossed
x - crossed diagonal
o - small circle
O - large circle
. - dots
* - stars
Letters can be combined, in which case all the specified hatchings are done. If same letter repeats, it increases the density of hatching of that pattern. Hatching is supported in the PostScript, PDF, SVG and Agg backends only. Unlike other properties such as linewidth and colors, hatching can only be specified for the collection as a whole, not separately for each member. Parameters
hatch{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'} | matplotlib.collections_api#matplotlib.collections.TriMesh.set_hatch |
set_in_layout(in_layout)[source]
Set if artist is to be included in layout calculations, E.g. Constrained Layout Guide, Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight'). Parameters
in_layoutbool | matplotlib.collections_api#matplotlib.collections.TriMesh.set_in_layout |
set_joinstyle(js)[source]
Set the JoinStyle for the collection (for all its elements). Parameters
jsJoinStyle or {'miter', 'round', 'bevel'} | matplotlib.collections_api#matplotlib.collections.TriMesh.set_joinstyle |
set_label(s)[source]
Set a label that will be displayed in the legend. Parameters
sobject
s will be converted to a string by calling str. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_label |
set_linestyle(ls)[source]
Set the linestyle(s) for the collection.
linestyle description
'-' or 'solid' solid line
'--' or 'dashed' dashed line
'-.' or 'dashdot' dash-dotted line
':' or 'dotted' dotted line 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. Parameters
lsstr or tuple or list thereof
Valid values for individual linestyles include {'-', '--', '-.', ':', '', (offset, on-off-seq)}. See Line2D.set_linestyle for a complete description. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_linestyle |
set_linestyles(ls)[source]
Alias for set_linestyle. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_linestyles |
set_linewidth(lw)[source]
Set the linewidth(s) for the collection. lw can be a scalar or a sequence; if it is a sequence the patches will cycle through the sequence Parameters
lwfloat or list of floats | matplotlib.collections_api#matplotlib.collections.TriMesh.set_linewidth |
set_linewidths(lw)[source]
Alias for set_linewidth. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_linewidths |
set_ls(ls)[source]
Alias for set_linestyle. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_ls |
set_lw(lw)[source]
Alias for set_linewidth. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_lw |
set_norm(norm)[source]
Set the normalization instance. Parameters
normNormalize or None
Notes If there are any colorbars using the mappable for this norm, setting the norm of the mappable will reset the norm, locator, and formatters on the colorbar to default. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_norm |
set_offset_transform(transOffset)[source]
Set the artist offset transform. Parameters
transOffsetTransform | matplotlib.collections_api#matplotlib.collections.TriMesh.set_offset_transform |
set_offsets(offsets)[source]
Set the offsets for the collection. Parameters
offsets(N, 2) or (2,) array-like | matplotlib.collections_api#matplotlib.collections.TriMesh.set_offsets |
set_path_effects(path_effects)[source]
Set the path effects. Parameters
path_effectsAbstractPathEffect | matplotlib.collections_api#matplotlib.collections.TriMesh.set_path_effects |
set_paths()[source] | matplotlib.collections_api#matplotlib.collections.TriMesh.set_paths |
set_picker(picker)[source]
Define the picking behavior of the artist. Parameters
pickerNone or bool or float or callable
This can be one of the following:
None: Picking is disabled for this artist (default). A boolean: If True then picking will be enabled and the artist will fire a pick event if the mouse event is over the artist. A float: If picker is a number it is interpreted as an epsilon tolerance in points and the artist will fire off an event if its data is within epsilon of the mouse event. For some artists like lines and patch collections, the artist may provide additional data to the pick event that is generated, e.g., the indices of the data within epsilon of the pick event
A function: If picker is callable, it is a user supplied function which determines whether the artist is hit by the mouse event: hit, props = picker(artist, mouseevent)
to determine the hit test. if the mouse event is over the artist, return hit=True and props is a dictionary of properties you want added to the PickEvent attributes. | matplotlib.collections_api#matplotlib.collections.TriMesh.set_picker |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.