API reference
Top-level functions
The starting point for creating custom ProPlot figures.
| Call |
| Call |
| Create a figure with a single subplot or arbitrary grids of subplots, analogous to |
| List subclass and pseudo-2d array used as a container for the axes returned by |
Figure class
The figure class used for all ProPlot figures.
|
Axes classes
The axes classes used for all ProPlot figures.
| Lowest-level axes subclass. |
| Axes subclass for plotting in ordinary Cartesian coordinates. |
| Axes subclass for plotting in polar coordinates. |
| Axes subclass for plotting on cartographic projections. |
| Axes subclass for plotting cartopy projections. |
| Axes subclass for plotting |
Constructor functions
The constructor functions used to build class instances from simple shorthand arguments.
| Generate, retrieve, modify, and/or merge instances of |
| Pass all arguments to |
| Generate and merge |
| Return an arbitrary |
| Return a |
| Return a |
| Return a |
| Return a |
Configuration tools
Tools for setting up ProPlot and configuring global settings. See the configuration guide for details.
Instance of | |
| Magical abstract class for managing matplotlib’s builtin settings and ProPlot’s added settings.When ProPlot is imported, this class is instantiated as the |
| Register colormaps packaged with ProPlot or saved to the |
| Register color cycles packaged with ProPlot or saved to the |
| Register the open-color colors, XKCD color survey colors, and colors saved to the |
Add fonts packaged with ProPlot or saved to the | |
| Set up the ipython inline backend format and ensure that inline figures always look the same as saved figures. |
| Apply the matplotlib style(s) with |
Plotting wrappers
The plotting wrappers that add functionality to various Axes
methods. “Wrapped” Axes
methods accept the additional keyword arguments documented by the wrapper function. In a future version, these features will be documented on the individual Axes
methods themselves.
| Supports grouping and stacking successive columns of data, and changes the default bar style. |
| Supports grouping and stacking successive columns of data, and changes the default bar style. |
| Adds convenient keyword arguments and changes the default boxplot style. |
| Adds several new keyword args and features for specifying the colormap, levels, and normalizers. |
| Adds useful features for controlling colorbars. |
| Adds features for controlling colors in the property cycler and drawing legends or colorbars in one go. |
| Makes |
| Makes |
| Supports overlaying and stacking successive columns of data, and permits using different colors for “negative” and “positive” regions. |
| Supports overlaying and stacking successive columns of data, and permits using different colors for “negative” and “positive” regions. |
| Plot horizontal lines with flexible positional arguments and optionally use different colors for “negative” and “positive” lines. |
| Adds support for drawing error bars and error shading on-the-fly. |
| Adds useful features for controlling legends, including “centered-row” legends. |
| Adds keyword arguments to |
| Interpret positional arguments for the “1D” plotting methods so usage is consistent. |
| Interpret positional arguments for the “2D” plotting methods so usage is consistent. |
| Enables specifying |
| Adds convenient keyword arguments and changes the default violinplot style to match this matplotlib example. |
| Plot vertical lines with flexible positional arguments and optionally use different colors for “negative” and “positive” lines. |
Demo functions
Functions for enumerating and contrasting the available colors and fonts.
| Generate a table of the registered colormaps or the input colormaps categorized by source. |
| Show how arbitrary colormap(s) vary with respect to the hue, chroma, luminance, HSL saturation, and HPL saturation channels, and optionally the red, blue and green channels. |
| Generate tables of the registered color names. |
| Generate hue-saturation, hue-luminance, and luminance-saturation cross-sections for the HCL, HSL, and HPL colorspaces. |
| Generate a table of registered color cycles or the input color cycles categorized by source. |
| Generate a table of fonts. |
Colormaps and normalizers
New colormap classes and colormap normalization classes.
| Similar to |
| New base class for all |
| New base class for all |
| Similar to |
| Meta-normalizer that discretizes the possible color values returned by arbitrary continuous normalizers given a list of level boundaries. |
| Normalizer that ensures some central data value lies at the central colormap color. |
| Normalizer that scales data linearly with respect to average position in an arbitrary monotonically increasing level lists. |
| Dictionary subclass used to replace the builtin matplotlib color database. |
| Dictionary subclass used to replace the |
Locators and formatters
Various Locator
and Formatter
classes.
| The new default formatter. |
| Format numbers as fractions or multiples of some arbitrary value. |
| A locator for determining longitude gridlines. |
| A locator for determining latitude gridlines. |
| Format numbers with scientific notation. |
| Rounds numbers to the specified number of significant digits. |
| Replicate various features from |
Axis scale classes
Various axis ScaleBase
classes.
| Axis scale composed of arbitrary piecewise linear transformations. |
| “Exponential scale” that performs either of two transformations. |
| An axis scale comprised of arbitrary forward and inverse transformations. |
Axis scale that is linear in the inverse of x. | |
| As with |
| As with |
| As with |
| Axis scale that transforms coordinates as with latitude in the Mercator projection. |
| “Power scale” that performs the transformation |
Axis scale that is linear in the sine of x. | |
| As with |
Cartopy projections
New cartopy projection classes.
| The Aitoff projection. |
| The Hammer projection. |
| The Kavrayskiy VII projection. |
Analogous to | |
| Analogous to |
Analogous to | |
Analogous to | |
| Analogous to |
Analogous to | |
| The Winkel tripel (Winkel III) projection. |
Gridspec classes
The new gridspec classes.
| Matplotlib |
| Matplotlib |
Miscellaneous tools
Various tools that may be useful while making plots.
| Identical to |
| Calculate the approximate “edge” values along an axis given “center” values. |
| Calculate the approximate “edge” values given a 2d grid of “center” values. |
| Convert values and lists of values between arbitrary physical units. |
| Return a color with the opacity channel set to the specified value. |
| Return a color with a different hue and the same luminance and saturation as the input color. |
| Return a color with a different luminance and the same hue and saturation as the input color. |
| Return a color with a different saturation and the same hue and luminance as the input color. |
| Scale the luminance channel of a color. |
| Scale the saturation channel of a color. |
| Translate the color in any format and from any colorspace to an RGB tuple. |
| Translate color in any format to a tuple of channel values in any colorspace. |
| Translate the color in any format and from any colorspace to an RGB tuple. |
| Translate color in any format to a tuple of channel values in any colorspace. |