faceted.faceted_ax¶

faceted.faceted_ax(cbar_mode=None, **kwargs)¶

A convenience version of faceted for creating single-axis figures.

Exactly two of width, height, and aspect must be defined. The third is inferred based on the other two values.

Parameters

widthfloat: Width of figure
heightfloat: Height of figure
aspectfloat: Aspect ratio of plots in each tile
top_padfloat: Spacing (in inches) between top of figure and axes
bottom_padfloat: Spacing (in inches) between bottom of figure and axes
left_padfloat: Spacing (in inches) between left of figure and axes
right_padfloat: Spacing (in inches) between right of figure and axes
internal_padfloat or tuple: Spacing in between panels in both the horizontal and vertical directions (in inches); if an individual number, the spacing is the same in the horizontal and vertical; if a tuple is specified, the left value is the horizontal pad, and the right value is the vertical pad.
cbar_mode{None, ‘single’, ‘edge’, ‘each’}: Mode for adding colorbar(s) to figure
cbar_short_side_padfloat: Spacing between the ends of the colorbar and the edges of the axes (in inches); controls the length of the colorbar
cbar_padfloat: Spacing between plot axes and the colorbar axes (in inches)
cbar_sizefloat: Width of the colorbar in inches
cbar_location{‘top’, ‘bottom’, ‘left’, ‘right’}: Side of the plot axes (or figure) for the colorbar
sharexbool or {‘all’, ‘col’, ‘row’, ‘none’}: Share x-axis limits, ticks, and tick labels
shareybool or {‘all’, ‘col’, ‘row’, ‘none’}: Share y-axis limits, ticks, and tick labels
axes_kwargsdict: Keyword arguments to pass to Axes constructor

Returns