API reference#

FixedLayoutEngine([margin_pads_pts, ...])

Custom matplotlib LayoutEngine.

add_abc([fig, xoffset_pts, yoffset_pts, ...])

Add labels to all suplots in fig.

add_colorbar(mappable[, ax, location, ...])

Add a colorbar to ax.

align_axes_vertically(ax, reference_ax[, ...])

Set horizontal position of ax relative to reference_ax.

align_axes_horizontally(ax, reference_ax[, ...])

Set horizontal position of ax relative to reference_ax.

centers_to_edges(centers[, lower, upper])

Work out bin edges from bin centers.

convert_to_steps(x, y[, start_at, ...])

Convert (x,y) data to steps.

crop_colormap(cmap[, x, y, new_cmap_name, ...])

Return a colormap within (x,y) range

dotted([linewidth, fontsize, ...])

Return a tuple to create a dotted line that fits perfectly into a legend.

dash_dotted([ratio, n_dashes, linewidth, ...])

Return a tuple to create a dash-dotted line that fits perfectly into a legend.

dashed([ratio, n_dashes, linewidth, ...])

Return a tuple to create a dashed line that fits perfectly into a legend.

for_pcolormesh(xcenters, ycenters, z, *[, ...])

Convert xcenters, ycenters, z such that they can be plotted by matplotlib.pyplot.pcolormesh().

get_axes_margins([ax, unit])

Get the size of the margins of ax in physical units.

savefig([fname, ftype, fig])

Save a matplotlib.figure.Figure to a file.

set_axes_size(width[, height, aspect, ax, ...])

Set physical size of ax.

set_colorbar_pad(colorbar, pad[, unit])

Adjust padding between a colorbar and its parent axes.

set_colorbar_thickness(colorbar, thickness)

Adjust thickness of a colorbar.

set_color_cycle(*colors[, nsteps, fig])

Set the color cycle in plots.

set_latex_backend(font)

Enable a latex backend for rendering figures.

square_polar_axes([ax, zorder])

Format a polar axes to have a squared outline.

textwithbox(axes, x, y, text[, pad, ...])

Plot text with matplotlib surrounded by a box using LaTeX commands.

Colors([red, teal, blue, pink, orange, ...])

Various colors.

OkabeItoPalette([blue, orange, green, ...])

Okabe and Ito color palette.

OkabeItoAccentPalette([blue, red, green])

Accented Okabe and Ito color palette.

OkabeItoMutedPalette([sandstone, mist, ...])

Muted Okabe and Ito color palette.

AliasError(keyword_arg, alias)

InvalidFigureError(message)