matplotlib.figure.Figure

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

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

patch: Объект фигуры отрисовывается экземпляром matplotlib.patches.Rectangle
suppressComposite: Для нескольких изображений фигуры фигура будет создавать составные изображения в зависимости от функции render_option_image_nocomposite. Если suppressComposite имеет значение True|False, это переопределит обработчик.
figsize: Кортеж w,h в дюймах
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], где все величины выражены в долях ширины и высоты фигуры.

Параметры:

Параметры:	rect : последовательность float Последовательность из 4 элементов [left, bottom, width, height]. projection : [‘aitoff’ \| ‘hammer’ \| ‘lambert’ \| ‘mollweide’ \| ‘polar’ \| ‘rectilinear’], optional Тип проекции области графиков. polar : boolean, optional Если True, эквивалентно projection=’polar’. Этот метод также принимает ключевые аргументы для :class:`~matplotlib.axes.Axes`. Возвращаемое значение —— axes : Axes Добавленная область графиков.

rect : последовательность float

Последовательность из 4 элементов [left, bottom, width, height].

projection :

polar : boolean, optional

Если True, эквивалентно projection=’polar’.

Этот метод также принимает ключевые аргументы для

:class:`~matplotlib.axes.Axes`.

Возвращаемое значение

——

axes : Axes

Добавленная область графиков.

Примеры

Простой пример:

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

Если в фигуре уже есть область графиков с теми же параметрами, она просто делается текущей и возвращается. Это поведение устарело начиная с Matplotlib 2.1. В то же время, если вы не хотите этого поведения (т.е. хотите принудительно создать новую область графиков), вы должны использовать уникальный набор аргументов и ключевых слов. Атрибут axes label предназначен для этой цели: если вы хотите добавить две области графиков, которые в остальном идентичны, убедитесь, что вы дали им уникальные метки:

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

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

fig.add_axes(ax)

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

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

add_subplot(*args, **kwargs)

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

Параметры:

Параметры:	args Либо трехзначное целое число, либо три отдельных целых числа, описывающие позицию подграфика. Если три целых числа I, J и K, то подграфик является I-м графиком на сетке с J строками и K столбцами. projection* : [‘aitoff’ \| ‘hammer’ \| ‘lambert’ \| ‘mollweide’, ‘polar’ \| ‘rectilinear’], optional Тип проекции области графиков. polar : boolean, optional Если True, эквивалентно projection=’polar’. Этот метод также принимает ключевые аргументы для :class:`~matplotlib.axes.Axes`.
Возвращаемое значение:	axes : Axes Область графиков подграфика.

*args

Либо трехзначное целое число, либо три отдельных целых числа, описывающие позицию подграфика. Если три целых числа I, J и K, то подграфик является I-м графиком на сетке с J строками и K столбцами.

projection : [‘aitoff’ | ‘hammer’ | ‘lambert’ | ‘mollweide’, ‘polar’ | ‘rectilinear’], optional

Тип проекции области графиков.

polar : boolean, optional

Если True, эквивалентно projection=’polar’.

Этот метод также принимает ключевые аргументы для

:class:`~matplotlib.axes.Axes`.

Возвращаемое значение:

axes : Axes

Область графиков подграфика.

См. также

matplotlib.pyplot.subplot: для объяснения аргументов.

Примечания

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

Примеры

fig.add_subplot(111)

# эквивалентно, но более обобщенно fig.add_subplot(1, 1, 1)

# добавить подграфик с красным фоном fig.add_subplot(212, facecolor=’r’)

# добавить полярный подграфик fig.add_subplot(111, projection=’polar’)

# добавить экземпляр Subplot sub fig.add_subplot(sub)

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

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

Параметры:

Параметры:	bottom : скаляр Нижняя часть подграфиков для `subplots_adjust()` rotation : угол в градусах Угол поворота меток оси X ha : строка Горизонтальное выравнивание меток оси X which : {None, ‘major’, ‘minor’, ‘both’} Выбор меток, которые нужно повернуть (по умолчанию None, что работает так же, как major)

bottom : скаляр

Нижняя часть подграфиков для subplots_adjust()

rotation : угол в градусах

Угол поворота меток оси X

ha : строка

Горизонтальное выравнивание меток оси X

which : {None, ‘major’, ‘minor’, ‘both’}

Выбор меток, которые нужно повернуть (по умолчанию None, что работает так же, как major)

axes: Только чтение: список областей графиков в Figure

clear(keep_observers=False): Очистка фигуры — синоним для 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	[ ‘neither’ \| ‘both’ \| ‘min’ \| ‘max’ ] Если не ‘neither’, добавить указатели (треугольники) для значений вне диапазона. Они устанавливаются для заданной цветовой карты с помощью методов colormap set_under и set_over.
extendfrac	[ None \| ‘auto’ \| длина \| длины ] Если None, минимальное и максимальное треугольные расширения полосы цвета имеют длину 5% от длины внутренней полосы цвета (это значение по умолчанию). Если ‘auto’, треугольные расширения полосы цвета имеют такую же длину, как внутренние прямоугольники (когда spacing равен ‘uniform’) или такую же длину, как соседние внутренние прямоугольники (когда spacing равен ‘proportional’). Если скаляр, указывает длину минимального и максимального треугольных расширений полосы цвета как долю от длины внутренней полосы цвета. Также может быть задана двухэлементная последовательность дробей, указывающая длину минимального и максимального расширений полосы цвета соответственно как долю от длины внутренней полосы цвета.
extendrect	[ False \| True ] Если False, минимальное и максимальное расширения полосы цвета будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	[ ‘uniform’ \| ‘proportional’ ] Равномерное распределение дает каждому дискретному цвету одинаковое место; пропорциональное делает расстояние пропорциональным интервалу данных.
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.

Свойство

Описание

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(renderer): Отобразить фигуру с помощью экземпляра 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`. По умолчанию используется normalization(). Это масштабирует яркость -> 0-1
vmin\|vmax	используются для масштабирования изображения яркости до 0-1. Если одно из них равно None, используются минимальное и максимальное значения яркости. Обратите внимание, что если вы передаете экземпляр norm, настройки vmin и vmax будут игнорироваться.
alpha	значение альфа-смешивания, по умолчанию равно None
origin	[‘верх’ \| ‘низ’] Указывает, где индекс [0,0] массива находится в верхнем левом или нижнем левом углу осей. По умолчанию используется значение rc image.origin

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

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

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

figurePatch: Устарело начиная с версии 2.1: Функция figurePatch устарела в версии 2.1. Используйте Figure.patch вместо неё.

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_locator`	неизвестно
`axisbelow`	[True \| False \| ‘line’]
`clip_box`	экземпляр `matplotlib.transforms.Bbox`
`clip_on`	[True \| False]
`clip_path`	[(`Path`, `Transform`) \| `Patch` \| None]
`color_cycle`	неизвестно
`contains`	вызываемая функция
`facecolor`	неизвестно
`fc`	неизвестно
`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`	неизвестно
`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	неизвестно
`ylabel`	неизвестно
`ylim`	неизвестно
`ymargin`	неизвестно
`yscale`	неизвестно
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	любое число

get_axes()

get_children(): Получить список элементов-артистов, содержащихся в рисунке

get_default_bbox_extra_artists()

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

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

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

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, если использовать tight_layout() при отрисовке.

get_tightbbox(renderer)

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

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

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

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

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

Ждет, пока пользователь n раз щелкнет по фигуре, и возвращает координаты каждого щелчка в списке.

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

Параметры:

Параметры:	n : int, необязательно, по умолчанию: 1 Количество щелчков мышью для накопления. Если отрицательно, накапливать щелчки, пока ввод не будет завершен вручную. timeout : скаляр, необязательно, по умолчанию: 30 Количество секунд ожидания до истечения времени. Если ноль или отрицательное значение, таймаут никогда не наступит. show_clicks : bool, необязательно, по умолчанию: False Если True, показывать красный крест в месте каждого щелчка. mouse_add : int, одно из (1, 2, 3), необязательно, по умолчанию: 1 (левый щелчок) Кнопка мыши, используемая для добавления точек. mouse_pop : int, одно из (1, 2, 3), необязательно, по умолчанию: 3 (правый щелчок) Кнопка мыши, используемая для удаления последней добавленной точки. mouse_stop : int, одно из (1, 2, 3), необязательно, по умолчанию: 2 (средний щелчок) Кнопка мыши, используемая для остановки ввода.
Возвращает:	points : список кортежей Список координат щелчков (x, y).

n : int, необязательно, по умолчанию: 1

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

timeout : скаляр, необязательно, по умолчанию: 30

Количество секунд ожидания до истечения времени. Если ноль или отрицательное значение, таймаут никогда не наступит.

show_clicks : bool, необязательно, по умолчанию: False

Если True, показывать красный крест в месте каждого щелчка.

mouse_add : int, одно из (1, 2, 3), необязательно, по умолчанию: 1 (левый щелчок)

Кнопка мыши, используемая для добавления точек.

mouse_pop : int, одно из (1, 2, 3), необязательно, по умолчанию: 3 (правый щелчок)

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

mouse_stop : int, одно из (1, 2, 3), необязательно, по умолчанию: 2 (средний щелчок)

Кнопка мыши, используемая для остановки ввода.

Возвращает:

points : список кортежей

Список координат щелчков (x, y).

Примечания

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

hold(b=None)

Устарело начиная с версии 2.0: Функция hold устарела в версии 2.0.

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

Например:

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

Все механизмы «hold» устарели.

legend(*args, **kwargs)

Разместить легенду на рисунке.

Для создания легенды из существующих объектов на каждом осей:

legend()

Для создания легенды для списка линий и меток:

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

Параметры:

loc : строка или целое число

Расположение легенды. Возможные значения:

Строковое обозначение расположения	Код расположения
‘верхний правый’	1
‘верхний левый’	2
‘нижний левый’	3
‘нижний правый’	4
‘правый’	5
‘центр слева’	6
‘центр справа’	7
‘нижний центр’	8
‘верхний центр’	9
‘центр’	10

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

prop : None или FontProperties или словарь

Экземпляр matplotlib.font_manager.FontProperties. Если prop — словарь, будет создан новый экземпляр с prop. Если None, будут использованы настройки rc.

numpoints : целое число

Количество точек в линии легенды, по умолчанию 4

scatterpoints : целое число

Количество точек в линии легенды, по умолчанию 4

scatteryoffsets : список чисел с плавающей точкой

Список смещений по оси y для символов точек рассеяния в легенде

markerscale : None или число

Относительный размер маркеров легенды по отношению к оригинальным. Если None, будут использованы настройки rc.

markerfirst : bool

Если True, маркер легенды располагается слева от метки легенды. Если False, маркер легенды располагается справа от метки легенды. По умолчанию True.

frameon : None или bool

Управление отображением легенды на области (рамке). По умолчанию None, что использует значение из legend.frameon rcParam.

fancybox : None или bool

Если True, рисуется рамка с закругленными углами. Если None, используются настройки rc.

shadow : None или bool

Если True, рисуется тень за легендой. Если None, используются настройки rc.

framealpha : None или float

Управление альфа-прозрачностью фона легенды. По умолчанию None, что использует значение из legend.framealpha rcParam.

facecolor : None или “inherit” или цветовое описание

Управление цветом фона легенды. По умолчанию None, что использует значение из legend.facecolor rcParam. Если "inherit", будет использовано значение из axes.facecolor rcParam.

edgecolor : None или “inherit” или цветовое описание

Управление цветом границы области фона легенды. По умолчанию None, что использует значение из legend.edgecolor rcParam. Если "inherit", будет использовано значение из axes.edgecolor rcParam.

ncol : целое число

Количество столбцов. По умолчанию 1.

mode : “expand” или None

Если mode — “expand”, легенда будет горизонтально расширена, чтобы заполнить область осей (или bbox_to_anchor)

title : строка

Заголовок легенды

borderpad : число с плавающей точкой или None

Межстрочный отступ внутри границы легенды, измеряемый в единицах размера шрифта. По умолчанию None, что использует значение из legend.borderpad rcParam.

labelspacing : число с плавающей точкой или None

Вертикальное расстояние между элементами легенды, измеряемое в единицах размера шрифта. По умолчанию None, что использует значение из legend.labelspacing rcParam.

handlelength : число с плавающей точкой или None

Длина элементов управления легенды, измеряемая в единицах размера шрифта. По умолчанию None, что использует значение из legend.handlelength rcParam.

handletextpad : число с плавающей точкой или None

Отступ между элементом управления легенды и текстом, измеряемый в единицах размера шрифта. По умолчанию None, что использует значение из legend.handletextpad rcParam.

borderaxespad : число с плавающей точкой или None

Отступ между осями и границей легенды, измеряемый в единицах размера шрифта. По умолчанию None, что использует значение из legend.borderaxespad rcParam.

columnspacing : число с плавающей точкой или None

Отступ между столбцами, измеряемый в единицах размера шрифта. По умолчанию None, что использует значение из legend.columnspacing rcParam.

Возвращаемое значение:

matplotlib.legend.Legend экземпляр

Примечания

Не все типы объектов поддерживаются командой легенды. Подробности см. в Руководстве по легендам.

savefig(fname, **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 будет установлено в значение рисунка.
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 через параметры kwargs. Это полезно, например, для отображения графика поверх цветного фона на веб-странице. Прозрачность этих областей будет восстановлена до исходных значений после выхода из этой функции.
frameon:: Если True, область рисунка будет окрашена, если False, фон рисунка будет прозрачным. Если не задано, используется значение rcParam ‘savefig.frameon’.
bbox_inches:: Bbox в дюймах. Сохраняется только заданная часть рисунка. Если ‘tight’, пытается определить компактную область рисунка.
pad_inches:: Количество отступа вокруг рисунка, когда bbox_inches — ‘tight’.
bbox_extra_artists:: Список дополнительных объектов, которые будут учтены при вычислении компактной области.

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

set_canvas(canvas)

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

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

set_dpi(val)

Установить разрешение в точках на дюйм для рисунка

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

set_edgecolor(color)

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

ПРИНИМАЕТ: любой matplotlib цвет - см. справку по цветам

set_facecolor(color)

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

ПРИНИМАЕТ: любой matplotlib цвет - см. справку по цветам

set_figheight(val, forward=False)

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

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

set_figwidth(val, forward=False)

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

ПРИНИМАЕТ: float

set_frameon(b)

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

ПРИНИМАЕТ: boolean

set_size_inches(w, h=None, forward=True)

Установить размер рисунка в дюймах (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(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)

Добавить набор подрисунков к этому рисунку.

Параметры:

Параметры:	nrows, ncols : int, по умолчанию: 1 Количество строк/столбцов сетки подрисунков. sharex, sharey : bool или {‘none’, ‘all’, ‘row’, ‘col’}, по умолчанию: False Управляет совместным использованием свойств среди осей x (`sharex`) или y (`sharey`) : True или ‘all’: оси x или y будут совместно использоваться всеми подрисунками. False или ‘none’: каждая ось x или y каждого подриунка будет независимой. ‘row’: каждая строка подрисунков будет совместно использовать ось x или y. ‘col’: каждый столбец подрисунков будет совместно использовать ось x или y. Когда подрисунки имеют общую ось x вдоль столбца, метки делений x нижнего подриунка отображаются. Аналогично, когда подрисунки имеют общую ось y вдоль строки, метки делений y первого столбца подрисунков отображаются. squeeze : bool, по умолчанию: True Если True, лишние измерения будут удалены из возвращаемого объекта оси: если создан только один подрисунок (nrows=ncols=1), возвращается единственный объект Axes в качестве скаляра. для подрисунков Nx1 или 1xN возвращается одномерный массив numpy объектов Axes, возвращаемые в виде одномерных массивов numpy. для NxM подрисунков с N>1 и M>1 возвращаются двумерные массивы. Если False, никакое сжатие не выполняется: возвращаемый объект Axes всегда является двумерным массивом, содержащим экземпляры Axes, даже если он в итоге 1x1. subplot_kw : dict, по умолчанию: {} Словарь с ключевыми словами, передаваемыми в вызов `add_subplot()` для создания каждого подриунка. gridspec_kw : dict, по умолчанию: {} Словарь с ключевыми словами, передаваемыми в конструктор `GridSpec` для создания сетки, на которой размещаются подрисунки.
Возвращает:	ax : единственный объект Axes или массив объектов Axes Добавленные оси. Размеры результирующего массива можно контролировать с помощью ключевого слова squeeze, см. выше.

nrows, ncols : int, по умолчанию: 1

Количество строк/столбцов сетки подрисунков.

sharex, sharey : bool или {‘none’, ‘all’, ‘row’, ‘col’}, по умолчанию: False

Управляет совместным использованием свойств среди осей x (sharex) или y (sharey) :

True или ‘all’: оси x или y будут совместно использоваться всеми подрисунками.
False или ‘none’: каждая ось x или y каждого подриунка будет независимой.
‘row’: каждая строка подрисунков будет совместно использовать ось x или y.
‘col’: каждый столбец подрисунков будет совместно использовать ось x или y.

Когда подрисунки имеют общую ось x вдоль столбца, метки делений x нижнего подриунка отображаются. Аналогично, когда подрисунки имеют общую ось y вдоль строки, метки делений y первого столбца подрисунков отображаются.

squeeze : bool, по умолчанию: True

Если True, лишние измерения будут удалены из возвращаемого объекта оси:
- если создан только один подрисунок (nrows=ncols=1), возвращается единственный объект Axes в качестве скаляра.
- для подрисунков Nx1 или 1xN возвращается одномерный массив numpy объектов Axes, возвращаемые в виде одномерных массивов numpy.
- для NxM подрисунков с N>1 и M>1 возвращаются двумерные массивы.
Если False, никакое сжатие не выполняется: возвращаемый объект Axes всегда является двумерным массивом, содержащим экземпляры Axes, даже если он в итоге 1x1.

subplot_kw : dict, по умолчанию: {}

Словарь с ключевыми словами, передаваемыми в вызов add_subplot() для создания каждого подриунка.

gridspec_kw : dict, по умолчанию: {}

Словарь с ключевыми словами, передаваемыми в конструктор GridSpec для создания сетки, на которой размещаются подрисунки.

Возвращает:

ax : единственный объект Axes или массив объектов Axes

Добавленные оси. Размеры результирующего массива можно контролировать с помощью ключевого слова squeeze, см. выше.

См. также

pyplot.subplots: API pyplot; в строке документации содержатся примеры.

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 : 0.5: Положение x текста в координатах рисунка
y : 0.98: Положение y текста в координатах рисунка
horizontalalignment : ‘center’: Горизонтальное выравнивание текста
verticalalignment : ‘top’: Вертикальное выравнивание текста

Если указан аргумент kwarg fontproperties, значения по умолчанию rcParams для fontsize (figure.titlesize) и fontweight (figure.titleweight) будут проигнорированы в пользу значений по умолчанию FontProperties.

Возвращается экземпляр 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() для значения других аргументов.

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

Свойство	Описание
`agg_filter`	неизвестно
`alpha`	вещественное число (от 0.0 — прозрачный до 1.0 — непрозрачный)
`animated`	[True \| False]
`backgroundcolor`	любой цвет matplotlib
`bbox`	свойства FancyBboxPatch
`clip_box`	экземпляр `matplotlib.transforms.Bbox`
`clip_on`	[True \| False]
`clip_path`	[ (`Path`, `Transform`) \| `Patch` \| None ]
`color`	любой цвет matplotlib
`contains`	вызываемая функция
`family` или fontfamily или fontname или name	[НАЗВАНИЕ_ШРИФТА \| ‘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` или fontsize	[размер в пунктах \| ‘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 : float: отступ между краем рисунка и краями подграфиков, как доля размера шрифта.
h_pad, w_pad : float: отступ (высота/ширина) между краями смежных подграфиков. По умолчанию pad_inches.
rect : if rect is given, it is interpreted as a rectangle: (левый, нижний, правый, верхний) в нормализованных координатах рисунка, в которые поместится вся область подграфиков (включая подписи). По умолчанию (0, 0, 1, 1).

waitforbuttonpress(timeout=-1)

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

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

Если timeout отрицательный, ожидания нет.