Build a layout of Axes based on ASCII art or nested lists.
This is a helper function to build complex GridSpec layouts visually.
See Complex and semantic figure composition (subplot_mosaic) for an example and full API documentation
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
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.
If True, the x-axis (sharex) or y-axis (sharey) will be shared among all subplots. In that case, tick label visibility and axis units behave as for subplots
. If False, each subplot's x- or y-axis will be independent.
Defines the relative widths of the columns. Each column gets a relative width of width_ratios[i] / sum(width_ratios)
. If not given, all columns will have the same width. Convenience for gridspec_kw={'width_ratios': [...]}
.
Defines the relative heights of the rows. Each row gets a relative height of height_ratios[i] / sum(height_ratios)
. If not given, all rows will have the same height. Convenience for gridspec_kw={'height_ratios': [...]}
.
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.
Dictionary with keywords passed to the Figure.add_subplot
call used to create each subplot. These values may be overridden by values in per_subplot_kw.
A dictionary mapping the Axes identifiers or tuples of identifiers to a dictionary of keyword arguments to be passed to the Figure.add_subplot
call used to create each subplot. The values in these dictionaries have precedence over the values in subplot_kw.
If mosaic is a string, and thus all keys are single characters, it is possible to use a single string instead of a tuple as keys; i.e. "AB"
is equivalent to ("A", "B")
.
Added in version 3.7.
Dictionary with keywords passed to the GridSpec
constructor used to create the grid the subplots are placed on.
All additional keyword arguments are passed to the pyplot.figure
call.
Figure
The new figure
A dictionary mapping the labels to the Axes objects. The order of the Axes is left-to-right and top-to-bottom of their position in the total layout.
matplotlib.pyplot.subplot_mosaic
#
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4