Skip to content

Chartpacks

Categorical list of functions

Creating new chartpacks

Function Description
Chartpack Create a new chartpack

Getting information about chartpacks

Function Description
get_description Get the description attached an Iris Pie object
set_description Set the description for an Iris Pie object

Plotting chartpacks

Function Description
plot Plot the chartpack

Adding figures and charts to chartpacks

Function Description
add_chart Add a new chart to an existing figure in the chartpack
add_figure Add a new figure to the chartpack

Directly accessible properties

Property Description
num_figures Total number of figures in the chartpack

☐ Chartpack

Create a new chartpack

self = Chartpack(
    title="",
    span=...,
    tiles=None,
    transforms=None,
    highlight=None,
    legend=None,
    reverse_plot_order=False,
)

Input arguments

title

The title of the chartpack, used as a basis for creating a caption shown at the top of each figure.

span

The date span on which the time series will be plotted.

tiles

The number of rows and columns of the figure grid. If input "None", the number of rows and columns will be determined automatically.

transforms

A dictionary of functions that will be applied to the input data before plotting.

highlight

A date span that will be highlighted in the charts.

legend

A list of strings that will be used as the legend for the charts.

reverse_plot_order

If True, the order of plotting the individual time series within each chart will be reversed.

Returns

self

A new empty Chartpack object.

☐ add_chart

Add a new chart to an existing figure in the chartpack

☐ add_figure

Add a new figure to the chartpack

☐ get_description

Get the description attached an Iris Pie object

description = self.get_description()

Input arguments

self

An Iris Pie object from which to get the description.

Returns

description

The description attached to the Iris Pie object.

☐ plot

Plot the chartpack

☐ set_description

Set the description for an Iris Pie object

self.set_description(
    description,
)

Input arguments

self

An Iris Pie object to which to attach the description.

description

The description to attach to the Iris Pie object.

Returns

This method modifies the Iris Pie object in place and returns None.