foxes.utils.TabWindroseAxes - foxes 0.7 documentation

foxes 0.7 documentation

foxes.utils.TabWindroseAxes

class foxes.utils.TabWindroseAxes(windrose.windrose.WindroseAxes)[source]

A derivate of the wind rose axes that runs on stochastic data (bins with weights) instead of time series data

Public members¶

static from_ax(ax=None, fig=None, figsize=None, rect=None, *, ...)[source]: Return a WindroseAxes object for the figure fig.

legend(loc='upper right', *args, **kwargs)[source]: Sets the legend location and her properties.

set(*, adjustable=<UNSET>, agg_filter=<UNSET>, alpha=<UNSET>, ...): Set multiple properties at once.

name = 'windrose'

TabWindroseAxes(*args, **kwargs): See Axes base class for args and kwargs documentation

clear(): Clear the current axes

set_radii_angle(**kwargs): Set the radii labels angle

set_legend(**pyplot_arguments)

contour(direction, var, **kwargs): Plot a windrose in linear mode. For each var bins, a line will be draw on the axes, a segment between each sector (center to center). Each line can be formatted (color, width, …) like with standard plot pylab command.

contourf(direction, var, **kwargs): Plot a windrose in filled mode. For each var bins, a line will be draw on the axes, a segment between each sector (center to center). Each line can be formatted (color, width, …) like with standard plot pylab command.

bar(direction, var, **kwargs): Plot a windrose in bar mode. For each var bins and for each sector, a colored bar will be draw on the axes.

box(direction, var, **kwargs): Plot a windrose in proportional box mode. For each var bins and for each sector, a colored box will be draw on the axes.

get_xaxis_transform(which='grid'): Get the transformation used for drawing x-axis labels, ticks and gridlines. The x-direction is in data coordinates and the y-direction is in axis coordinates.

get_xaxis_text1_transform(pad)

Returns¶

transformTransform: The transform used for drawing x-axis labels, which will add pad_points of padding (in points) between the axis and the label. The x-direction is in data coordinates and the y-direction is in axis coordinates
valign{‘center’, ‘top’, ‘bottom’, ‘baseline’, ‘center_baseline’}: The text vertical alignment.
halign{‘center’, ‘left’, ‘right’}: The text horizontal alignment.

get_xaxis_text2_transform(pad)

Returns¶

transformTransform: The transform used for drawing secondary x-axis labels, which will add pad_points of padding (in points) between the axis and the label. The x-direction is in data coordinates and the y-direction is in axis coordinates
valign{‘center’, ‘top’, ‘bottom’, ‘baseline’, ‘center_baseline’}: The text vertical alignment.
halign{‘center’, ‘left’, ‘right’}: The text horizontal alignment.

get_yaxis_transform(which='grid'): Get the transformation used for drawing y-axis labels, ticks and gridlines. The x-direction is in axis coordinates and the y-direction is in data coordinates.

get_yaxis_text1_transform(pad)

Returns¶

transformTransform: The transform used for drawing y-axis labels, which will add pad_points of padding (in points) between the axis and the label. The x-direction is in axis coordinates and the y-direction is in data coordinates
valign{‘center’, ‘top’, ‘bottom’, ‘baseline’, ‘center_baseline’}: The text vertical alignment.
halign{‘center’, ‘left’, ‘right’}: The text horizontal alignment.

get_yaxis_text2_transform(pad)

Returns¶

transformTransform: The transform used for drawing secondart y-axis labels, which will add pad_points of padding (in points) between the axis and the label. The x-direction is in axis coordinates and the y-direction is in data coordinates
valign{‘center’, ‘top’, ‘bottom’, ‘baseline’, ‘center_baseline’}: The text vertical alignment.
halign{‘center’, ‘left’, ‘right’}: The text horizontal alignment.

draw(renderer): Draw the Artist (and its children) using the given renderer.

set_thetamax(thetamax): Set the maximum theta limit in degrees.

get_thetamax(): Return the maximum theta limit in degrees.

set_thetamin(thetamin): Set the minimum theta limit in degrees.

get_thetamin(): Get the minimum theta limit in degrees.

set_thetalim(*args, **kwargs): Set the minimum and maximum theta values.

set_theta_offset(offset): Set the offset for the location of 0 in radians.

get_theta_offset(): Get the offset for the location of 0 in radians.

set_theta_zero_location(loc, offset=0.0): Set the location of theta’s zero.

set_theta_direction(direction): Set the direction in which theta increases.

get_theta_direction(): Get the direction in which theta increases.

set_rmax(rmax): Set the outer radial limit.

Returns¶

float: Outer radial limit.

set_rmin(rmin): Set the inner radial limit.

Returns¶

float: The inner radial limit.

set_rorigin(rorigin): Update the radial origin.

get_rorigin(): Returns¶

float

get_rsign()

set_rlim(bottom=None, top=None, *, emit=True, auto=False, **kwargs): Set the radial axis view limits.

get_rlabel_position()

Returns¶

float: The theta position of the radius labels in degrees.

set_rlabel_position(value): Update the theta position of the radius labels.

set_yscale(*args, **kwargs): Set the yaxis’ scale.

set_rscale(*args, **kwargs)

set_rticks(*args, **kwargs)

set_thetagrids(angles, labels=None, fmt=None, **kwargs): Set the theta gridlines in a polar plot.

set_rgrids(radii, labels=None, angle=None, fmt=None, **kwargs): Set the radial gridlines on a polar plot.

format_coord(theta, r): Return a format string formatting the x, y coordinates.

get_data_ratio(): Return the aspect ratio of the data itself. For a polar plot, this should always be 1.0

can_zoom(): Return whether this Axes supports the zoom box button functionality.

can_pan(): Return whether this Axes supports the pan/zoom button functionality.

start_pan(x, y, button): Called when a pan operation has started.

end_pan(): Called when a pan operation completes (when the mouse button is up.)

drag_pan(button, key, x, y): Called when the mouse moves during a pan operation.

get_title(loc='center'): Get an Axes title.

set_title(label, fontdict=None, loc=None, pad=None, *, y=None, **): Set a title for the Axes.

get_legend_handles_labels(legend_handler_map=None): Return handles and labels for legend

inset_axes(bounds, *, transform=None, zorder=5, **kwargs): Add a child inset Axes to this existing Axes.

indicate_inset(bounds, inset_ax=None, *, transform=None, ...): Add an inset indicator to the Axes. This is a rectangle on the plot at the position indicated by bounds that optionally has lines that connect the rectangle to an inset Axes (.Axes.inset_axes).

indicate_inset_zoom(inset_ax, **kwargs): Add an inset indicator rectangle to the Axes based on the axis limits for an inset_ax and draw connectors between inset_ax and the rectangle.

secondary_xaxis(location, *, functions=None, **kwargs): Add a second x-axis to this ~.axes.Axes.

secondary_yaxis(location, *, functions=None, **kwargs): Add a second y-axis to this ~.axes.Axes.

text(x, y, s, fontdict=None, **kwargs): Add text to the Axes.

annotate(text, xy, xytext=None, xycoords='data', ...): Annotate the point xy with text text.

axhline(y=0, xmin=0, xmax=1, **kwargs): Add a horizontal line across the Axes.

axvline(x=0, ymin=0, ymax=1, **kwargs): Add a vertical line across the Axes.

axline(xy1, xy2=None, *, slope=None, **kwargs): Add an infinitely long straight line.

axhspan(ymin, ymax, xmin=0, xmax=1, **kwargs): Add a horizontal span (rectangle) across the Axes.

axvspan(xmin, xmax, ymin=0, ymax=1, **kwargs): Add a vertical span (rectangle) across the Axes.

hlines(y, xmin, xmax, colors=None, linestyles='solid', ...): Plot horizontal lines at each y from xmin to xmax.

vlines(x, ymin, ymax, colors=None, linestyles='solid', ...): Plot vertical lines at each x from ymin to ymax.

eventplot(positions, orientation='horizontal', lineoffsets=1, ...): Plot identical parallel lines at the given positions.

plot(*args, scalex=True, scaley=True, data=None, **kwargs): Plot y versus x as lines and/or markers.

plot_date(x, y, fmt='o', tz=None, xdate=True, ydate=False, *, ...): [Discouraged] Plot coercing the axis to treat floats as dates.

loglog(*args, **kwargs): Make a plot with log scaling on both the x- and y-axis.

semilogx(*args, **kwargs): Make a plot with log scaling on the x-axis.

semilogy(*args, **kwargs): Make a plot with log scaling on the y-axis.

acorr(x, *, data=None, **kwargs): Plot the autocorrelation of x.

xcorr(x, y, normed=True, detrend=<function detrend_none>, ...): Plot the cross correlation between x and y.

step(x, y, *args, where='pre', data=None, **kwargs): Make a step plot.

barh(y, width, height=0.8, left=None, *, align='center', ...): Make a horizontal bar plot.

bar_label(container, labels=None, *, fmt='%g', ...): Label a bar plot.

broken_barh(xranges, yrange, *, data=None, **kwargs): Plot a horizontal sequence of rectangles.

stem(*args, linefmt=None, markerfmt=None, basefmt=None, ...): Create a stem plot.

pie(x, explode=None, labels=None, colors=None, autopct=None, ...): Plot a pie chart.

errorbar(x, y, yerr=None, xerr=None, fmt='', ecolor=None, ...): Plot y versus x as lines and/or markers with attached errorbars.

boxplot(x, notch=None, sym=None, vert=None, whis=None, ...): Draw a box and whisker plot.

bxp(bxpstats, positions=None, widths=None, vert=True, ...): Drawing function for box and whisker plots.

scatter(x, y, s=None, c=None, marker=None, cmap=None, ...): A scatter plot of y vs. x with varying marker size and/or color.

hexbin(x, y, C=None, gridsize=100, bins=None, xscale='linear', ...): Make a 2D hexagonal binning plot of points x, y.

arrow(x, y, dx, dy, **kwargs): Add an arrow to the Axes.

quiverkey(Q, X, Y, U, label, **kwargs): Add a key to a quiver plot.

quiver(*args, data=None, **kwargs): Plot a 2D field of arrows.

barbs(*args, data=None, **kwargs): Plot a 2D field of barbs.

fill(*args, data=None, **kwargs): Plot filled polygons.

fill_between(x, y1, y2=0, where=None, interpolate=False, ...): Fill the area between two horizontal curves.

fill_betweenx(y, x1, x2=0, where=None, step=None, ...): Fill the area between two vertical curves.

imshow(X, cmap=None, norm=None, *, aspect=None, ...): Display data as an image, i.e., on a 2D regular raster.

pcolor(*args, shading=None, alpha=None, norm=None, cmap=None, ...): Create a pseudocolor plot with a non-regular rectangular grid.

pcolormesh(*args, alpha=None, norm=None, cmap=None, vmin=None, ...): Create a pseudocolor plot with a non-regular rectangular grid.

pcolorfast(*args, alpha=None, norm=None, cmap=None, vmin=None, ...): Create a pseudocolor plot with a non-regular rectangular grid.

clabel(CS, levels=None, **kwargs): Label a contour plot.

hist(x, bins=None, range=None, density=False, weights=None, ...): Compute and plot a histogram.

stairs(values, edges=None, *, orientation='vertical', ...): A stepwise constant function as a line with bounding edges or a filled plot.

hist2d(x, y, bins=10, range=None, density=False, weights=None, ...): Make a 2D histogram plot.

ecdf(x, weights=None, *, complementary=False, ...): Compute and plot the empirical cumulative distribution function of x.

psd(x, NFFT=None, Fs=None, Fc=None, detrend=None, window=None, ...): Plot the power spectral density.

csd(x, y, NFFT=None, Fs=None, Fc=None, detrend=None, ...): Plot the cross-spectral density.

magnitude_spectrum(x, Fs=None, Fc=None, window=None, ...): Plot the magnitude spectrum.

angle_spectrum(x, Fs=None, Fc=None, window=None, pad_to=None, ...): Plot the angle spectrum.

phase_spectrum(x, Fs=None, Fc=None, window=None, pad_to=None, ...): Plot the phase spectrum.

cohere(x, y, NFFT=256, Fs=2, Fc=0, ...): Plot the coherence between x and y.

specgram(x, NFFT=None, Fs=None, Fc=None, detrend=None, ...): Plot a spectrogram.

spy(Z, precision=0, marker=None, markersize=None, ...): Plot the sparsity pattern of a 2D array.

matshow(Z, **kwargs): Plot the values of a 2D matrix or array as color-coded image.

violinplot(dataset, positions=None, vert=True, widths=0.5, ...): Make a violin plot.

violin(vpstats, positions=None, vert=True, widths=0.5, ...): Drawing function for violin plots.

table(cellText=None, cellColours=None, cellLoc='right', ...): Add a table to an ~.axes.Axes.

stackplot(x, *args, labels=(), colors=None, baseline='zero', ...): Draw a stacked area plot.

streamplot(x, y, u, v, density=1, linewidth=None, color=None, ...): Draw streamlines of a vector flow.

tricontour(*args, **kwargs): Draw contour lines on an unstructured triangular grid.

tricontourf(*args, **kwargs): Draw contour regions on an unstructured triangular grid.

tripcolor(*args, alpha=1.0, norm=None, cmap=None, vmin=None, ...): Create a pseudocolor plot of an unstructured triangular grid.

triplot(*args, **kwargs): Draw an unstructured triangular grid as lines and/or markers.

__str__(): Return str(self).

classmethod __init_subclass__(**kwargs): This method is called when a class is subclassed.

__repr__(): Return repr(self).

get_subplotspec(): Return the .SubplotSpec associated with the subplot, or None.

set_subplotspec(subplotspec): Set the .SubplotSpec. associated with the subplot.

get_gridspec(): Return the .GridSpec associated with the subplot, or None.

get_window_extent(renderer=None): Return the Axes bounding box in display space.

set_figure(fig): Set the .Figure instance the artist belongs to.

property viewLim

get_position(original=False): Return the position of the Axes within the figure as a .Bbox.

set_position(pos, which='both'): Set the Axes position.

reset_position(): Reset the active position to the original position.

set_axes_locator(locator): Set the Axes locator.

get_axes_locator(): Return the axes_locator.

sharex(other): Share the x-axis with other.

sharey(other): Share the y-axis with other.

cla(): Clear the Axes.

property artists

property collections

property images

property lines

property patches

property tables

property texts

get_facecolor(): Get the facecolor of the Axes.

set_facecolor(color): Set the facecolor of the Axes.

set_prop_cycle(*args, **kwargs): Set the property cycle of the Axes.

get_aspect(): Return the aspect ratio of the axes scaling.

set_aspect(aspect, adjustable=None, anchor=None, share=False): Set the aspect ratio of the axes scaling, i.e. y/x-scale.

get_adjustable(): Return whether the Axes will adjust its physical dimension (‘box’) or its data limits (‘datalim’) to achieve the desired aspect ratio.

set_adjustable(adjustable, share=False): Set how the Axes adjusts to achieve the required aspect ratio.

get_box_aspect(): Return the Axes box aspect, i.e. the ratio of height to width.

set_box_aspect(aspect=None): Set the Axes box aspect, i.e. the ratio of height to width.

get_anchor(): Get the anchor location.

set_anchor(anchor, share=False): Define the anchor location.

apply_aspect(position=None): Adjust the Axes for a specified data aspect ratio.

axis(arg=None, /, *, emit=True, **kwargs): Convenience method to get or set some axis properties.

get_legend(): Return the .Legend instance, or None if no legend is defined.

get_images(): Return a list of .AxesImages contained by the Axes.

get_lines(): Return a list of lines contained by the Axes.

get_xaxis(): [Discouraged] Return the XAxis instance.

get_yaxis(): [Discouraged] Return the YAxis instance.

get_xgridlines(): Return the xaxis’ grid lines as a list of .Line2Ds.

get_xticklines(minor=False): Return the xaxis’ tick lines as a list of .Line2Ds.

get_ygridlines(): Return the yaxis’ grid lines as a list of .Line2Ds.

get_yticklines(minor=False): Return the yaxis’ tick lines as a list of .Line2Ds.

has_data(): Return whether any artists have been added to the Axes.

add_artist(a): Add an .Artist to the Axes; return the artist.

add_child_axes(ax): Add an .AxesBase to the Axes’ children; return the child Axes.

add_collection(collection, autolim=True): Add a .Collection to the Axes; return the collection.

add_image(image): Add an .AxesImage to the Axes; return the image.

add_line(line): Add a .Line2D to the Axes; return the line.

add_patch(p): Add a .Patch to the Axes; return the patch.

add_table(tab): Add a .Table to the Axes; return the table.

add_container(container): Add a .Container to the Axes’ containers; return the container.

relim(visible_only=False): Recompute the data limits based on current artists.

update_datalim(xys, updatex=True, updatey=True): Extend the ~.Axes.dataLim Bbox to include the given points.

in_axes(mouseevent): Return whether the given event (in display coords) is in the Axes.

get_autoscalex_on(): Return whether the xaxis is autoscaled.

get_autoscaley_on(): Return whether the yaxis is autoscaled.

set_autoscalex_on(b): Set whether the xaxis is autoscaled when drawing or by .Axes.autoscale_view.

set_autoscaley_on(b): Set whether the yaxis is autoscaled when drawing or by .Axes.autoscale_view.

get_autoscale_on(): Return True if each axis is autoscaled, False otherwise.

set_autoscale_on(b): Set whether autoscaling is applied to each axis on the next draw or call to .Axes.autoscale_view.

property use_sticky_edges: When autoscaling, whether to obey all Artist.sticky_edges.

set_xmargin(m): Set padding of X data limits prior to autoscaling.

set_ymargin(m): Set padding of Y data limits prior to autoscaling.

margins(*margins, x=None, y=None, tight=True): Set or retrieve autoscaling margins.

set_rasterization_zorder(z): Set the zorder threshold for rasterization for vector graphics output.

get_rasterization_zorder(): Return the zorder value below which artists will be rasterized.

autoscale(enable=True, axis='both', tight=None): Autoscale the axis view to the data (toggle).

autoscale_view(tight=None, scalex=True, scaley=True): Autoscale the view limits using the data limits.

draw_artist(a): Efficiently redraw a single artist.

redraw_in_frame(): Efficiently redraw Axes data, but not axis ticks, labels, etc.

get_frame_on(): Get whether the Axes rectangle patch is drawn.

set_frame_on(b): Set whether the Axes rectangle patch is drawn.

get_axisbelow(): Get whether axis ticks and gridlines are above or below most artists.

set_axisbelow(b): Set whether axis ticks and gridlines are above or below most artists.

grid(visible=None, which='major', axis='both', **kwargs): Configure the grid lines.

ticklabel_format(*, axis='both', style='', scilimits=None, ...): Configure the .ScalarFormatter used by default for linear Axes.

locator_params(axis='both', tight=None, **kwargs): Control behavior of major tick locators.

tick_params(axis='both', **kwargs): Change the appearance of ticks, tick labels, and gridlines.

set_axis_off(): Hide all visual components of the x- and y-axis.

set_axis_on(): Do not hide all visual components of the x- and y-axis.

get_xlabel(): Get the xlabel text string.

set_xlabel(xlabel, fontdict=None, labelpad=None, *, loc=None, **): Set the label for the x-axis.

invert_xaxis(): Invert the x-axis.

xaxis_inverted(): Return whether the xaxis is oriented in the “inverse” direction.

get_xbound(): Return the lower and upper x-axis bounds, in increasing order.

set_xbound(lower=None, upper=None): Set the lower and upper numerical bounds of the x-axis.

get_xlim(): Return the x-axis view limits.

set_xlim(left=None, right=None, *, emit=True, auto=False, ...): Set the x-axis view limits.

get_xscale(): Return the xaxis’ scale (as a str).

set_xscale(value, **kwargs): Set the xaxis’ scale.

get_xticks(*, minor=False): Return the xaxis’ tick locations in data coordinates.

set_xticks(ticks, labels=None, *, minor=False, **kwargs): Set the xaxis’ tick locations and optionally tick labels.

get_xmajorticklabels(): Return the xaxis’ major tick labels, as a list of ~.text.Text.

get_xminorticklabels(): Return the xaxis’ minor tick labels, as a list of ~.text.Text.

get_xticklabels(minor=False, which=None): Get the xaxis’ tick labels.

set_xticklabels(labels, *, minor=False, fontdict=None, **kwargs): [Discouraged] Set the xaxis’ tick labels with list of string labels.

get_ylabel(): Get the ylabel text string.

set_ylabel(ylabel, fontdict=None, labelpad=None, *, loc=None, **): Set the label for the y-axis.

invert_yaxis(): Invert the y-axis.

yaxis_inverted(): Return whether the yaxis is oriented in the “inverse” direction.

get_ybound(): Return the lower and upper y-axis bounds, in increasing order.

set_ybound(lower=None, upper=None): Set the lower and upper numerical bounds of the y-axis.

get_ylim(): Return the y-axis view limits.

set_ylim(bottom=None, top=None, *, emit=True, auto=False, ...): Set the y-axis view limits.

get_yscale(): Return the yaxis’ scale (as a str).

get_yticks(*, minor=False): Return the yaxis’ tick locations in data coordinates.

set_yticks(ticks, labels=None, *, minor=False, **kwargs): Set the yaxis’ tick locations and optionally tick labels.

get_ymajorticklabels(): Return the yaxis’ major tick labels, as a list of ~.text.Text.

get_yminorticklabels(): Return the yaxis’ minor tick labels, as a list of ~.text.Text.

get_yticklabels(minor=False, which=None): Get the yaxis’ tick labels.

set_yticklabels(labels, *, minor=False, fontdict=None, **kwargs): [Discouraged] Set the yaxis’ tick labels with list of string labels.

xaxis_date(tz=None): Set up axis ticks and labels to treat data along the xaxis as dates.

yaxis_date(tz=None): Set up axis ticks and labels to treat data along the yaxis as dates.

format_xdata(x): Return x formatted as an x-value.

format_ydata(y): Return y formatted as a y-value.

minorticks_on(): Display minor ticks on the Axes.

minorticks_off(): Remove minor ticks from the Axes.

get_navigate(): Get whether the Axes responds to navigation commands.

set_navigate(b): Set whether the Axes responds to navigation toolbar commands.

get_navigate_mode(): Get the navigation toolbar button status: ‘PAN’, ‘ZOOM’, or None.

set_navigate_mode(b): Set the navigation toolbar button status.

get_children(): Return a list of the child .Artists of this .Artist.

contains(mouseevent): Test whether the artist contains the mouse event.

contains_point(point): Return whether point (pair of pixel coordinates) is inside the Axes patch.

get_default_bbox_extra_artists(): Return a default list of artists that are used for the bounding box calculation.

get_tightbbox(renderer=None, *, call_axes_locator=True, ...): Return the tight bounding box of the Axes, including axis and their decorators (xlabel, title, etc).

twinx(): Create a twin Axes sharing the xaxis.

twiny(): Create a twin Axes sharing the yaxis.

get_shared_x_axes(): Return an immutable view on the shared x-axes Grouper.

get_shared_y_axes(): Return an immutable view on the shared y-axes Grouper.

label_outer(remove_inner_ticks=False): Only show “outer” labels and tick labels.

get_fc(): Alias for get_facecolor.

set_fc(color): Alias for set_facecolor.

zorder = 0

remove(): Remove the artist from the figure if possible.

have_units(): Return whether units are set on any axis.

convert_xunits(x): Convert x using the unit type of the xaxis.

convert_yunits(y): Convert y using the unit type of the yaxis.

property axes: The ~.axes.Axes instance the artist resides in, or None.

property stale: Whether the artist is ‘stale’ and needs to be re-drawn for the output to match the internal state of the artist.

add_callback(func): Add a callback function that will be called whenever one of the .Artist’s properties changes.

remove_callback(oid): Remove a callback based on its observer id.

pchanged(): Call all of the registered callbacks.

is_transform_set(): Return whether the Artist has an explicitly set transform.

set_transform(t): Set the artist transform.

get_transform(): Return the .Transform instance used by this artist.

pickable(): Return whether the artist is pickable.

pick(mouseevent): Process a pick event.

set_picker(picker): Define the picking behavior of the artist.

get_picker(): Return the picking behavior of the artist.

get_url(): Return the url.

set_url(url): Set the url for the artist.

get_gid(): Return the group id.

set_gid(gid): Set the (group) id for the artist.

get_snap(): Return the snap setting.

set_snap(snap): Set the snapping behavior.

get_sketch_params(): Return the sketch parameters for the artist.

set_sketch_params(scale=None, length=None, randomness=None): Set the sketch parameters.

set_path_effects(path_effects): Set the path effects.

get_path_effects()

get_figure(): Return the .Figure instance the artist belongs to.

set_clip_box(clipbox): Set the artist’s clip .Bbox.

set_clip_path(path, transform=None): Set the artist’s clip path.

get_alpha(): Return the alpha value used for blending - not supported on all backends.

get_visible(): Return the visibility.

get_animated(): Return whether the artist is animated.

get_in_layout(): Return boolean flag, True if artist is included in layout calculations.

get_clip_on(): Return whether the artist uses clipping.

get_clip_box(): Return the clipbox.

get_clip_path(): Return the clip path.

get_transformed_clip_path_and_affine(): Return the clip path with the non-affine part of its transformation applied, and the remaining affine part of its transformation.

set_clip_on(b): Set whether the artist uses clipping.

get_rasterized(): Return whether the artist is to be rasterized.

set_rasterized(rasterized): Force rasterized (bitmap) drawing for vector graphics output.

get_agg_filter(): Return filter function to be used for agg filter.

set_agg_filter(filter_func): Set the agg filter.

set_alpha(alpha): Set the alpha value used for blending - not supported on all backends.

set_visible(b): Set the artist’s visibility.

set_animated(b): Set whether the artist is intended to be used in an animation.

set_in_layout(in_layout): Set if artist is to be included in layout calculations, E.g. constrainedlayout_guide, .Figure.tight_layout(), and fig.savefig(fname, bbox_inches='tight').

get_label(): Return the label used for this artist in the legend.

set_label(s): Set a label that will be displayed in the legend.

get_zorder(): Return the artist’s zorder.

set_zorder(level): Set the zorder for the artist. Artists with lower zorder values are drawn first.

property sticky_edges: x and y sticky edge lists for autoscaling.

update_from(other): Copy properties from other to self.

properties(): Return a dictionary of all the properties of the artist.

update(props): Update this artist’s properties from the dict props.

findobj(match=None, include_self=True): Find artist objects.

get_cursor_data(event): Return the cursor data for a given event.

format_cursor_data(data): Return a string representation of data.

get_mouseover(): Return whether this artist is queried for custom context information when the mouse cursor moves over it.

set_mouseover(mouseover): Set whether this artist is queried for custom context information when the mouse cursor moves over it.

property mouseover: Return whether this artist is queried for custom context information when the mouse cursor moves over it.

Classes¶

class PolarTransform(matplotlib.transforms.Transform): The base polar transform.

class PolarAffine(matplotlib.transforms.Affine2DBase): The affine part of the polar projection.

class InvertedPolarTransform(matplotlib.transforms.Transform): The inverse of the polar transform, mapping Cartesian coordinate space x and y back to theta and r.

class ThetaFormatter(matplotlib.ticker.Formatter): Used to format the theta tick labels. Converts the native unit of radians into degrees and adds a degree symbol.

class RadialLocator(matplotlib.ticker.Locator): Used to locate radius ticks.

class ThetaLocator(matplotlib.ticker.Locator): Used to locate theta ticks.

class ArtistList(collections.abc.Sequence): A sublist of Axes children based on their type.