рисунок

matplotlib.figure

Модуль figure предоставляет главный элемент Artist, объект Figure, который содержит все элементы графика. Определены следующие классы:

SubplotParams: управляет стандартными отступами подграфиков
Figure: главный контейнер для всех элементов графика

class matplotlib.figure.AxesStack

Базовый класс: matplotlib.cbook.Stack

Специализация стека для обработки всех подграфиков (Axes) в рисунке (Figure). Этот стек хранит пары key, (ind, axes), где:

ключ должен быть хэшем аргументов и ключевых слов, используемых для создания подграфика.
индекс — порядковый номер для отслеживания порядка добавления подграфиков.

AxesStack — вызываемый объект, где ax_stack() возвращает текущий подграфик. В качестве альтернативы можно использовать current_key_axes() для получения текущего ключа и связанного подграфика.

add(key, a)

Добавляет подграфик a с ключом key в стек и возвращает стек.

Если a уже находится в стеке, он не добавляется повторно, а возвращается None.

as_list(): Возвращает список экземпляров подграфиков (Axes), добавленных в рисунок.

bubble(a): Перемещает указанный подграфик, который должен уже существовать в стеке, наверх.

current_key_axes()

Возвращает кортеж (key, axes) для активного подграфика.

Если в стеке нет подграфиков, возвращает (None, None).

get(key): Возвращает экземпляр подграфика (Axes), добавленный с ключом key. Если подграфик не найден, возвращает None.

remove(a): Удаляет подграфик из стека.

class matplotlib.figure.Figure(figsize=None, dpi=None, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None)

Базовый класс: matplotlib.artist.Artist

Объект Figure поддерживает обратные вызовы через атрибут callbacks, который является экземпляром matplotlib.cbook.CallbackRegistry. События, к которым можно подключиться, — это ‘dpi_changed’, и обратный вызов будет вызван с func(fig), где fig — экземпляр Figure.

patch: Объект фигуры рисуется с помощью экземпляра matplotlib.patches.Rectangle
suppressComposite: Для нескольких изображений фигуры, фигура создаст составные изображения в зависимости от функции рендеринга option_image_nocomposite. Если suppressComposite — True/False, это переопределит рендеринг.
figsize: Ширина и высота в дюймах
dpi: Точек на дюйм
facecolor: Цвет заливки объекта фигуры; по умолчанию rc figure.facecolor
edgecolor: Цвет границы объекта фигуры; по умолчанию rc figure.edgecolor
linewidth: Ширина линии границы объекта фигуры; стандартная ширина линии рамки
frameon: Если False, подавляет рисование рамки фигуры
subplotpars: Объект SubplotParams, по умолчанию rc
tight_layout: Если False использовать subplotpars; если True настраивать параметры подграфиков с помощью tight_layout() со значениями отступов по умолчанию. При передаче словаря со значениями pad, w_pad, h_pad и rect, значения отступов по умолчанию tight_layout() будут переопределены. По умолчанию rc figure.autolayout.

add_axes(*args, **kwargs)

Добавить область построения графиков в положение rect [left, bottom, width, height], где все значения являются долями ширины и высоты фигуры. Аргументы kwargs допускают Axes kwargs, а также projection, которое задаёт тип проекции области построения. (Для обратной совместимости, polar=True также может быть предоставлен, что эквивалентно projection='polar'). Допустимые значения для projection: [‘aitoff’, ‘hammer’, ‘lambert’, ‘mollweide’, ‘polar’, ‘rectilinear’]. Некоторые из этих проекций поддерживают дополнительные kwargs, которые могут быть предоставлены add_axes(). Типичное использование:

rect = l,b,w,h
fig.add_axes(rect)
fig.add_axes(rect, frameon=False, axisbg='g')
fig.add_axes(rect, polar=True)
fig.add_axes(rect, projection='polar')
fig.add_axes(ax)

Если в фигуре уже есть область построения с теми же параметрами, то она просто станет текущей и будет возвращена. Если этого поведения не требуется, например, необходимо принудительно создать новую область построения, необходимо использовать уникальный набор аргументов и kwargs. Для этой цели был доступен атрибут области построения label. Например, если вы хотите добавить две области построения, которые в остальном идентичны, в фигуру, убедитесь, что вы дали им уникальные метки:

fig.add_axes(rect, label='axes1')
fig.add_axes(rect, label='axes2')

В редких случаях add_axes может быть вызван с единственным аргументом — экземпляром Axes, уже созданным в текущей фигуре, но не в списке областей построения фигуры. Например, если область построения была удалена с помощью delaxes(), она может быть восстановлена следующим образом:

fig.add_axes(ax)

Во всех случаях будет возвращён экземпляр Axes.

В дополнение к projection поддерживаются следующие kwargs:

Свойство	Описание
`adjustable`	[ ‘box’ \| ‘datalim’ \| ‘box-forced’]
`agg_filter`	неизвестно
`alpha`	вещественное число (от 0,0 — прозрачный до 1,0 — непрозрачный)
`anchor`	неизвестно
`animated`	[True \| False]
`aspect`	неизвестно
`autoscale_on`	неизвестно
`autoscalex_on`	неизвестно
`autoscaley_on`	неизвестно
`axes`	экземпляр `Axes`
`axes_locator`	неизвестно
`axis_bgcolor`	любой цвет matplotlib — см. `colors()`
`axisbelow`	[ True \| False ]
`clip_box`	экземпляр `matplotlib.transforms.Bbox`
`clip_on`	[True \| False]
`clip_path`	[ (`Path`, `Transform`) \| `Patch` \| None ]
`color_cycle`	неизвестно
`contains`	вызываемая функция
`figure`	неизвестно
`frame_on`	[ True \| False ]
`gid`	строка идентификатора
`label`	строка или что-либо, что можно напечатать с помощью преобразования ‘%s’
`navigate`	[ True \| False ]
`navigate_mode`	неизвестно
`path_effects`	неизвестно
`picker`	[None\|вещественное число\|логическое значение\|вызываемая функция]
`position`	неизвестно
`rasterization_zorder`	неизвестно
`rasterized`	[True \| False \| None]
`sketch_params`	неизвестно
`snap`	неизвестно
`title`	неизвестно
`transform`	экземпляр `Transform`
`url`	строка URL
`visible`	[True \| False]
`xbound`	неизвестно
`xlabel`	неизвестно
`xlim`	последовательность из 2 чисел с плавающей точкой
`xmargin`	неизвестно
`xscale`	[‘linear’ \| ‘log’ \| ‘logit’ \| ‘symlog’]
`xticklabels`	последовательность строк
`xticks`	последовательность чисел с плавающей точкой
`ybound`	неизвестно
`ylabel`	неизвестно
`ylim`	последовательность из 2 чисел с плавающей точкой
`ymargin`	неизвестно
`yscale`	[‘linear’ \| ‘log’ \| ‘logit’ \| ‘symlog’]
`yticklabels`	последовательность строк
`yticks`	последовательность чисел с плавающей точкой
`zorder`	любое число

add_axobserver(func): при изменении состояния области построения, будет вызван func(self)

add_subplot(*args, **kwargs)

Добавление подграфика. Примеры:

fig.add_subplot(111)

# equivalent but more general
fig.add_subplot(1,1,1)

# add subplot with red background
fig.add_subplot(212, axisbg='r')

# add a polar subplot
fig.add_subplot(111, projection='polar')

# add Subplot instance sub
fig.add_subplot(sub)

kwargs — допустимые Axes kwargs плюс projection, который выбирает тип проекции для оси. (Для обратной совместимости также можно указать polar=True, что эквивалентно projection=’polar’). Допустимые значения для projection: [‘aitoff’, ‘hammer’, ‘lambert’, ‘mollweide’, ‘polar’, ‘rectilinear’]. Некоторые из этих проекций поддерживают дополнительные kwargs, которые могут быть переданы add_axes().

Объект Axes будет возвращён.

Если в фигуре уже есть подграфик с ключом (args, kwargs), он будет просто сделан текущим и возвращён.

См. также

subplot() для объяснения аргументов.

Поддерживаются следующие kwargs:

Свойство	Описание
`adjustable`	[ ‘box’ \| ‘datalim’ \| ‘box-forced’]
`agg_filter`	неизвестно
`alpha`	вещественное число (от 0.0 — прозрачный до 1.0 — непрозрачный)
`anchor`	неизвестно
`animated`	[True \| False]
`aspect`	неизвестно
`autoscale_on`	неизвестно
`autoscalex_on`	неизвестно
`autoscaley_on`	неизвестно
`axes`	объект `Axes`
`axes_locator`	неизвестно
`axis_bgcolor`	любой цвет matplotlib — см. `colors()`
`axisbelow`	[ True \| False ]
`clip_box`	объект `matplotlib.transforms.Bbox`
`clip_on`	[True \| False]
`clip_path`	[ (`Path`, `Transform`) \| `Patch` \| None ]
`color_cycle`	неизвестно
`contains`	функция-обработчик
`figure`	неизвестно
`frame_on`	[ True \| False ]
`gid`	строка-идентификатор
`label`	строка или любой печатаемый объект с преобразованием ‘%s’
`navigate`	[ True \| False ]
`navigate_mode`	неизвестно
`path_effects`	неизвестно
`picker`	[None\|число\|логическое значение\|функция-обработчик]
`position`	неизвестно
`rasterization_zorder`	неизвестно
`rasterized`	[True \| False \| None]
`sketch_params`	неизвестно
`snap`	неизвестно
`title`	неизвестно
`transform`	объект `Transform`
`url`	строка URL
`visible`	[True \| False]
`xbound`	неизвестно
`xlabel`	неизвестно
`xlim`	последовательность из двух чисел с плавающей точкой
`xmargin`	неизвестно
`xscale`	[‘linear’ \| ‘log’ \| ‘logit’ \| ‘symlog’]
`xticklabels`	последовательность строк
`xticks`	последовательность чисел с плавающей точкой
`ybound`	неизвестно
`ylabel`	неизвестно
`ylim`	последовательность из двух чисел с плавающей точкой
`ymargin`	неизвестно
`yscale`	[‘linear’ \| ‘log’ \| ‘logit’ \| ‘symlog’]
`yticklabels`	последовательность строк
`yticks`	последовательность чисел с плавающей точкой
`zorder`	любое число

autofmt_xdate(bottom=0.2, rotation=30, ha='right')

Метки даты на оси x часто перекрываются, поэтому полезно их повернуть и выровнять по правому краю. Кроме того, распространённым случаем использования является несколько подграфиков с общей осью x, где данные на оси x — это даты. Метки осей x часто длинные, и это помогает повернуть их на нижнем подграфике и отключить их на других подграфиках, а также отключить метки оси x.

bottom: Нижняя граница подграфиков для subplots_adjust()
rotation: Угол поворота меток оси x
ha: Горизонтальное выравнивание меток оси x

axes: Только для чтения: список осей в фигуре

clear(): Очистить фигуру — синоним clf().

clf(keep_observers=False)

Очистить фигуру.

Установите keep_observers в True, если, например, виджет gui отслеживает оси в фигуре.

colorbar(mappable, cax=None, ax=None, use_gridspec=True, **kw)

Создать шкалу цветовых градиентов для объекта ScalarMappable, mappable.

Документация для тонкого обертки pylab:

Добавление шкалы цветовых градиентов к графику.

Подписи функций для интерфейса pyplot; все, кроме первой, также являются подписями методов для метода colorbar():

colorbar(**kwargs)
colorbar(mappable, **kwargs)
colorbar(mappable, cax=cax, **kwargs)
colorbar(mappable, ax=ax, **kwargs)

аргументы:

mappable: объект Image, ContourSet, и т. д., к которому применяется шкала цветовых градиентов; этот аргумент обязателен для метода colorbar(), но необязателен для функции colorbar(), которая устанавливает значение по умолчанию для текущего изображения.

ключевые аргументы:

cax: None | объект осей, в который будет нарисована шкала цветовых градиентов
ax: None | объект родительских осей, из которого будет взято место для новых осей шкалы цветовых градиентов. Если предоставлен список осей, все они будут изменены, чтобы освободить место для осей шкалы цветовых градиентов.
use_gridspec: False | Если cax равно None, новый cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec равно True, cax создается как экземпляр Subplot с использованием модуля grid_spec.

Дополнительные ключевые аргументы делятся на два типа:

свойства осей:

Свойство	Описание
orientation	вертикальный или горизонтальный
fraction	0.15; доля исходных осей, используемых для шкалы цветовых градиентов
pad	0.05 при вертикальной ориентации, 0.15 при горизонтальной; доля исходных осей между шкалой цветовых градиентов и новыми осями изображения
shrink	1.0; доля, на которую уменьшается шкала цветовых градиентов
aspect	20; отношение длинных к коротким сторонам
anchor	(0.0, 0.5) при вертикальной ориентации; (0.5, 1.0) при горизонтальной; точка привязки осей шкалы цветовых градиентов
panchor	(1.0, 0.5) при вертикальной ориентации; (0.5, 0.0) при горизонтальной; точка привязки родительских осей шкалы цветовых градиентов. Если False, точка привязки родительских осей не изменится

свойства шкалы цветовых градиентов:

Свойство	Описание
extend	[ ‘ничего’ \| ‘оба’ \| ‘мин’ \| ‘макс’ ] Если не ‘ничего’, добавляются заостренные концы для значений вне диапазона. Они устанавливаются для заданной цветовой карты с помощью методов set_under и set_over цветовой карты.
extendfrac	[ None \| ‘авто’ \| длина \| длины ] Если None, минимальное и максимальное треугольные расширения шкалы цветовых градиентов имеют длину 5% от длины внутренней шкалы цветовых градиентов (по умолчанию). Если ‘авто’, треугольные расширения шкалы цветовых градиентов имеют ту же длину, что и внутренние прямоугольники (когда spacing равен ‘uniform’), или ту же длину, что и соответствующие смежные внутренние прямоугольники (когда spacing равен ‘proportional’). Если скаляр, указывает длину минимального и максимального треугольных расширений шкалы цветовых градиентов как долю длины внутренней шкалы цветовых градиентов. Также может быть указана двухэлементная последовательность дробей, указывающая длину минимального и максимального расширений шкалы цветовых градиентов как долю длины внутренней шкалы цветовых градиентов.
extendrect	[ False \| True ] Если False, минимальное и максимальное расширения шкалы цветовых градиентов будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	[ ‘равномерное’ \| ‘пропорциональное’ ] Равномерное расстояние обеспечивает одинаковое пространство для каждого дискретного цвета; пропорциональное делает пространство пропорциональным интервалу данных.
ticks	[ None \| список меток \| объект Locator ] Если None, метки определяются автоматически из входных данных.
format	[ None \| строка формата \| объект Formatter ] Если None, используется `ScalarFormatter`. Если указана строка формата, например, ‘%.3f’, она используется. Вместо этого можно указать альтернативный объект `Formatter`.
drawedges	[ False \| True ] Если True, рисуются линии на границах цветов.

Следующее, вероятно, будет полезно только в контексте индексированных цветов (то есть, когда у mappable norm=NoNorm()) или других необычных ситуациях.

Свойство	Описание
boundaries	None или последовательность
values	None или последовательность, длина которой на 1 меньше, чем у boundaries. Для каждого региона, ограниченного смежными элементами в boundaries, будет использоваться цвет, сопоставленный с соответствующим значением в values.

Если mappable является ContourSet, его ключевой аргумент extend включается автоматически.

Обратите внимание, что ключевой аргумент shrink обеспечивает простой способ предотвращения слишком большой высоты вертикальной шкалы цветовых градиентов, например, по сравнению с осями объекта mappable, к которому прикреплена шкала; но это ручной метод, требующий некоторых проб и ошибок. Если шкала цветовых градиентов слишком большая (или горизонтальная шкала слишком широкая), используйте меньшее значение shrink.

Для более точного управления вы можете вручную указать расположения объектов осей, в которых отображаются объекты mappable и шкала цветовых градиентов. В этом случае не используйте ключевые аргументы свойств осей.

Известно, что некоторые программы просмотра векторной графики (svg и pdf) отображают белые промежутки между сегментами шкалы цветовых градиентов. Это связано с ошибками в просмотрщиках, а не в matplotlib. В качестве обходного решения шкалу цветовых градиентов можно отобразить с перекрывающимися сегментами:

cbar = colorbar()
cbar.solids.set_edgecolor("face")
draw()

Однако это имеет негативные последствия в других ситуациях. Особенно с полупрозрачными изображениями (alpha < 1) и расширениями шкалы цветовых градиентов, и по умолчанию не включено (см. вопрос #1188).

возвращает:: экземпляр Colorbar; также см. его базовый класс ColorbarBase. Вызовите метод set_label(), чтобы добавить подпись к шкале цветовых градиентов.

contains(mouseevent)

Проверка, произошел ли событие мыши на рисунке.

Возвращает True,{}

delaxes(a): удаление из рисунка и обновление текущей оси

dpi

draw(artist, renderer, *args, **kwargs): Отображение рисунка с использованием экземпляра matplotlib.backend_bases.RendererBase renderer.

draw_artist(a): отображение только экземпляра matplotlib.artist.Artist a – доступно только после отображения рисунка

figimage(X, xo=0, yo=0, alpha=None, norm=None, cmap=None, vmin=None, vmax=None, origin=None, resize=False, **kwargs)

Добавляет нересемплированное изображение в рисунок.

Подписи вызова:

figimage(X, **kwargs)

добавляет нересемплированную матрицу X в рисунок.

figimage(X, xo, yo)

со смещениями пикселей xo, yo,

X должна быть массивом с плавающей точкой:

Если X — MxN, предполагается яркость (серая шкала)
Если X — MxNx3, предполагается RGB
Если X — MxNx4, предполагается RGBA

Необязательные ключевые аргументы:

Ключевое слово	Описание
resize	логическое значение, True или False. Если “True”, то размер рисунка изменяется в соответствии с размером изображения.
xo или yo	Целое число, смещение изображения по x и y в пикселях
cmap	экземпляр `matplotlib.colors.Colormap`, например, cm.jet. Если None, используется значение по умолчанию из rc `image.cmap`
norm	экземпляр `matplotlib.colors.Normalize`. По умолчанию используется нормализация(). Это масштабирует яркость в диапазон 0-1
vmin\|vmax	используются для масштабирования изображения яркости в диапазон 0-1. Если значение None, используются минимальное и максимальное значения яркости. Обратите внимание, что если вы передаете экземпляр norm, настройки vmin и vmax будут проигнорированы.
alpha	значение прозрачности, по умолчанию None
origin	[‘верхний’ \| ‘нижний’] Указывает, где индекс [0,0] массива находится в верхнем левом или нижнем левом углу осей. По умолчанию используется значение rc image.origin

figimage дополняет изображение осей (imshow()), которое будет ресемплировано для соответствия текущим осям. Если вы хотите, чтобы ресемплированное изображение заполняло весь рисунок, вы можете определить Axes с размером [0,1,0,1].

Возвращается экземпляр matplotlib.image.FigureImage.

(Исходный код, png, hires.png, pdf)

Дополнительные ключевые слова — это ключевые слова Artist, передаваемые в FigureImage

gca(**kwargs)

Получить текущие оси, создав их при необходимости

Следующие ключевые слова поддерживаются для обеспечения того, что возвращаемые оси соответствуют заданной проекции и т. д., а также для создания осей, если активных осей нет:

Свойство	Описание
`adjustable`	[ ‘box’ \| ‘datalim’ \| ‘box-forced’]
`agg_filter`	неизвестно
`alpha`	число с плавающей точкой (от 0,0 — прозрачный до 1,0 — непрозрачный)
`anchor`	неизвестно
`animated`	[True \| False]
`aspect`	неизвестно
`autoscale_on`	неизвестно
`autoscalex_on`	неизвестно
`autoscaley_on`	неизвестно
`axes`	экземпляр `Axes`
`axes_locator`	неизвестно
`axis_bgcolor`	любой цвет matplotlib — см. `colors()`
`axisbelow`	[ True \| False ]
`clip_box`	экземпляр `matplotlib.transforms.Bbox`
`clip_on`	[True \| False]
`clip_path`	[ (`Path`, `Transform`) \| `Patch` \| None ]
`color_cycle`	неизвестно
`contains`	вызываемая функция
`figure`	неизвестно
`frame_on`	[ True \| False ]
`gid`	строка-идентификатор
`label`	строка или что-либо, что можно распечатать с помощью преобразования ‘%s’.
`navigate`	[ True \| False ]
`navigate_mode`	неизвестно
`path_effects`	неизвестно
`picker`	[None\|число с плавающей точкой\|булево значение\|вызываемая функция]
`position`	неизвестно
`rasterization_zorder`	неизвестно
`rasterized`	[True \| False \| None]
`sketch_params`	неизвестно
`snap`	неизвестно
`title`	неизвестно
`transform`	экземпляр `Transform`
`url`	строка url
`visible`	[True \| False]
`xbound`	неизвестно
`xlabel`	неизвестно
`xlim`	последовательность из 2 чисел с плавающей точкой
`xmargin`	неизвестно
`xscale`	[‘linear’ \| ‘log’ \| ‘logit’ \| ‘symlog’]
`xticklabels`	последовательность строк
`xticks`	последовательность чисел с плавающей точкой
`ybound`	неизвестно
`ylabel`	неизвестно
`ylim`	последовательность из 2 чисел с плавающей точкой
`ymargin`	неизвестно
`yscale`	[‘linear’ \| ‘log’ \| ‘logit’ \| ‘symlog’]
`yticklabels`	последовательность строк
`yticks`	последовательность чисел с плавающей точкой
`zorder`	любое число

get_axes()

get_children(): получить список артистов, содержащихся в фигуре

get_default_bbox_extra_artists()

get_dpi(): Возвращает dpi как число с плавающей точкой

get_edgecolor(): Получить цвет обводки прямоугольника Figure

get_facecolor(): Получить цвет заливки прямоугольника Figure

get_figheight(): Возвращает figheight как число с плавающей точкой

get_figwidth(): Возвращает figwidth как число с плавающей точкой

get_frameon(): получить булево значение, указывающее frameon

get_size_inches()

Возвращает текущий размер фигуры в дюймах (1 дюйм = 2,54 см) как массив numpy.

Возвращает:

Возвращает:	size : ndarray Размер фигуры в дюймах

size : ndarray

Размер фигуры в дюймах

См. также

matplotlib.Figure.set_size_inches

get_tight_layout(): Возвращает булево значение, True, если использовать :meth`tight_layout` при отрисовке.

get_tightbbox(renderer)

Возвращает (плотное) ограничивающее прямоугольник фигуры в дюймах.

Он учитывает только заголовки осей, подписи осей и метки делений осей. Требуется улучшение.

get_window_extent(*args, **kwargs): получить ограничивающую рамку фигуры в пространстве отображения; kwargs игнорируются

END_OF_DOCUMENT_MARKER

ginput(n=1, timeout=30, show_clicks=True, mouse_add=1, mouse_pop=3, mouse_stop=2)

Вызов сигнатуры:

ginput(self, n=1, timeout=30, show_clicks=True,
       mouse_add=1, mouse_pop=3, mouse_stop=2)

Блокирующий вызов для взаимодействия с фигурой.

Это будет ожидать n щелчков от пользователя и вернет список координат каждого щелчка.

Если timeout равен нулю или отрицательному значению, таймаут не применяется.

Если n равен нулю или отрицательному значению, накапливаются щелчки до тех пор, пока не произойдет щелчок средней кнопкой мыши (или, возможно, обе кнопки мыши одновременно), что завершает ввод.

Нажатие правой кнопкой мыши отменяет последний ввод.

Кнопки, используемые для различных действий (добавление точек, удаление точек, завершение ввода), могут быть переопределены с помощью аргументов mouse_add, mouse_pop и mouse_stop, которые задают соответствующую кнопку мыши: 1 для левой, 2 для средней, 3 для правой.

Клавиатура также может использоваться для выбора точек в случае, если ваша мышь не имеет одной или нескольких кнопок. Клавиши Delete и Backspace действуют как нажатие правой кнопки мыши (т. е. удаление последней точки), клавиша Enter завершает ввод, а любая другая клавиша (не используемая менеджером окон) выбирает точку.

hold(b=None)

Установить состояние удержания. Если hold равно None (по умолчанию), переключать состояние удержания. В противном случае установить состояние удержания на логическое значение b.

Например:

hold()      # toggle hold
hold(True)  # hold is on
hold(False) # hold is off

legend(handles, labels, *args, **kwargs)

Поместить легенду в фигуру. Метки — это последовательность строк, обработчики — последовательность экземпляров Line2D или Patch, а loc может быть строкой или целым числом, определяющим расположение легенды

Использование:

legend( (line1, line2, line3),
        ('label1', 'label2', 'label3'),
        'upper right')

Коды расположения loc:

'best' : 0,          (currently not supported for figure legends)
'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4,
'right'        : 5,
'center left'  : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center'       : 10,

loc также может быть кортежем (x, y) в координатах фигуры, который определяет нижний левый угол рамки легенды. Координаты фигуры (0,0) — это левая нижняя часть фигуры, а 1,1 — правая верхняя.

Ключевые аргументы:

prop: [ None | FontProperties | dict ]: Экземпляр matplotlib.font_manager.FontProperties. Если prop является словарем, будет создан новый экземпляр с prop. Если None, будут использоваться настройки rc.
numpoints: целое число: Количество точек в линии легенды, по умолчанию 4
scatterpoints: целое число: Количество точек в линии легенды, по умолчанию 4
scatteryoffsets: список чисел с плавающей точкой: список смещений y для символов разброса в легенде
markerscale: [ None | скаляр ]: Относительный размер маркеров легенды по отношению к исходному. Если None, будут использоваться настройки rc.
markerfirst: [ True | False ]: Если True, маркер легенды помещается слева от метки легенды. Если False, маркер легенды помещается справа от метки легенды.
fancybox: [ None | False | True ]: Если True, рисуется рамка с закругленными углами. Если None, используется rc.
shadow: [ None | False | True ]: Если True, за легендой рисуется тень. Если None, будут использоваться настройки rc.
ncol: Количество столбцов. По умолчанию 1
mode: Если mode равен “expand”, легенда будет горизонтально расширена, чтобы заполнить область осей (или bbox_to_anchor)
title: Заголовок легенды

Отступы и интервалы между различными элементами используют следующие ключевые параметры. Размеры этих значений даны как доля размера шрифта. Если None, будут использованы значения из rcParams.

Ключевое слово	Описание
borderpad	доля отступа внутри рамки легенды
labelspacing	вертикальное расстояние между записями легенды
handlelength	длина маркеров легенды
handletextpad	отступ между маркёром легенды и текстом
borderaxespad	отступ между осями и рамкой легенды
columnspacing	отступ между столбцами

Примечание

Не все типы объектов поддерживаются легендой. См. ССЫЛКУ (FIXME) для получения подробной информации.

Пример:

(Исходный код, png, hires.png, pdf)

savefig(*args, **kwargs)

Сохранить текущую фигуру.

Вызов сигнатуры:

savefig(fname, dpi=None, facecolor='w', edgecolor='w',
        orientation='portrait', papertype=None, format=None,
        transparent=False, bbox_inches=None, pad_inches=0.1,
        frameon=None)

Доступные форматы вывода зависят от используемого бэкэнда.

Аргументы:

fname:

Строка, содержащая путь к имени файла, или объект-подобный файлу Python, или, возможно, объект, зависящий от бэкэнда, например, PdfPages.

Если format равен None и fname является строкой, формат вывода определяется из расширения имени файла. Если у имени файла нет расширения, используется значение параметра rc savefig.format.

Если fname не является строкой, не забудьте указать format, чтобы убедиться, что используется правильный бэкэнд.

Ключевые аргументы:

dpi: [ None | scalar > 0 | ‘figure’]: Разрешение в точках на дюйм. Если None, оно по умолчанию будет равно значению savefig.dpi в файле matplotlibrc. Если ‘figure’, оно установит dpi, равный значению figure.
facecolor, edgecolor:: цвета прямоугольника фигуры
orientation: [ ‘landscape’ | ‘portrait’ ]: не поддерживается во всех бэкэндах; в настоящее время поддерживается только для вывода в формате postscript
papertype:: Одно из значений ‘letter’, ‘legal’, ‘executive’, ‘ledger’, ‘a0’ через ‘a10’, ‘b0’ через ‘b10’. Поддерживается только для вывода в формате postscript.
format:: Одно из расширений файлов, поддерживаемых активным бэкэндом. Большинство бэкэндов поддерживают png, pdf, ps, eps и svg.
transparent:: Если True, все области осей будут прозрачными; область фигуры также будет прозрачной, если не указаны facecolor и/или edgecolor с помощью ключевых слов. Это полезно, например, для отображения графика поверх цветного фона на веб-странице. Прозрачность этих областей будет восстановлена до их первоначальных значений после выхода из этой функции.
frameon:: Если True, область фигуры будет окрашенной, если False, фон фигуры будет прозрачным. Если не указано, будет использоваться значение rcParam ‘savefig.frameon’.
bbox_inches:: Область в дюймах. Сохраняется только указанная часть фигуры. Если ‘tight’, пытается определить область фигуры с минимальным отступом.
pad_inches:: Размер отступа вокруг фигуры, когда bbox_inches равен ‘tight’.
bbox_extra_artists:: Список дополнительных объектов, которые будут учтены при расчете области с минимальным отступом.

sca(a): Установить текущую ось на a и вернуть a

set_canvas(canvas)

Установить холст, содержащий фигуру

ПРИНИМАЕТ: экземпляр FigureCanvas

set_dpi(val)

Установить количество точек на дюйм фигуры

ПРИНИМАЕТ: число с плавающей точкой

set_edgecolor(color)

Установить цвет рамки прямоугольника фигуры

ПРИНИМАЕТ: любой цвет matplotlib — см. help(colors)

set_facecolor(color)

Установить цвет заливки прямоугольника фигуры

ПРИНИМАЕТ: любой цвет matplotlib — см. help(colors)

set_figheight(val, forward=False)

Установить высоту фигуры в дюймах

ПРИНИМАЕТ: число с плавающей точкой

set_figwidth(val, forward=False)

Установить ширину фигуры в дюймах

ПРИНИМАЕТ: число с плавающей точкой

set_frameon(b)

Установить, отображается ли рамка фигуры (фон) или она невидима

ПРИНИМАЕТ: булево значение

set_size_inches(w, h, forward=False)

Установить размер фигуры в дюймах (1 дюйм = 2,54 см)

Использование:

fig.set_size_inches(w,h)  # OR
fig.set_size_inches((w,h) )

необязательный ключевой параметр forward=True автоматически обновит размер холста; например, вы можете изменить размер окна фигуры из оболочки

ПРИНИМАЕТ: кортеж w, h, где w и h — значения в дюймах

См. также

matplotlib.Figure.get_size_inches

set_tight_layout(tight)

Установить, используется ли tight_layout() при отрисовке. Если None, будет использоваться значение rcParams[‘figure.autolayout’].

При предоставлении словаря, содержащего ключи pad, w_pad, h_pad и rect, значения по умолчанию отступов tight_layout() будут переопределены.

ПРИНИМАЕТ: [True | False | dict | None ]

show(warn=True)

Если используется графический бэкэнд с pyplot, отобразить окно фигуры.

Если фигура не была создана с помощью figure(), ей может не хватать FigureManagerBase, и будет возбуждено исключение AttributeError.

Для бэкэндов, не использующих графический интерфейс, это ничего не делает, в этом случае будет выведено предупреждение, если warn равно True (по умолчанию).

subplots_adjust(*args, **kwargs)

Вызов:

subplots_adjust(left=None, bottom=None, right=None, top=None,
                    wspace=None, hspace=None)

Обновить SubplotParams с помощью kwargs (по умолчанию rc, когда None) и обновить расположение подграфиков

suptitle(t, **kwargs)

Добавить центрированный заголовок к фигуре.

kwargs являются свойствами matplotlib.text.Text. Используя координаты фигуры, значения по умолчанию:

x: Положение текста по оси x в координатах фигуры
y: Положение текста по оси y в координатах фигуры
horizontalalignment: Горизонтальное выравнивание текста
verticalalignment: Вертикальное выравнивание текста

Возвращается экземпляр matplotlib.text.Text.

Пример:

fig.suptitle('this is the figure title', fontsize=12)

text(x, y, s, *args, **kwargs)

Добавить текст к рисунку.

Вызов функции:

text(x, y, s, fontdict=None, **kwargs)

Добавить текст к рисунку в местоположение x, y (координаты относительно 0-1). См. text() для значения других аргументов.

Параметры kwargs управляют свойствами Text:

Свойство	Описание
`agg_filter`	неизвестно
`alpha`	число с плавающей точкой (от 0.0 — прозрачный до 1.0 — непрозрачный)
`animated`	[True \| False]
`axes`	экземпляр `Axes`
`backgroundcolor`	любой цвет matplotlib
`bbox`	словарь свойств FancyBboxPatch
`clip_box`	экземпляр `matplotlib.transforms.Bbox`
`clip_on`	[True \| False]
`clip_path`	[ ( `Path`, `Transform`) \| `Patch` \| None ]
`color`	любой цвет matplotlib
`contains`	функция-вызов
`family` или имя_шрифта или семейство_шрифтов или имя	[ИМЯ_ШРИФТА \| ‘serif’ \| ‘sans-serif’ \| ‘cursive’ \| ‘fantasy’ \| ‘monospace’ ]
`figure`	экземпляр `matplotlib.figure.Figure`
`fontproperties` или font_properties	экземпляр `matplotlib.font_manager.FontProperties`
`gid`	строка-идентификатор
`horizontalalignment` или ha	[ ‘center’ \| ‘right’ \| ‘left’ ]
`label`	строка или любой печатаемый объект с преобразованием ‘%s’
`linespacing`	число с плавающей точкой (кратное размеру шрифта)
`multialignment`	[‘left’ \| ‘right’ \| ‘center’ ]
`path_effects`	неизвестно
`picker`	[None\|число с плавающей точкой\|логическое значение\|функция-вызов]
`position`	(x,y)
`rasterized`	[True \| False \| None]
`rotation`	[ угол в градусах \| ‘vertical’ \| ‘horizontal’ ]
`rotation_mode`	неизвестно
`size` или размер_шрифта	[размер в пунктах \| ‘xx-small’ \| ‘x-small’ \| ‘small’ \| ‘medium’ \| ‘large’ \| ‘x-large’ \| ‘xx-large’ ]
`sketch_params`	неизвестно
`snap`	неизвестно
`stretch` или fontstretch	[числовое значение в диапазоне 0-1000 \| ‘ultra-condensed’ \| ‘extra-condensed’ \| ‘condensed’ \| ‘semi-condensed’ \| ‘normal’ \| ‘semi-expanded’ \| ‘expanded’ \| ‘extra-expanded’ \| ‘ultra-expanded’ ]
`style` или fontstyle	[ ‘normal’ \| ‘italic’ \| ‘oblique’]
`text`	строка или любой печатаемый объект с преобразованием ‘%s’
`transform`	экземпляр `Transform`
`url`	строка url
`usetex`	неизвестно
`variant` или fontvariant	[ ‘normal’ \| ‘small-caps’ ]
`verticalalignment` или ma или va	[ ‘center’ \| ‘top’ \| ‘bottom’ \| ‘baseline’ ]
`visible`	[True \| False]
`weight` или fontweight	[числовое значение в диапазоне 0-1000 \| ‘ultralight’ \| ‘light’ \| ‘normal’ \| ‘regular’ \| ‘book’ \| ‘medium’ \| ‘roman’ \| ‘semibold’ \| ‘demibold’ \| ‘demi’ \| ‘bold’ \| ‘heavy’ \| ‘extra bold’ \| ‘black’ ]
`wrap`	неизвестно
`x`	число с плавающей точкой
`y`	число с плавающей точкой
`zorder`	любое число

tight_layout(renderer=None, pad=1.08, h_pad=None, w_pad=None, rect=None)

Настройка параметров подграфиков для задания заданного отступа.

Параметры:

pad: отступ между краем фигуры и краями подграфиков, как доля размера шрифта.
h_pad, w_pad: отступ (высота/ширина) между краями смежных подграфиков. По умолчанию pad_inches.
rect: (слева, снизу, справа, сверху) в нормализованных координатах фигуры, в которые будет помещена вся область подграфиков (включая метки). По умолчанию (0, 0, 1, 1).

waitforbuttonpress(timeout=-1)

Вызов сигнатуры:

waitforbuttonpress(self, timeout=-1)

Блокирующий вызов для взаимодействия с фигурой.

Это вернёт True, если была нажата клавиша, False, если была нажата кнопка мыши, и None, если timeout был достигнут без нажатия ни того, ни другого.

Если timeout отрицательный, таймаут не используется.

class matplotlib.figure.SubplotParams(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)

Базы: object

Класс для хранения параметров подграфика

Все размеры являются долей ширины или высоты фигуры. Все значения по умолчанию соответствуют своим значениям в rc параметров

Доступны следующие атрибуты

left: Левая сторона подграфиков фигуры
right: Правая сторона подграфиков фигуры
bottom: Нижняя сторона подграфиков фигуры
top: Верхняя сторона подграфиков фигуры
wspace: Количество ширины, зарезервированной для пустого пространства между подграфиками
hspace: Количество высоты, зарезервированной для белого пространства между подграфиками

update(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None): Обновить текущие значения. Если любой kwarg равен None, используется текущее значение, если оно задано, в противном случае используется значение по умолчанию из rc

matplotlib.figure.figaspect(arg)

Создать фигуру с заданным соотношением сторон. Если arg — число, используется это соотношение сторон. Если arg — массив, figaspect определит ширину и высоту фигуры, которая бы подходила к массиву, сохраняя соотношение сторон. Возвращаются ширина и высота фигуры в дюймах. Убедитесь, что вы создаёте оси с одинаковой шириной и высотой, например,

Пример использования:

# make a figure twice as tall as it is wide
w, h = figaspect(2.)
fig = Figure(figsize=(w,h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)

# make a figure with the proper aspect for an array
A = rand(5,3)
w, h = figaspect(A)
fig = Figure(figsize=(w,h))
ax = fig.add_axes([0.1, 0.1, 0.8, 0.8])
ax.imshow(A, **kwargs)

Благодарим Фернандо Переса за эту функцию