API Reference

Purpose

NestedGridPlotter is based on matplotlib and intends to simplify the plotting of nestedgrid by providing a objected oriented class.

The following functionalities are directly provided on module-level.

Classes

SubfigsBuilder(*[, nrows, ncols, squeeze, ...])	Args and kwargs for Figure.subfigures routine.
SubplotsMosaicBuilder(mosaic, *[, sharex, ...])	Args and kwargs for Figure.subfigures routine.
Plotter([fig, builder])	General class to wrap matplotlib plots.
NestedGridPlotter([fig, builder])	Alias for Plotter for backward compatibility.
AnimatedPlotter([fig, builder])	Nestedgrid plotter with embedded animation support.

Utility Functions

add_grid_and_tick_prams_to_axis(ax[, which, ...])	Add a grid and configure the thick for a given axis.
ticklabels_to_datetime(ax, initial_datetime, ...)	Convert float ticklabels to datetime.
add_twin_axis_as_datetime(ax, ...[, format, ...])	Add dates to an already existing axis.
add_xaxis_twin_as_date(ax, first_date[, ...])	Add dates to an already existing axis.
align_x_axes(axes[, is_ticks_major])	Align the ticks of multiple x axes.
align_y_axes(axes[, is_ticks_major])	Align the ticks of multiple y axes.
align_x_axes_on_values(axes[, align_values, ...])	Align the ticks of multiple x axes.
align_y_axes_on_values(axes[, align_values, ...])	Align the ticks of multiple y axes.
extract_frames_from_embedded_html_animation(fpath)	Extract the embedded frames from an html animation created with matplotlib.
get_line_style(line_style_label)	Get a parametrized linestyle from a line style label.
hide_axis_spine(ax, loc)	Hide one or all spines of the given axis.
hide_axis_ticklabels(ax[, which])	Hide x, y or both x and y ticklabels of the given axis.
make_patch_spines_invisible(ax)	Make patch and spines of the ax invisible.
make_ticks_overlapping_axis_frame_invisible(ax)	Make the ticks overlapping the frame of the axis invisible.
make_x_axes_symmetric_zero_centered(axes[, ...])	Make x-axis symmetric in zero for all provided axes
make_y_axes_symmetric_zero_centered(axes[, ...])	Make y-axis symmetric in zero for all provided axes.
replace_bad_path_characters(filename[, repchar])	Make filename compatible with path by replacement.
add_letter_to_frames(axes[, zorder])	Add a letter at the top left hand corner of the frame of the given axes.

Plot functions

multi_imshow(axes, fig, data[, xlabel, ...])

Plot multiple 2D field with imshow using a shared and scaled colorbar.

Plot configuration

apply_nice_default_rc_params()

Apply nice rc parameters for matplotlib.