doc_content stringlengths 1 386k | doc_id stringlengths 5 188 |
|---|---|
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 d... | matplotlib.collections_api#matplotlib.collections.QuadMesh.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.QuadMesh.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.QuadMesh.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.QuadMesh.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 onof... | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_linestyle |
set_linestyles(ls)[source]
Alias for set_linestyle. | matplotlib.collections_api#matplotlib.collections.QuadMesh.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.QuadMesh.set_linewidth |
set_linewidths(lw)[source]
Alias for set_linewidth. | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_linewidths |
set_ls(ls)[source]
Alias for set_linestyle. | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_ls |
set_lw(lw)[source]
Alias for set_linewidth. | matplotlib.collections_api#matplotlib.collections.QuadMesh.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.QuadMesh.set_norm |
set_offset_transform(transOffset)[source]
Set the artist offset transform. Parameters
transOffsetTransform | matplotlib.collections_api#matplotlib.collections.QuadMesh.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.QuadMesh.set_offsets |
set_path_effects(path_effects)[source]
Set the path effects. Parameters
path_effectsAbstractPathEffect | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_path_effects |
set_paths()[source] | matplotlib.collections_api#matplotlib.collections.QuadMesh.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 eve... | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_picker |
set_pickradius(pr)[source]
Set the pick radius used for containment tests. Parameters
prfloat
Pick radius, in points. | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_pickradius |
set_rasterized(rasterized)[source]
Force rasterized (bitmap) drawing for vector graphics output. Rasterized drawing is not supported by all artists. If you try to enable this on an artist that does not support it, the command has no effect and a warning will be issued. This setting is ignored for pixel-based output. ... | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_rasterized |
set_sketch_params(scale=None, length=None, randomness=None)[source]
Set the sketch parameters. Parameters
scalefloat, optional
The amplitude of the wiggle perpendicular to the source line, in pixels. If scale is None, or not provided, no sketch filter will be provided.
lengthfloat, optional
The length of th... | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_sketch_params |
set_snap(snap)[source]
Set the snapping behavior. Snapping aligns positions with the pixel grid, which results in clearer images. For example, if a black line of 1px width was defined at a position in between two pixels, the resulting image would contain the interpolated value of that line in the pixel grid, which wo... | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_snap |
set_transform(t)[source]
Set the artist transform. Parameters
tTransform | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_transform |
set_url(url)[source]
Set the url for the artist. Parameters
urlstr | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_url |
set_urls(urls)[source]
Parameters
urlslist of str or None
Notes URLs are currently only implemented by the SVG backend. They are ignored by all other backends. | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_urls |
set_visible(b)[source]
Set the artist's visibility. Parameters
bbool | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_visible |
set_zorder(level)[source]
Set the zorder for the artist. Artists with lower zorder values are drawn first. Parameters
levelfloat | matplotlib.collections_api#matplotlib.collections.QuadMesh.set_zorder |
to_rgba(x, alpha=None, bytes=False, norm=True)[source]
Return a normalized rgba array corresponding to x. In the normal case, x is a 1D or 2D sequence of scalars, and the corresponding ndarray of rgba values will be returned, based on the norm and colormap set for this ScalarMappable. There is one special case, for h... | matplotlib.collections_api#matplotlib.collections.QuadMesh.to_rgba |
update(props)[source]
Update this artist's properties from the dict props. Parameters
propsdict | matplotlib.collections_api#matplotlib.collections.QuadMesh.update |
update_from(other)[source]
Copy properties from other to self. | matplotlib.collections_api#matplotlib.collections.QuadMesh.update_from |
update_scalarmappable()[source]
Update colors from the scalar mappable array, if any. Assign colors to edges and faces based on the array and/or colors that were directly set, as appropriate. | matplotlib.collections_api#matplotlib.collections.QuadMesh.update_scalarmappable |
zorder=0 | matplotlib.collections_api#matplotlib.collections.QuadMesh.zorder |
classmatplotlib.collections.RegularPolyCollection(numsides, rotation=0, sizes=(1,), **kwargs)[source]
Bases: matplotlib.collections._CollectionWithSizes A collection of n-sided regular polygons. Parameters
numsidesint
The number of sides of the polygon.
rotationfloat
The rotation of the polygon in radians. ... | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection |
add_callback(func)[source]
Add a callback function that will be called whenever one of the Artist's properties changes. Parameters
funccallable
The callback function. It must have the signature: def func(artist: Artist) -> Any
where artist is the calling Artist. Return values may exist but are ignored. Retu... | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.add_callback |
autoscale()[source]
Autoscale the scalar limits on the norm instance using the current array | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.autoscale |
autoscale_None()[source]
Autoscale the scalar limits on the norm instance using the current array, changing only limits that are None | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.autoscale_None |
changed()[source]
Call this whenever the mappable is changed to notify all the callbackSM listeners to the 'changed' signal. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.changed |
colorbar
The last colorbar associated with this ScalarMappable. May be None. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.colorbar |
contains(mouseevent)[source]
Test whether the mouse event occurred in the collection. Returns bool, dict(ind=itemlist), where every item in itemlist contains the event. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.contains |
convert_xunits(x)[source]
Convert x using the unit type of the xaxis. If the artist is not in contained in an Axes or if the xaxis does not have units, x itself is returned. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.convert_xunits |
convert_yunits(y)[source]
Convert y using the unit type of the yaxis. If the artist is not in contained in an Axes or if the yaxis does not have units, y itself is returned. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.convert_yunits |
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.collections_api#matplotlib.collections.RegularPolyCollection.draw |
findobj(match=None, include_self=True)[source]
Find artist objects. Recursively find all Artist instances contained in the artist. Parameters
match
A filter criterion for the matches. This can be
None: Return all objects contained in artist. A function with signature def match(artist: Artist) -> bool. The resul... | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.findobj |
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... | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.format_cursor_data |
get_agg_filter()[source]
Return filter function to be used for agg filter. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_agg_filter |
get_alpha()[source]
Return the alpha value used for blending - not supported on all backends. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_alpha |
get_animated()[source]
Return whether the artist is animated. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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.RegularPolyCollection.get_array |
get_capstyle()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_capstyle |
get_children()[source]
Return a list of the child Artists of this Artist. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_children |
get_clim()[source]
Return the values (min, max) that are mapped to the colormap limits. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_clim |
get_clip_box()[source]
Return the clipbox. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_clip_box |
get_clip_on()[source]
Return whether the artist uses clipping. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_clip_on |
get_clip_path()[source]
Return the clip path. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_clip_path |
get_cmap()[source]
Return the Colormap instance. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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... | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_cursor_data |
get_dashes()[source]
Alias for get_linestyle. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_dashes |
get_datalim(transData)[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_datalim |
get_ec()[source]
Alias for get_edgecolor. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_ec |
get_edgecolor()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_edgecolor |
get_edgecolors()[source]
Alias for get_edgecolor. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_edgecolors |
get_facecolor()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_facecolor |
get_facecolors()[source]
Alias for get_facecolor. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_facecolors |
get_fc()[source]
Alias for get_facecolor. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_fc |
get_figure()[source]
Return the Figure instance the artist belongs to. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_figure |
get_fill()[source]
Return whether face is colored. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_fill |
get_gid()[source]
Return the group id. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_gid |
get_hatch()[source]
Return the current hatching pattern. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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.RegularPolyCollection.get_in_layout |
get_joinstyle()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_joinstyle |
get_label()[source]
Return the label used for this artist in the legend. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_label |
get_linestyle()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_linestyle |
get_linestyles()[source]
Alias for get_linestyle. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_linestyles |
get_linewidth()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_linewidth |
get_linewidths()[source]
Alias for get_linewidth. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_linewidths |
get_ls()[source]
Alias for get_linestyle. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_ls |
get_lw()[source]
Alias for get_linewidth. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_lw |
get_numsides()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_numsides |
get_offset_transform()[source]
Return the Transform instance used by this artist offset. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_offset_transform |
get_offsets()[source]
Return the offsets for the collection. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_offsets |
get_path_effects()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_path_effects |
get_paths()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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.RegularPolyCollection.get_picker |
get_pickradius()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_pickradius |
get_rasterized()[source]
Return whether the artist is to be rasterized. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_rasterized |
get_rotation()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_rotation |
get_sizes()[source]
Return the sizes ('areas') of the elements in the collection. Returns
array
The 'area' of each element. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_sizes |
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 shrunk... | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_sketch_params |
get_snap()[source]
Return the snap setting. See set_snap for details. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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.RegularPolyCollection.get_tightbbox |
get_transform()[source]
Return the Transform instance used by this artist. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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.RegularPolyCollection.get_transformed_clip_path_and_affine |
get_transforms()[source] | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_transforms |
get_url()[source]
Return the url. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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.RegularPolyCollection.get_urls |
get_visible()[source]
Return the visibility. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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... | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_window_extent |
get_zorder()[source]
Return the artist's zorder. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.get_zorder |
have_units()[source]
Return whether units are set on any axis. | matplotlib.collections_api#matplotlib.collections.RegularPolyCollection.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.RegularPolyCollection.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.RegularPolyCollection.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.RegularPolyCollection.pick |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.