API Reference¶

This section contains the API reference for earthkit-plots. Each class and function is documented on its own page; the tables below link through to them.

Core Components¶

`Figure`	The overall canvas onto which subplots are drawn.
`Subplot`	A single plot within a Figure.

High-level API¶

The shortcut API is exposed through three namespace objects on the top-level earthkit.plots package. Each groups the shortcut methods for one chart type; the method tables on the pages below link through to the underlying quickplot functions.

Namespace	Description
ekp.geo	Geographic / map plots.
ekp.timeseries	Time series plots.
ekp.climatology	Climatology (annual-cycle) plots.

Quickplot¶

quickplot(*args, **kwargs)

Alias for plot().

Styles¶

Style

A style for plotting data.

`load_style`(name, **kwargs)	Load a named style by its user-facing name.
`list_styles`()	Return a sorted list of all available named style names.

Metadata¶

`earthkit.plots.metadata.formatters`
`earthkit.plots.metadata.labels`