API reference

API

Plotting routines

cfplot.con	The interface to contouring in cf-plot.
cfplot.lineplot
cfplot.stipple
cfplot.stream	Plot a streamplot to show fluid flow and 2D field gradients.
cfplot.traj
cfplot.vect

Graphics related

cfplot.gopen	Open a contour-runtime graphics session compatible with cfplot.gopen.
cfplot.gclose	Close a contour-runtime graphics session and save/view output.
cfplot.gpos	Select a subplot position, matching the legacy cfplot.gpos API.

Parameter related

cfplot.cscale	Choose and manipulate colour maps in shared plotting state.
cfplot.gset	Set plot limits for non-longitude-latitude plots.
cfplot.levs	Set or clear the contour levels stored in shared plotting state.
cfplot.mapset	Set map plotting parameters in shared state.
cfplot.plotvars	Stores plotting variables in cfp.plotvars.
cfplot.reset
cfplot.setvars	Set shared plotting variables from defaults plus explicit overrides.

Mapping related

Colour related

cfplot.cbar

The cf-plot interface to Matplotlib colorbar for contour rendering.

Calculations

Utility Routines

cfplot.rgaxes

Validation

Deprecated/Obsolete APIs

Deprecations

These functions are not intended for user use and will be removed in the next version. In most cases these have no use in the codebase as of v3.3.0.

Note the functions compare_arrays and regression_tests (version 3.3.0 and earlier) related to testing only so have been moved out of the functional codebase.

Obsolete Internal API

These routines were exposed in the user-facing API at versions 3.3.0 and below but were marked as not being intended for user use. They have therefore been removed except for under-the-hood processing at version 3.5.0. They are listed here for completeness and posterity.

If you made use of any of the functionality provided by these internal-use routines, and wish to have this in future, please get in touch to let us know and we may be able to support them again.

• _bfill

• _bfill_ugrid

• _cf_data_assign

• _check_data

• _cscale_get_map

• _dim_titles

• _gvals

• _map_title

• _mapaxis

• _plot_map_axes

• _process_color_scales

• _set_map

• _supscr

• _timeaxis