matplotlib.pyplot.subplot_mosaic

matplotlib.pyplot.subplot_mosaic(layout, *, subplot_kw=None, gridspec_kw=None, empty_sentinel='.', **fig_kw) [source]

Build a layout of Axes based on ASCII art or nested lists.

This is a helper function to build complex GridSpec layouts visually.

Note

This API is provisional and may be revised in the future based on early user feedback.

Parameters:

layoutlist of list of {hashable or nested} or str A visual layout of how you want your Axes to be arranged labeled as strings. For example x = [['A panel', 'A panel', 'edge'], ['C panel', '.', 'edge']] Produces 4 axes: 'A panel' which is 1 row high and spans the first two columns 'edge' which is 2 rows high and is on the right edge 'C panel' which in 1 row and 1 column wide in the bottom left a blank space 1 row and 1 column wide in the bottom center Any of the entries in the layout can be a list of lists of the same form to create nested layouts. If input is a str, then it must be of the form ''' AAE C.E ''' where each character is a column and each line is a row. This only allows only single character Axes labels and does not allow nesting but is very terse. subplot_kwdict, optional Dictionary with keywords passed to the Figure.add_subplot call used to create each subplot. gridspec_kwdict, optional Dictionary with keywords passed to the GridSpec constructor used to create the grid the subplots are placed on. empty_sentinelobject, optional Entry in the layout to mean "leave this space empty". Defaults to '.'. Note, if layout is a string, it is processed via inspect.cleandoc to remove leading white space, which may interfere with using white-space as the empty sentinel. **fig_kw All additional keyword arguments are passed to the pyplot.figure call.

Returns:

figFigure The new figure dict[label, Axes] A dictionary mapping the labels to the Axes objects.

Examples using matplotlib.pyplot.subplot_mosaic