API reference¶
The comprehensive API reference. All of the below objects are imported
into the top-level namespace. Use help(pplt.object)
to read
the docs during a python session.
Please note that the documentation of plotting command “wrappers” from
ProPlot < 0.8 is now found in the individual PlotAxes
plotting commands. Using help(ax.command)
during a python session shows both
the ProPlot documentation and the original matplotlib documentation.
Figure class¶
The figure class used for all ProPlot figures.
|
The |
|
List-like object used to store subplots returned by |
Gridspec class¶
The gridspec and subplotspec subclasses.
|
A |
Axes classes¶
The axes classes used for all ProPlot figures.
|
The lowest-level |
|
The second lowest-level |
|
Axes subclass for plotting in ordinary Cartesian coordinates. |
|
Axes subclass for plotting in polar coordinates. |
|
Axes subclass for plotting in geographic projections. |
|
Simple mix-in of |
Top-level functions¶
The starting point for creating ProPlot figures.
|
Create an empty figure. |
|
Create a figure with a single subplot or an arbitrary grid of subplots. |
|
Call |
|
Call |
|
|
|
Call |
|
Call |
Configuration tools¶
Tools for setting up ProPlot and configuring global settings. See the configuration guide for details.
|
A dictionary-like class for managing matplotlib settings stored in |
Instance of |
|
A dictionary-like container of ProPlot settings. |
|
A dictionary-like container of matplotlib settings. |
|
|
Apply the matplotlib style(s) with |
|
Set up the ipython inline backend display format and ensure that inline figures always look the same as saved figures. |
|
Register named colormaps. |
|
Register named color cycles. |
|
Register named colors. |
|
Register font names. |
Constructor functions¶
The constructor functions used to build class instances from simple shorthand arguments.
|
Return a |
|
Return a |
|
Return a |
|
Return a |
|
Generate, retrieve, modify, and/or merge instances of |
|
Return an arbitrary |
|
Generate and merge |
Locators and formatters¶
Various Locator
and Formatter
classes.
|
The new default number formatter. |
|
Format numbers as fractions or multiples of some value. |
|
A locator for longitude gridlines. |
|
A locator for latitude gridlines. |
|
Format numbers with scientific notation. |
|
Format numbers by retaining the specified number of significant digits. |
|
A general purpose number formatter. |
Axis scale classes¶
Various axis ScaleBase
classes.
|
Axis scale composed of arbitrary piecewise linear transformations. |
|
"Exponential scale" that performs either of two transformations. |
|
Axis scale composed 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 is linear in the Mercator projection latitude. |
|
"Power scale" that performs the transformation |
Axis scale that is linear in the sine transformation of x. |
|
|
As with |
Colormaps and normalizers¶
New colormap classes and colormap normalization classes.
|
Replacement for |
|
Replacement for |
|
A |
|
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 the interpolated list index in an arbitrary monotonically increasing level list. |
|
Dictionary subclass used to replace the builtin matplotlib color database. |
|
Dictionary subclass used to replace the matplotlib colormap registry. |
Projection classes¶
Additional cartopy projection classes.
|
The Aitoff projection. |
|
The Hammer projection. |
|
The Kavrayskiy VII projection. |
|
The Winkel tripel (Winkel III) projection. |
Analogous to |
|
Analogous to |
|
|
Analogous to |
|
Analogous to |
Analogous to |
|
Analogous to |
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. |
|
Get the colors associated with a registered or on-the-fly color cycle. |
|
Return a color with a different hue and the same luminance and saturation as the input color. |
|
Return a color with a different saturation and the same hue and luminance 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 the opacity channel set to the specified value. |
|
Shift the hue channel of a color. |
|
Scale the saturation channel of a color. |
|
Scale the luminance channel of a color. |
|
Translate the color in any format and from any colorspace to a HEX string. |
|
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. |
|
Convert values and lists of values between arbitrary physical units. |
Demo functions¶
Functions for displaying 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. |