matplotlib.figure.SubFigure.subplot_mosaic
- SubFigure.subplot_mosaic(mosaic, *, sharex=False, sharey=False, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, per_subplot_kw=None, gridspec_kw=None)[source]
-
Построение макета осей на основе ASCII-искусства или вложенных списков.
Это вспомогательная функция для построения сложных макетов GridSpec визуально.
См. Сложная и семантическая компоновка фигуры (subplot_mosaic) для примера и полной документации API.
- Параметры:
-
- mosaicсписок списков {хешируемых или вложенных} или строка
-
Визуальная компоновка того, как вы хотите расположить свои оси, помеченные строками. Например
x = [['A panel', 'A panel', 'edge'], ['C panel', '.', 'edge']]генерирует 4 оси:
- 'A panel', который имеет высоту 1 строка и занимает первые два столбца
- 'edge', который имеет высоту 2 строки и находится на правом краю
- 'C panel', который имеет ширину 1 строка и 1 столбец в левом нижнем углу
- пустое место шириной 1 строка и 1 столбец в центре снизу
Любой из элементов в макете может быть списком списков той же формы для создания вложенных макетов.
Если вход представляет собой строку, то она может быть либо многострочной строкой в формате
''' AAE C.E '''
где каждый символ — столбец, а каждая строка — строка. Или это может быть строка с одной строкой, где строки разделены
;:'AB;CC'
Нотация строк допускает только метки осей из одного символа и не поддерживает вложенные структуры, но очень лаконична.
Идентификаторы осей могут быть
strили хешируемым объектом, не являющимся итерируемым (например,tupleкортежи не могут быть использованы). - sharex, shareybool, по умолчанию: False
-
Если True, ось x (sharex) или ось y (sharey) будут совмещены среди всех подграфиков. В этом случае видимость меток делений и единиц оси ведут себя так же, как для
subplots. Если False, ось x или y каждого подграфика будет независимой. - width_ratiosмассив-подобный длиной ncols, необязательно
-
Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину
width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину. Эквивалентноgridspec_kw={'width_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету. - height_ratiosмассив-подобный длиной nrows, необязательно
-
Определяет относительные высоты строк. Каждая строка получает относительную высоту
height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту. Эквивалентноgridspec_kw={'height_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету. - subplot_kwdict, необязательно
-
Словарь с ключевыми словами, передаваемыми в вызов
Figure.add_subplotдля создания каждого подграфика. Эти значения могут быть переопределены значениями в per_subplot_kw. - per_subplot_kwdict, необязательно
-
Словарь, сопоставляющий идентификаторы осей или кортежи идентификаторов со словарем ключевых аргументов, которые будут переданы в вызов
Figure.add_subplotдля создания каждого подграфика. Значения в этих словарях имеют приоритет над значениями в subplot_kw.Если mosaic — строка, а значит, все ключи — одиночные символы, можно использовать одну строку вместо кортежа в качестве ключей; т.е.
"AB"эквивалентно("A", "B").Добавлена в версии 3.7.
- gridspec_kwdict, необязательно
-
Словарь с ключевыми словами, передаваемыми в конструктор
GridSpec, используемый для создания сетки, на которой размещаются подграфики. В случае вложенных макетов этот аргумент применяется только к внешнему макету. Для более сложных макетов пользователи должны использоватьFigure.subfiguresдля создания вложенности. - empty_sentinelобъект, необязательно
-
Элемент в макете, означающий «оставьте это место пустым». По умолчанию
'.'. Обратите внимание, что если layout — строка, она обрабатывается черезinspect.cleandoc, чтобы удалить начальные пробелы, что может помешать использованию пробелов в качестве пустого маркера.
- Возвращает:
-
- dict[метка, ось]
-
Словарь, сопоставляющий метки с объектами осей. Порядок осей слева направо и сверху вниз соответствует их положению в общем макете.
Примеры использования matplotlib.figure.SubFigure.subplot_mosaic
Сложная и семантическая компоновка фигуры (subplot_mosaic)
© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/stable/api/_as_gen/matplotlib.figure.SubFigure.subplot_mosaic.html