matplotlib.figure

matplotlib.figure реализует следующие классы:

Figure: Основной уровень Artist, содержащий все элементы графика. Многие методы реализованы в FigureBase.
SubFigure: Логическая фигура внутри фигуры, обычно добавляемая в фигуру (или родительскую SubFigure) с помощью методов Figure.add_subfigure или Figure.subfigures (временный API v3.4).
SubplotParams: Управление стандартным отступом между подграфиками.

classmatplotlib.figure.Figure(figsize=None, dpi=None, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None, constrained_layout=None, *, layout=None, **kwargs)[source]

Основной контейнер для всех элементов графика.

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

Атрибуты

patch: Экземпляр Rectangle, представляющий патч фона фигуры.
suppressComposite: Для нескольких изображений фигура будет создавать составные изображения в зависимости от функции renderera option_image_nocomposite. Если suppressComposite — логическое значение, это переопределит рендерер.

Параметры

figsize2-кортеж чисел с плавающей точкой, по умолчанию: rcParams["figure.figsize"] (по умолчанию: [6.4, 4.8])

Размер фигуры (width, height) в дюймах.

dpiчисло с плавающей точкой, по умолчанию: rcParams["figure.dpi"] (по умолчанию: 100.0)

Точек на дюйм.

facecolorпо умолчанию: rcParams["figure.facecolor"] (по умолчанию: 'white')

Цвет заливки патча фигуры.

edgecolorпо умолчанию: rcParams["figure.edgecolor"] (по умолчанию: 'white')

Цвет границы патча фигуры.

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

Ширина линии рамки (т.е. ширина линии границы патча фигуры).

frameonбулево значение, по умолчанию: rcParams["figure.frameon"] (по умолчанию: True)

Если False, запретить отображение патча фона фигуры.

subplotparsSubplotParams

Параметры подграфиков. Если не указаны, используются стандартные параметры подграфиков rcParams["figure.subplot.*"].

tight_layoutлогическое значение или словарь, по умолчанию: rcParams["figure.autolayout"] (по умолчанию: False)

Использовать ли механизм tight layout. См. set_tight_layout.

Не рекомендуется

Использование этого параметра не рекомендуется. Используйте layout='tight' вместо него в общем случае tight_layout=True и используйте set_tight_layout в противном случае.

constrained_layoutлогическое значение, по умолчанию: rcParams["figure.constrained_layout.use"] (по умолчанию: False)

Это равно layout='constrained'.

Не рекомендуется

Использование этого параметра не рекомендуется. Используйте layout='constrained' вместо него.

layout{'constrained', 'tight'}, необязательно

Механизм макета для позиционирования элементов графика. Поддерживаемые значения:

'constrained': решатель constrained layout обычно дает лучшие результаты макета и поэтому рекомендуется. Однако он вычислительно затратен и может быть медленным для сложных фигур с большим количеством элементов.

См. Руководство по constrained layout для примеров.
'tight': Используйте механизм tight layout. Это относительно простой алгоритм, который настраивает параметры подграфиков таким образом, чтобы у декораций, таких как метки делений, подписи осей и заголовки, было достаточно места. См. Figure.set_tight_layout для получения дополнительной информации.

Если не указано, используется параметры tight_layout и constrained_layout, включая их значения по умолчанию в конфигурации rcParams["figure.autolayout"] (по умолчанию: False) и rcParams["figure.constrained_layout.use"] (по умолчанию: False).

Другие параметры

**kwargsFigure свойства, необязательно

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`animated`	bool
`canvas`	FigureCanvas
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`constrained_layout`	bool или dict или None
`constrained_layout_pads`	float, по умолчанию: `rcParams["figure.constrained_layout.w_pad"]` (по умолчанию: `0.04167`)
`dpi`	float
`edgecolor`	цвет
`facecolor`	цвет
`figheight`	float
`figure`	`Figure`
`figwidth`	float
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`linewidth`	число
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемая функция
`rasterized`	bool
`size_inches`	(float, float) или float
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`tight_layout`	bool или dict с ключами "pad", "w_pad", "h_pad", "rect" или None
`transform`	`Transform`
`url`	строка
`visible`	bool
`zorder`	float

add_artist(artist, clip=False)[source]

Добавление Artist к фигуре.

Обычно элементы добавляются в объекты Axes с помощью Axes.add_artist; этот метод может использоваться в редких случаях, когда необходимо добавить элементы непосредственно в фигуру.

Параметры

artistArtist: Элемент для добавления в фигуру. Если у добавленного элемента нет ранее заданного преобразования, его преобразование будет установлено в figure.transSubfigure.
clipbool, по умолчанию: False: Определяет, должен ли добавленный элемент быть обрезаем областью фигуры.

Возвращает

Artist: Добавленный элемент.

add_axes(*args, **kwargs)[source]

Добавить область построения графиков (Axes) в фигуру.

Возможные варианты вызова:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)

Параметры

rectпоследовательность чисел с плавающей точкой: Размеры новой области построения графиков [левый, нижний, ширина, высота]. Все величины выражены в долях ширины и высоты фигуры.
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', строка}, необязательно: Тип проекции для Axes. строка — имя пользовательской проекции, см. projections. Значение None по умолчанию соответствует проекции 'rectilinear'.
polarbool, по умолчанию: False: Если True, эквивалентно projection='polar'.
axes_classподкласс Axes, необязательно: Подкласс axes.Axes, который используется для создания экземпляра. Этот параметр несовместим с параметрами projection и polar. Примеры использования см. в axisartist.
sharex, shareyAxes, необязательно: Использовать общие оси x или y с sharex и/или sharey. Оси будут иметь одинаковые пределы, метки и масштаб с осями совмещаемой области построения графиков.
labelстрока: Метка для возвращаемой области построения графиков.

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

Axes, или подкласс Axes: Тип возвращаемой области построения графиков зависит от используемой проекции. Это Axes для прямолинейной проекции и projections.polar.PolarAxes для полярной проекции.

Дополнительные параметры

**kwargs: Этот метод также принимает ключевые аргументы для класса возвращаемой области построения графиков. Ключевые аргументы для класса прямолинейной области построения графиков Axes приведены в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция, см. фактический класс области построения графиков.

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} или float
`autoscale_on`	bool
`autoscalex_on`	bool
`autoscaley_on`	bool
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	float или None
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемая функция
`position`	[левое, нижнее, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	float или None
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(низ: float, верх: float)
`xmargin`	число больше -0,5
`xscale`	{"линейный", "логарифмический", "симлогический", "логический", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно

`ybound`	неизвестно
`ylabel`	строка
`ylim`	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
`ymargin`	число с плавающей точкой, больше -0,5
`yscale`	{"линейный", "логарифмический", "симлогирифмический", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

См. также

Figure.add_subplot
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примечания

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

Примеры

Некоторые простые примеры:

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

add_axobserver(func)[source]: Всякий раз, когда изменяется состояние оси, func(self) будет вызван.

add_callback(func)[source]

Добавить функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Параметры

funcвызываемая функция

Функция обратного вызова. Она должна иметь подпись:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Возвращаемые значения могут существовать, но игнорируются.

Возвращает

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

См. также

remove_callback

add_gridspec(nrows=1, ncols=1, **kwargs)[source]

Возвращает GridSpec, у которого эта фигура является родителем. Это позволяет выполнять сложное расположение осей в фигуре.

Параметры

nrowsцелое число, по умолчанию: 1: Количество строк в сетке.
ncolsцелое число, по умолчанию: 1: Количество столбцов в сетке.

Возвращает

GridSpec

Другие параметры

**kwargs: Ключевые аргументы передаются в GridSpec.

См. также

matplotlib.pyplot.subplots

Примеры

Добавление подграфика, занимающего две строки:

fig = plt.figure()
gs = fig.add_gridspec(2, 2)
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[1, 0])
# spans two rows:
ax3 = fig.add_subplot(gs[:, 1])

add_subfigure(subplotspec, **kwargs)[source]

Добавить SubFigure в фигуру как часть расположения подграфиков.

Параметры

subplotspecgridspec.SubplotSpec: Определяет область в родительской сетке, где будет размещена подфигура.

Возвращает

figure.SubFigure

Другие параметры

**kwargs: Передаются в объект SubFigure.

См. также

Figure.subfigures

add_subplot(*args, **kwargs)[source]

Добавить Axes на график в качестве части размещения подграфиков.

Вызовы:

add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()

Параметры

*argsint, (int, int, index), или SubplotSpec, по умолчанию: (1, 1, 1)

Положение подграфика, описываемое одним из

Трех целых чисел (nrows, ncols, index). Подграфик займет позицию index на сетке с nrows строками и ncols столбцами. index начинается с 1 в верхнем левом углу и увеличивается вправо. index также может быть двухэлементной кортежем, задающим (first, last) индексы (1-основанные, включающие last) подграфика, например, fig.add_subplot(3, 1, (1, 2)) создает подграфик, занимающий верхние 2/3 графика.
Трехзначное целое число. Цифры интерпретируются как заданные отдельно как три однозначных числа, т.е. fig.add_subplot(235) эквивалентно fig.add_subplot(2, 3, 5). Обратите внимание, что это можно использовать только если подграфиков не более 9.
Объект SubplotSpec.

В редких случаях, add_subplot может быть вызван с одним аргументом, объектом Axes подграфика, уже созданным в текущем графике, но не в списке Axes графика.

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional

Тип проекции подграфика (Axes). str — имя пользовательской проекции, см. projections. По умолчанию None, что приводит к проекции 'rectilinear'.

polarbool, по умолчанию: False

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

axes_classподкласс Axes, необязательно

Подкласс axes.Axes, который создается. Этот параметр несовместим с projection и polar. См. axisartist для примеров.

sharex, shareyAxes, необязательно

Поделиться осью x или y с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось общих осей.

labelstr

Метка для возвращаемого Axes.

Возвращает

axes.SubplotBase или другой подкласс Axes: Axes подграфика. Возвращаемый базовый класс Axes зависит от используемой проекции. Это Axes, если используется прямолинейная проекция, и projections.polar.PolarAxes, если используется полярная проекция. Возвращаемый Axes является подклассом базового класса подграфика.

Другие параметры

**kwargs: Этот метод также принимает ключевые аргументы для возвращаемого базового класса Axes; за исключением аргумента figure. Ключевые аргументы для прямолинейного базового класса Axes можно найти в следующей таблице, но также могут быть и другие ключевые аргументы, если используется другая проекция.

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} или float
`autoscale_on`	bool
`autoscalex_on`	bool
`autoscaley_on`	bool
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	float или None
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	объект
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`position`	[левое, нижнее, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	float или None
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(нижняя: float, верхняя: float)
`xmargin`	float больше -0,5
`xscale`	{"линейный", "логарифмический", "симлогический", "логит", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно

`ybound`	неизвестно
`ylabel`	строка
`ylim`	(нижняя: число, верхняя: число)
`ymargin`	число больше -0,5
`yscale`	{"линейный", "логарифмический", "симлогарифмический", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

См. также

Figure.add_axes
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примеры

fig = plt.figure()

fig.add_subplot(231)
ax1 = fig.add_subplot(2, 3, 1)  # equivalent but more general

fig.add_subplot(232, frameon=False)  # subplot with no frame
fig.add_subplot(233, projection='polar')  # polar subplot
fig.add_subplot(234, sharex=ax1)  # subplot sharing x-axis with ax1
fig.add_subplot(235, facecolor="red")  # red subplot

ax1.remove()  # delete ax1 from the figure
fig.add_subplot(ax1)  # add ax1 back to the figure

align_labels(axs=None)[source]

Выравнивает подписи x и y для подграфиков в одной строке или столбце подграфиков (соответственно), если выравнивание меток выполняется автоматически (т.е. позиция метки не задана вручную).

Выравнивание сохраняется для событий рисования после вызова этой функции.

Параметры

axsсписок Axes: Необязательный список (Axes для выравнивания меток. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels

align_xlabels(axs=None)[source]

Выравнивает подписи x для подграфиков в одном столбце подграфиков, если выравнивание меток выполняется автоматически (т.е. позиция метки не задана вручную).

Выравнивание сохраняется для событий рисования после вызова этой функции.

Если метка находится внизу, она выравнивается с метками на осях, у которых метка также находится внизу и у которых одинаковая самая нижняя строка подграфиков. Если метка находится вверху, она выравнивается с метками на осях с одинаковой самой верхней строкой.

Параметры

axsсписок Axes: Необязательный список Axes для выравнивания меток x. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels

Примечания

Предполагается, что axs взяты из одного GridSpec, чтобы их позиции SubplotSpec соответствовали позициям на рисунке.

Примеры

Пример с повернутыми метками x:

fig, axs = plt.subplots(1, 2)
for tick in axs[0].get_xticklabels():
    tick.set_rotation(55)
axs[0].set_xlabel('XLabel 0')
axs[1].set_xlabel('XLabel 1')
fig.align_xlabels()

align_ylabels(axs=None)[source]

Выравнивает подписи y для подграфиков в одном столбце подграфиков, если выравнивание меток выполняется автоматически (т.е. позиция метки не задана вручную).

Выравнивание сохраняется для событий рисования после вызова этой функции.

Если метка слева, она выравнивается с метками на осях, у которых метка также слева и у которых одинаковый самый левый столбец подграфиков. Если метка справа, она выравнивается с метками на осях с одинаковым самым правым столбцом.

Параметры

axsсписок Axes: Необязательный список Axes для выравнивания меток y. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_labels

Примечания

Предполагается, что axs взяты из одного GridSpec, чтобы их позиции SubplotSpec соответствовали позициям на рисунке.

Примеры

Пример с большими метками y:

fig, axs = plt.subplots(2, 1)
axs[0].plot(np.arange(0, 1000, 50))
axs[0].set_ylabel('YLabel 0')
axs[1].set_ylabel('YLabel 1')
fig.align_ylabels()

autofmt_xdate(bottom=0.2, rotation=30, ha='right', which='major')[source]

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

Параметры

bottomfloat, по умолчанию: 0.2: Нижняя граница подграфиков для subplots_adjust.
rotationfloat, по умолчанию: 30 градусов: Угол поворота меток на оси x в градусах.
ha{'left', 'center', 'right'}, по умолчанию: 'right': Горизонтальное выравнивание меток на оси x.
which{'major', 'minor', 'both'}, по умолчанию: 'major': Выбирает, какие метки вращать.

propertyaxes

Список осей Axes в Figure. Вы можете получить доступ к осям и изменить их через этот список.

Не изменяйте сам список. Используйте add_axes, add_subplot или delaxes для добавления или удаления осей.

Примечание: Свойство Figure.axes и метод get_axes эквивалентны.

clear(keep_observers=False)[source]: Очистить график — синоним для clf.

clf(keep_observers=False)[source]

Очистить график.

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

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

Добавить шкалу цвета к графику.

Параметры

mappable

Объект matplotlib.cm.ScalarMappable (например, AxesImage, ContourSet и т. д.), описываемый этой шкалой цвета. Этот аргумент обязателен для метода Figure.colorbar, но необязателен для функции pyplot.colorbar, которая устанавливает значение по умолчанию для текущего изображения.

Обратите внимание, что можно создать ScalarMappable «на лету», чтобы создать шкалу цвета, не привязанную к ранее нарисованному элементу, например:

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)

caxAxes, необязательно

Оси, на которые будет нарисована шкала цвета.

axAxes, список осей, необязательно

Одна или несколько родительских осей, из которых будет отобрана область для новых осей шкалы цвета, если cax равно None. Это не влияет, если cax задано.

use_gridspecbool, необязательно

Если cax None, новая cax создается как экземпляр осей. Если ax является экземпляром Subplot и use_gridspec True, cax создается как экземпляр Subplot с использованием модуля gridspec.

Возвращает

colorbarColorbar

Примечания

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

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

locationNone или {'left', 'right', 'top', 'bottom'}: Положение относительно родительских осей, где создаются оси шкалы цвета. Также определяет ориентацию шкалы цвета (шкалы цвета слева и справа вертикальные, шкалы цвета сверху и снизу горизонтальные). Если равно None, положение будет взято из orientation, если оно задано (вертикальные шкалы цвета справа, горизонтальные снизу), или по умолчанию будет равно 'right', если orientation не задано.
orientationNone или {'vertical', 'horizontal'}: Ориентация шкалы цвета. Предпочтительнее задать location шкалы цвета, так как это также определяет orientation; передача несовместимых значений для location и orientation вызывает исключение.
fractionfloat, по умолчанию: 0.15: Доля исходных осей, используемая для шкалы цвета.
shrinkfloat, по умолчанию: 1.0: Доля, на которую нужно умножить размер шкалы цвета.
aspectfloat, по умолчанию: 20: Соотношение длинных и коротких размеров.
padfloat, по умолчанию: 0.05, если вертикальная, 0.15, если горизонтальная: Доля исходных осей между шкалой цвета и новыми осями изображения.
anchor(float, float), необязательно: Точка привязки осей шкалы цвета. По умолчанию (0.0, 0.5), если вертикальная; (0.5, 1.0), если горизонтальная.
panchor(float, float) или False, необязательно: Точка привязки родительских осей шкалы цвета. Если False, точка привязки родительских осей не изменится. По умолчанию (1.0, 0.5), если вертикальная; (0.5, 0.0), если горизонтальная.

свойства шкалы цвета:

Свойство	Описание
extend	{'neither', 'both', 'min', 'max'} Если не 'neither', создавать стрелки для значений за пределами диапазона. Они устанавливаются для данной цветовой карты с помощью методов colormap set_under и set_over.
extendfrac	{None, 'auto', длина, длины} Если None, как минимум, и как максимум, треугольные расширения шкалы цвета будут иметь длину 5% длины внутренней шкалы цвета (это значение по умолчанию). Если 'auto', делает треугольные расширения шкалы цвета такой же длины, как внутренние ячейки (если spacing равен 'uniform') или такие же длины, как соответствующие соседние внутренние ячейки (если spacing равен 'proportional'). Если скаляр, указывает длину как минимум, и как максимум, треугольных расширений шкалы цвета как долю длины внутренней шкалы цвета. Также можно указать двухэлементный кортеж дробей, указывающий длину минимального и максимального расширений шкалы цвета как долю длины внутренней шкалы цвета.
extendrect	bool Если False, минимальные и максимальные расширения шкалы цвета будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	{'uniform', 'proportional'} Равномерное распределение дает каждому дискретному цвету одинаковое пространство; пропорциональное делает пространство пропорциональным интервалу данных.
ticks	None или список делений или Locator Если None, деления определяются автоматически из входных данных.
format	None или строка или Formatter Если None, используется `ScalarFormatter`. Если задана строка формата, например, '%.3f', она используется. Вместо этого может быть задан другой `Formatter`.
drawedges	bool Рисовать ли линии на границах цветов.
label	строка Подпись по длинной оси шкалы цвета.

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

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

Свойство

Описание

boundaries

None или последовательность

values

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

Если mappable — ContourSet, его extend kwarg включается автоматически.

Аргумент shrink предоставляет простой способ масштабирования шкалы цвета относительно осей. Обратите внимание, что если cax задан, он определяет размер шкалы цвета, и аргументы shrink и aspect игнорируются.

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

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

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

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

contains(mouseevent)[source]

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

Возвращает

bool, {}

convert_xunits(x)[source]

Преобразует x с использованием типа единиц измерения оси x.

Если элемент не входит в область Axes или у оси x нет единиц измерения, возвращается само x.

convert_yunits(y)[source]

Преобразовать y с помощью типа единицы измерения оси y.

Если элемент управления не находится в Axes или у оси y нет единиц измерения, возвращается само y.

delaxes(ax)[source]: Удалить Axes ax из фигуры; обновить текущую ось.

propertydpi: Разрешение в точках на дюйм.

draw(renderer)[source]

Отобразить элемент управления (и его потомков) с помощью заданного рендерера.

Это не оказывает влияния, если элемент управления не отображается (Artist.get_visible возвращает False).

Parameters

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах элемента управления.

draw_artist(a)[source]

Только отрисовать Artist a.

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

draw_without_rendering()[source]: Отрисовать фигуру без вывода. Полезно для получения окончательных размеров элементов управления, которые требуют отрисовки перед тем, как их размер станет известен (например, текст).

execute_constrained_layout(renderer=None)[source]

Используйте layoutgrid для определения позиций в Axes.

См. также set_constrained_layout_pads.

Returns

layoutgridприватный объект отладки

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

Добавить нересемплированное изображение в фигуру.

Изображение прикрепляется к левому нижнему или верхнему углу в зависимости от origin.

Parameters

X

Данные изображения. Это массив одного из следующих типов:

MxN: значения яркости (серого уровня серого)
MxNx3: значения RGB
MxNx4: значения RGBA

xo, yoint

Смещение изображения по осям x/y в пикселях.

alphaNone или float

Значение альфа-смешивания.

normmatplotlib.colors.Normalize

Экземпляр Normalize для отображения яркости в интервале [0, 1].

cmapстрока или matplotlib.colors.Colormap, по умолчанию: rcParams["image.cmap"] (по умолчанию: 'viridis')

Цветовая карта для использования.

vmin, vmaxfloat

Если norm не задан, эти значения задают пределы данных для цветовой карты.

origin{'upper', 'lower'}, по умолчанию: rcParams["image.origin"] (по умолчанию: 'upper')

Указывает, где индекс [0, 0] массива находится в верхнем левом или нижнем левом углу осей.

resizebool

Если True, размер фигуры изменяется для соответствия размеру заданного изображения.

Returns

matplotlib.image.FigureImage

Other Parameters

**kwargs: Дополнительные kwargs — это Artist kwargs, передаваемые FigureImage.

Примечания

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

Примеры

f = plt.figure()
nx = int(f.get_figwidth() * f.dpi)
ny = int(f.get_figheight() * f.dpi)
data = np.random.random((ny, nx))
f.figimage(data)
plt.show()

findobj(match=None, include_self=True)[source]

Поиск объектов художника.

Рекурсивно находит все экземпляры Artist, содержащиеся в художнике.

Параметры

match

Критерий фильтрации совпадений. Это может быть

None: Возвращает все объекты, содержащиеся в художнике.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только художников, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только художников этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки совпадения.

Возвращает

список Artist

format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

Этот метод предназначен для переопределения подклассами художников. Вероятно, конечный пользователь Matplotlib не будет вызывать этот метод самостоятельно.

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

См. также

get_cursor_data

свойствоframeon: Возвращает видимость фонового блока фигуры, то есть, будет ли отрисовываться фон фигуры. Эквивалентно Figure.patch.get_visible().

gca(**kwargs)[source]

Получить текущие оси.

Если на данной фигуре нет осей, создаётся новая с помощью Figure.add_subplot. (Чтобы проверить, есть ли на фигуре оси, проверьте, пуст ли figure.axes. Чтобы проверить, есть ли на стеке фигур pyplot, проверьте, пуст ли pyplot.get_fignums().)

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

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	bool
`autoscalex_on`	bool
`autoscaley_on`	bool
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	число или None
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число или вызываемый объект
`position`	[левый, нижний, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	число или None
`rasterized`	bool
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	bool или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(нижняя граница: число, верхняя граница: число)
`xmargin`	число, большее -0.5
`xscale`	{"линейный", "логарифмический", "симлогарифмический", "логарифмический", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	неизвестно

`ylabel`	строка
`ylim`	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
`ymargin`	число с плавающей точкой, большее -0,5
`yscale`	{"линейный", "логарифмический", "симлогический", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

get_agg_filter()[source]: Возвращает функцию фильтра, используемую для фильтра agg.

get_alpha()[source]: Возвращает значение альфа, используемое для смешивания — не поддерживается во всех бэкэндах.

get_animated()[source]: Возвращает значение, указывающее, является ли объект анимированным.

get_axes()[source]

Список осей в фигуре. Вы можете получить доступ к осям и изменить их в фигуре через этот список.

Не изменяйте сам список. Вместо этого используйте add_axes, add_subplot или delaxes для добавления или удаления осей.

Примечание: свойство Figure.axes и метод get_axes эквивалентны.

get_children()[source]: Получить список объектов художников, содержащихся в фигуре.

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает значение, указывающее, использует ли художник обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_constrained_layout()[source]

Возвращает значение, указывающее, используется ли ограниченное расположение.

См. Руководство по ограниченному расположению.

get_constrained_layout_pads(relative=False)[source]

Получить отступы для constrained_layout.

Возвращает список w_pad, h_pad в дюймах и wspace и hspace в долях подграфика.

См. Руководство по ограниченному расположению.

Parameters

relativebool: Если True, преобразуйте из дюймов в относительные единицы относительно фигуры.

get_cursor_data(event)[source]

Возвращает данные курсора для данного события.

Примечание

Этот метод предназначен для переопределения подклассами художников. В качестве конечного пользователя Matplotlib вы, скорее всего, не вызовете этот метод самостоятельно.

Данные курсора могут использоваться художниками для предоставления дополнительной контекстной информации для данного события. По умолчанию метод возвращает None.

Подклассы могут переопределить метод и вернуть произвольные данные. Однако при этом они должны убедиться, что format_cursor_data может преобразовать данные в строковое представление.

Единственный текущий случай использования — отображение значения z AxesImage в строке состояния окна графика при перемещении мыши.

Parameters

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

get_dpi()[source]: Возвращает разрешение в точках на дюйм как число с плавающей точкой.

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

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

get_figheight()[source]: Возвращает высоту фигуры в дюймах.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_figwidth()[source]: Возвращает ширину фигуры в дюймах.

get_frameon()[source]: Возвращает видимость фоновой области фигуры, т.е. будет ли отрисовываться фоновый прямоугольник. Эквивалентно Figure.patch.get_visible().

get_gid()[source]: Возвращает идентификатор группы.

get_in_layout()[source]

Возвращает логическое значение, True, если элемент включён в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linewidth()[source]: Получить ширину линии прямоугольника Figure.

get_path_effects()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_rasterized()[source]: Возвращает, должен ли элемент быть растровым.

get_size_inches()[source]

Возвращает текущий размер фигуры в дюймах.

Возвращает

ndarray: Размер фигуры (ширина, высота) в дюймах.

См. также

matplotlib.figure.Figure.set_size_inches
matplotlib.figure.Figure.get_figwidth
matplotlib.figure.Figure.get_figheight

Примечания

Размер в пикселях можно получить, умножив на Figure.dpi.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, по которому длина уменьшается или увеличивается.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает настройку привязки.

См. set_snap для подробностей.

get_tight_layout()[source]: Возвращает, вызывается ли tight_layout при отрисовке.

get_tightbbox(renderer, bbox_extra_artists=None)[source]

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

Обратите внимание, что FigureBase отличается от всех других элементов, которые возвращают их Bbox в пикселях.

Элементы, у которых есть artist.set_in_layout(False) не включаются в рамку.

Параметры

rendererRendererBase подкласс: объект отрисовки, который будет использован для отрисовки фигур (т.е. fig.canvas.get_renderer())
bbox_extra_artistsсписок Artist или None: Список элементов, которые следует включить в ограничительную рамку. Если None (по умолчанию), то все дочерние элементы каждого Axes включаются в ограничительную рамку.

Возвращает

BboxBase: содержащий ограничивающую рамку (в дюймах фигуры).

get_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[source]: Возвращает траекторию обрезки с примененной к ней не-аффинной частью преобразования и оставшейся аффинной частью преобразования.

get_url()[source]: Возвращает URL.

get_visible()[source]: Возвращает видимость.

get_window_extent(*args, **kwargs)[source]

Получение ограничивающей рамки элемента в пространстве отображения.

Ширина и высота ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление "тугой" ограничивающей рамки. По умолчанию возвращается пустая ограничивающая рамка в координатах 0, 0.

Будьте внимательны при использовании этой функции, результаты не обновляются, если ограничивающая рамка элемента на окне изменилась. Размер может измениться из-за любых изменений в стеке преобразований, таких как изменение пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть хорошо на экране, но будут сохраняться некорректно.

get_zorder()[source]: Возвращает z-порядок элемента.

ginput(n=1, timeout=30, show_clicks=True, mouse_add=MouseButton.LEFT, mouse_pop=MouseButton.RIGHT, mouse_stop=MouseButton.MIDDLE)[source]

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

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

Возможны три вида взаимодействия:

Добавление точки.
Удаление последней добавленной точки.
Остановка взаимодействия и возврат уже добавленных точек.

Действия назначаются кнопкам мыши с помощью аргументов mouse_add, mouse_pop и mouse_stop.

Параметры

nint, по умолчанию: 1: Количество щелчков мышью для накопления. Если отрицательное, накапливать щелчки, пока ввод не будет завершен вручную.
timeoutfloat, по умолчанию: 30 секунд: Количество секунд ожидания до истечения времени ожидания. Если ноль или меньше, ожидание никогда не закончится.
show_clicksbool, по умолчанию: True: Если True, показывать красный крест в месте каждого щелчка.
mouse_addMouseButton или None, по умолчанию: MouseButton.LEFT: Кнопка мыши, используемая для добавления точек.
mouse_popMouseButton или None, по умолчанию: MouseButton.RIGHT: Кнопка мыши, используемая для удаления последней добавленной точки.
mouse_stopMouseButton или None, по умолчанию: MouseButton.MIDDLE: Кнопка мыши, используемая для остановки ввода.

Возвращает

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

Примечания

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

have_units()[source]: Возвращает, установлены ли единицы на любой оси.

is_transform_set()[source]

Возвращает, есть ли у элемента явно заданное преобразование.

Это True после вызова set_transform.

legend(*args, **kwargs)[source]

Размещение легенды на рисунке.

Вызовы:

legend()
legend(handles, labels)
legend(handles=handles)
legend(labels)

Вызовы соответствуют различным способам использования этого метода:

1. Автоматическое определение элементов, которые должны быть отображены в легенде

Элементы, которые необходимо добавить в легенду, автоматически определяются, если не переданы дополнительные аргументы.

В этом случае метки берутся из объекта графического элемента. Вы можете указать их при создании объекта или вызвав метод set_label() для объекта:

ax.plot([1, 2, 3], label='Inline label')
fig.legend()

или:

line, = ax.plot([1, 2, 3])
line.set_label('Label via method')
fig.legend()

Отдельные линии можно исключить из автоматического выбора элементов легенды, задав метку, начинающуюся с символа подчеркивания. Это значение по умолчанию для всех объектов графических элементов, поэтому вызов Figure.legend без аргументов и без ручного задания меток не приведет к отображению легенды.

2. Явное указание объектов графических элементов и меток в легенде

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

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])

3. Явное указание объектов графических элементов в легенде

Это аналогично пункту 2, но метки берутся из свойств меток объектов графических элементов. Пример:

line1, = ax1.plot([1, 2, 3], label='label1')
line2, = ax2.plot([1, 2, 3], label='label2')
fig.legend(handles=[line1, line2])

4. Присвоение меток существующим элементам графика

Не рекомендуется

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

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

fig, (ax1, ax2)  = plt.subplots(1, 2)
ax1.plot([1, 3, 5], color='blue')
ax2.plot([2, 4, 6], color='red')
fig.legend(['the blues', 'the reds'])

Параметры

handlesсписок Artist, необязательно

Список объектов графических элементов (линий, областей) для добавления в легенду. Используйте его вместе с labels, если вам нужен полный контроль над отображаемыми элементами в легенде, и автоматический механизм, описанный выше, недостаточен.

Длина списков handles и labels должна быть одинаковой в этом случае. Если они не равны, они усекаются до меньшей длины.

labelsсписок str, необязательно

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

Возвращает

Legend

Другие параметры

locstr или пара чисел с плавающей точкой, по умолчанию: rcParams["legend.loc"] (по умолчанию: 'best') ('best' для осей, 'верхний правый' для фигур)

Расположение легенды.

Строки 'upper left', 'upper right', 'lower left', 'lower right' размещают легенду в соответствующем углу осей/рисунка.

Строки 'upper center', 'lower center', 'center left', 'center right' размещают легенду в центре соответствующей стороны осей/рисунка.

Строка 'center' размещает легенду в центре осей/рисунка.

Строка 'best' размещает легенду в местоположении из девяти определённых ранее с минимальным перекрытием с другими отрисованными элементами. Этот вариант может быть довольно медленным для графиков с большим количеством данных; ваша скорость построения графиков может улучшиться, если вы укажете конкретное местоположение.

Местоположение также может быть 2-кортежем, задающим координаты левого нижнего угла легенды в координатах осей (в этом случае bbox_to_anchor будет проигнорирован).

Для обратной совместимости, 'center right' (но не другое местоположение) также может быть написано 'right', и каждое местоположение "строки" также может быть задано как числовое значение:

Строковое обозначение местоположения	Код местоположения
'best'	0
'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

bbox_to_anchorBboxBase, 2-кортеж или 4-кортеж чисел с плавающей точкой

Прямоугольник, используемый для позиционирования легенды совместно с loc. По умолчанию axes.bbox (если вызывается как метод для Axes.legend) или figure.bbox (если Figure.legend). Этот аргумент позволяет произвольно размещать легенду.

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

Если задаётся 4-кортеж или BboxBase, то он задаёт прямоугольник (x, y, width, height) , в котором размещается легенда. Чтобы поместить легенду в лучшее место в нижнем правом квадранте осей (или фигуры):

loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)

2-кортеж (x, y) помещает угол легенды, указанный loc, в x, y. Например, чтобы поместить верхний правый угол легенды в центр осей (или фигуры), можно использовать следующие ключевые слова:

loc='upper right', bbox_to_anchor=(0.5, 0.5)

ncolцелое число, по умолчанию: 1

Количество столбцов в легенде.

propNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта легенды. Если None (по умолчанию), будут использованы текущие matplotlib.rcParams.

fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

Размер шрифта легенды. Если значение является числом, размер будет абсолютным размером шрифта в пунктах. Строковые значения относительны к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не указан.

labelcolorстрока или список, по умолчанию: rcParams["legend.labelcolor"] (по умолчанию: 'None')

Цвет текста в легенде. Допустимая строка цвета (например, 'red'), или список строковых значений цвета. Цвет метки также может быть настроен для соответствия цвету линии или маркера, используя 'linecolor', 'markerfacecolor' (или 'mfc'), или 'markeredgecolor' (или 'mec').

Цвет метки можно задать глобально, используя rcParams["legend.labelcolor"] (по умолчанию: 'None'). Если None, используется rcParams["text.color"] (по умолчанию: 'black').

numpointsцелое число, по умолчанию: rcParams["legend.numpoints"] (по умолчанию: 1)

Количество точек маркера в легенде при создании записи легенды для Line2D (линии).

scatterpointsцелое число, по умолчанию: rcParams["legend.scatterpoints"] (по умолчанию: 1)

Количество точек маркера в легенде при создании записи легенды для PathCollection (графика рассеяния).

scatteryoffsetsитерируемый список чисел с плавающей точкой, по умолчанию: [0.375, 0.5, 0.3125]

Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды графика рассеяния. 0.0 — внизу текста легенды, 1.0 — вверху. Для отображения всех маркеров на одной высоте установите значение [0.5].

markerscaleчисло с плавающей точкой, по умолчанию: rcParams["legend.markerscale"] (по умолчанию: 1.0)

Относительный размер маркеров легенды по сравнению с первоначально нарисованными.

markerfirstбулево значение, по умолчанию: True

Если True, маркер легенды размещается слева от метки легенды. Если False, маркер легенды размещается справа от метки легенды.

frameonбулево значение, по умолчанию: rcParams["legend.frameon"] (по умолчанию: True)

Определяет, должна ли легенда отображаться на области (рамке).

fancyboxбулево значение, по умолчанию: rcParams["legend.fancybox"] (по умолчанию: True)

Определяет, должны ли быть включены закругленные углы вокруг FancyBboxPatch, что формирует фон легенды.

shadowбулево значение, по умолчанию: rcParams["legend.shadow"] (по умолчанию: False)

Определяет, нужно ли отображать тень за легендой.

framealphaчисло с плавающей точкой, по умолчанию: rcParams["legend.framealpha"] (по умолчанию: 0.8)

Альфа-прозрачность фона легенды. Если shadow активирован и framealpha равно None, значение по умолчанию игнорируется.

facecolor"inherit" или цвет, по умолчанию: rcParams["legend.facecolor"] (по умолчанию: 'inherit')

Цвет фона легенды. Если "inherit", используется rcParams["axes.facecolor"] (по умолчанию: 'white').

edgecolor"inherit" или цвет, по умолчанию: rcParams["legend.edgecolor"] (по умолчанию: '0.8')

Цвет границы области фона легенды. Если "inherit", используется rcParams["axes.edgecolor"] (по умолчанию: 'black').

mode{"expand", None}

Если mode установлено в "expand", легенда будет горизонтально расширена для заполнения области осей (или bbox_to_anchor, если он определяет размер легенды).

bbox_transformNone или matplotlib.transforms.Transform

Преобразование для прямоугольника (bbox_to_anchor). Для значения None (по умолчанию) будет использоваться преобразование осей transAxes.

titleстрока или None

Заголовок легенды. По умолчанию заголовок отсутствует (None).

title_fontpropertiesNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта заголовка легенды. Если None (по умолчанию), будет использован аргумент title_fontsize, если он присутствует; если title_fontsize также None, будет использован текущий rcParams["legend.title_fontsize"] (по умолчанию: None).

title_fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, по умолчанию: rcParams["legend.title_fontsize"] (по умолчанию: None)

Размер шрифта заголовка легенды. Примечание: это невозможно комбинировать с title_fontproperties. Если вы хотите установить размер шрифта вместе с другими свойствами шрифта, используйте параметр size в title_fontproperties.

borderpadчисло с плавающей точкой, по умолчанию: rcParams["legend.borderpad"] (по умолчанию: 0.4)

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

labelspacingчисло с плавающей точкой, по умолчанию: rcParams["legend.labelspacing"] (по умолчанию: 0.5)

Вертикальное расстояние между записями легенды, в единицах размера шрифта.

handlelengthчисло с плавающей точкой, по умолчанию: rcParams["legend.handlelength"] (по умолчанию: 2.0)

Длина дескрипторов легенды, в единицах размера шрифта.

handleheightчисло с плавающей точкой, по умолчанию: rcParams["legend.handleheight"] (по умолчанию: 0.7)

Высота дескрипторов легенды, в единицах размера шрифта.

handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8): Отступ между маркёром легенды и текстом в единицах размера шрифта.
borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5): Отступ между осями и границей легенды в единицах размера шрифта.
columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0): Отступ между столбцами в единицах размера шрифта.
handler_mapdict or None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет стандартную карту обработчиков, расположенную по адресу matplotlib.legend.Legend.get_legend_handler_map.

См. также

Axes.legend

Примечания

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

propertymouseover

Если это свойство установлено в True, элемент будет запрашиваться для получения пользовательской информации контекста, когда курсор мыши перемещается над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged()[source]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутренне при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент будет генерировать событие выбора, если mouseevent находится над элементом, и у элемента установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает, может ли элемент быть выбран.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств элемента.

remove()[source]

Удалить элемент из фигуры, если это возможно.

Эффект будет виден только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызов relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удаление обратного вызова по его идентификатору наблюдателя.

См. также

add_callback

savefig(fname, *, transparent=None, **kwargs)[source]

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

Вызов:

savefig(fname, *, dpi='figure', format=None, metadata=None,
        bbox_inches=None, pad_inches=0.1,
        facecolor='auto', edgecolor='auto',
        backend=None, **kwargs
       )

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

Параметры

fnamestr или путь или двоичный файл-подобный объект

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

Если установлен параметр format, он определяет формат вывода, и файл сохраняется как fname. Обратите внимание, что fname используется буквально, и не делается попытка согласовать расширение (если оно есть) fname с format, и не добавляется расширение.

Если параметр format не установлен, тогда формат определяется по расширению fname, если оно есть. Если параметр format не установлен, а у fname нет расширения, то файл сохраняется с rcParams["savefig.format"] (по умолчанию: 'png') и соответствующее расширение добавляется к fname.

Другие параметры

dpifloat или 'figure', по умолчанию: rcParams["savefig.dpi"] (по умолчанию: 'figure')

Разрешение в точках на дюйм. Если 'figure', используется значение dpi фигуры.

formatstr

Формат файла, например 'png', 'pdf', 'svg' и т.д. Поведение при отсутствии этого параметра документировано в fname.

metadatadict, необязательно

Ключ/значение для хранения в метаданных изображения. Поддерживаемые ключи и значения по умолчанию зависят от формата изображения и бэкэнда:

'png' с бэкэндом Agg: См. параметр metadata в print_png.
'pdf' с бэкэндом pdf: См. параметр metadata в PdfPages.
'svg' с бэкэндом svg: См. параметр metadata в print_svg.
'eps' и 'ps' с бэкэндом PS: Поддерживается только 'Creator'.

bbox_inchesstr или Bbox, по умолчанию: rcParams["savefig.bbox"] (по умолчанию: None)

Ограничивающая рамка в дюймах: сохраняется только заданная часть фигуры. Если 'tight', то попытаться определить ограничительную рамку фигуры.

pad_inchesfloat, по умолчанию: rcParams["savefig.pad_inches"] (по умолчанию: 0.1)

Количество отступов вокруг фигуры, когда bbox_inches равен 'tight'.

facecolorцвет или 'auto', по умолчанию: rcParams["savefig.facecolor"] (по умолчанию: 'auto')

Цвет заливки фигуры. Если 'auto', используется текущий цвет заливки фигуры.

edgecolorцвет или 'auto', по умолчанию: rcParams["savefig.edgecolor"] (по умолчанию: 'auto')

Цвет обводки фигуры. Если 'auto', используется текущий цвет обводки фигуры.

backendstr, необязательно

Использовать бэкэнд по умолчанию для рендеринга файла, например, чтобы рендерить файл png с бэкэндом "cairo" вместо по умолчанию "agg" или файл pdf с бэкэндом "pgf" вместо по умолчанию "pdf". Обратите внимание, что по умолчанию бэкэнд обычно достаточен. См. Встроенные бэкэнды для списка допустимых бэкэндов для каждого формата файла. Пользовательские бэкэнды могут быть указаны как "module://...".

orientation{'landscape', 'portrait'}

В настоящее время поддерживается только бэкэндом postscript.

papertypestr

Один из 'letter', 'legal', 'executive', 'ledger', 'a0' до 'a10', 'b0' до 'b10'. Поддерживается только для вывода в формате postscript.

transparentbool

Если True, все области Axes будут прозрачными; область Figure также будет прозрачной, если не указаны facecolor и/или edgecolor с помощью параметров kwargs.

Если False, не имеет эффекта, и цвет областей Axes и Figure не изменяется (за исключением области Figure, если указаны facecolor и/или edgecolor в качестве аргументов ключевых слов, в этом случае используются эти цвета).

Прозрачность этих областей будет восстановлена до их исходных значений по выходу из этой функции.

Это полезно, например, для отображения графика поверх цветного фона на веб-странице.

bbox_extra_artistsсписок Artist, необязательно

Список дополнительных элементов, которые будут учитываться при вычислении ограниченной рамки.

pil_kwargsdict, необязательно

Дополнительные ключевые аргументы, которые передаются в PIL.Image.Image.save при сохранении фигуры.

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, canvas=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, constrained_layout=<UNSET>, constrained_layout_pads=<UNSET>, dpi=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, figheight=<UNSET>, figwidth=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linewidth=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, size_inches=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, tight_layout=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Установка нескольких свойств сразу.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`animated`	bool
`canvas`	FigureCanvas
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`constrained_layout`	bool или dict или None
`constrained_layout_pads`	float, по умолчанию: `rcParams["figure.constrained_layout.w_pad"]` (по умолчанию: `0.04167`)
`dpi`	float
`edgecolor`	цвет
`facecolor`	цвет
`figheight`	float
`figure`	`Figure`
`figwidth`	float
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`linewidth`	число
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`rasterized`	bool
`size_inches`	(float, float) или float
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`tight_layout`	bool или dict с ключами "pad", "w_pad", "h_pad", "rect" или None
`transform`	`Transform`
`url`	строка
`visible`	bool
`zorder`	float

set_agg_filter(filter_func)[source]

Установить фильтр agg.

Parameters

filter_funccallable: Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3).

set_alpha(alpha)[source]

Устанавливает значение альфа-канала для смешивания - не поддерживается всеми бэкендами.

Параметры

alphaскаляр или None: alpha должен быть в диапазоне от 0 до 1 включительно.

set_animated(b)[source]

Устанавливает, предназначен ли объект для использования в анимации.

Если True, объект исключается из обычного рисования фигуры. Необходимо явно вызвать Figure.draw_artist / Axes.draw_artist на объекте. Этот подход используется для ускорения анимации с помощью кэширования.

См. также matplotlib.animation и Ускорение отрисовки с помощью кэширования.

Параметры

bbool

set_canvas(canvas)[source]

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

Параметры

canvasFigureCanvas

set_clip_box(clipbox)[source]

Устанавливает область обрезки объекта Bbox.

Параметры

clipboxBbox

set_clip_on(b)[source]

Устанавливает, используется ли объектом обрезка.

Если False, объекты будут видны за пределами осей, что может привести к непредсказуемым результатам.

Параметры

bbool

set_clip_path(path, transform=None)[source]

Устанавливает траекторию обрезки объекта.

Параметры

pathPatch или Path или TransformedPath или None: Траектория обрезки. Если задан Path, transform также должен быть предоставлен. Если None, ранее установленная траектория обрезки удаляется.
transformTransform, необязательно: Используется только в случае, если path является Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

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

По техническим причинам (поддержка set) также принимается кортеж (path, transform) в качестве единственного позиционного параметра.

set_constrained_layout(constrained)[source]

Устанавливает, используется ли constrained_layout при рисовании. Если None, используется значение rcParams["figure.constrained_layout.use"] (по умолчанию: False).

При указании словаря, содержащего ключи w_pad, h_pad, значения отступов constrained_layout будут переопределены. Эти отступы в дюймах и по умолчанию равны 3.0/72.0. w_pad - ширина отступа, h_pad - высота отступа.

См. Руководство по ограниченной компоновке.

Параметры

constrainedbool или dict или None

set_constrained_layout_pads(*, w_pad=None, h_pad=None, wspace=None, hspace=None)[source]

Устанавливает отступы для constrained_layout.

Подсказка: параметры можно передать из словаря, используя fig.set_constrained_layout(**pad_dict).

См. Руководство по ограниченной компоновке.

Параметры

w_padfloat, по умолчанию: rcParams["figure.constrained_layout.w_pad"] (по умолчанию: 0.04167): Отступ по ширине в дюймах. Это отступ вокруг осей, предназначенный для того, чтобы гарантировать достаточное пространство для хорошей визуализации шрифтов. По умолчанию 3 пункта = 0,04167 дюймов
h_padfloat, по умолчанию: rcParams["figure.constrained_layout.h_pad"] (по умолчанию: 0.04167): Отступ по высоте в дюймах. По умолчанию 3 пункта.
wspacefloat, по умолчанию: rcParams["figure.constrained_layout.wspace"] (по умолчанию: 0.02): Отступ по ширине между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается как w_pad + wspace.
hspacefloat, по умолчанию: rcParams["figure.constrained_layout.hspace"] (по умолчанию: 0.02): Отступ по высоте между подграфиками, выраженный как доля ширины подграфика. Общий отступ получается как h_pad + hspace.

set_dpi(val)[source]

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

Параметры

valfloat

set_edgecolor(color)[source]

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

Параметры

colorцвет

set_facecolor(color)[source]

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

Параметры

colorцвет

set_figheight(val, forward=True)[source]

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

Параметры

valfloat
forwardbool: См. set_size_inches.

См. также

matplotlib.figure.Figure.set_figwidth
matplotlib.figure.Figure.set_size_inches

set_figure(fig)[source]

Установить экземпляр Figure, к которому относится элемент.

Параметры

figFigure

set_figwidth(val, forward=True)[source]

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

Параметры

valfloat
forwardbool: См. set_size_inches.

См. также

matplotlib.figure.Figure.set_figheight
matplotlib.figure.Figure.set_size_inches

set_frameon(b)[source]

Установить видимость фонового элемента рисунка, т.е. отображать ли фон рисунка. Эквивалентно Figure.patch.set_visible().

Параметры

bbool

set_gid(gid)[source]

Установить идентификатор (группы) для элемента.

Параметры

gidstr

set_in_layout(in_layout)[source]

Установить, включать ли элемент в расчеты макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_label(s)[source]

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

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linewidth(linewidth)[source]

Установить толщину линии прямоугольника Figure.

Параметры

linewidthчисло

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_picker(picker)[source]

Определение поведения выбора элемента художника.

Параметры

pickerNone или bool или float или callable

Это может быть одно из следующих:

None: Выбор отключён для этого элемента (по умолчанию).
Булево значение: Если True, то выбор будет включён, и элемент будет генерировать событие выбора, если курсор мыши находится над элементом.
Число с плавающей точкой: Если picker — число, оно интерпретируется как допуск погрешности в точках, и элемент будет генерировать событие, если данные находятся в пределах погрешности от события мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может предоставить дополнительные данные для события выбора, например, индексы данных в пределах погрешности от события выбора
Функция: Если picker — вызываемая функция, это пользовательская функция, определяющая, попадает ли элемент под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если курсор мыши находится над элементом, верните hit=True и props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

set_rasterized(rasterized)[source]

Вынужденное растрирование (преобразование в битовое изображение) для векторной графики.

Растрирование не поддерживается всеми элементами. Если вы попытаетесь включить его для элемента, который его не поддерживает, команда не повлияет, и будет выведено предупреждение.

Это значение игнорируется для выходных данных на основе пикселей.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_size_inches(w, h=None, forward=True)[source]

Установка размера фигуры в дюймах.

Вызовы:

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

Параметры

w(float, float) или float: Ширина и высота в дюймах (если высота не задана отдельным аргументом) или ширина.
hfloat: Высота в дюймах.
forwardbool, по умолчанию: True: Если True, размер холста автоматически обновляется, например, вы можете изменить размер окна фигуры из командной строки.

См. также

matplotlib.figure.Figure.get_size_inches
matplotlib.figure.Figure.set_figwidth
matplotlib.figure.Figure.set_figheight

Примечания

Для преобразования из пикселей в дюймы разделите на Figure.dpi.

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установка параметров наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указан, фильтр наброска не будет применён.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, с помощью которого длина сжимается или расширяется (по умолчанию 16.0)

Backend PGF использует этот аргумент как seed для генератора случайных чисел, а не как описано выше. Использование одного и того же seed приводит к одному и тому же случайному виду.

set_snap(snap)[source]

Установка поведения привязки.

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

Привязка в настоящее время поддерживается только задними планами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязка вершин к ближайшему центру пикселей.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные сегменты, округлить до ближайшего центра пикселей.

set_tight_layout(tight)[source]

Установка того, вызывается ли tight_layout при отрисовке.

Параметры

tightbool или dict с ключами "pad", "w_pad", "h_pad", "rect" или None: Если bool, устанавливает, вызывать ли tight_layout при отрисовке. Если None, используйте rcParams["figure.autolayout"] (по умолчанию: False). Если dict, передайте его в качестве kwargs в tight_layout, переопределяя значения отступов по умолчанию.

set_transform(t)[source]

Установка преобразования художника.

Параметры

tTransform

set_url(url)[source]

Установка URL для элемента.

Параметры

urlstr

set_visible(b)[source]

Установить видимость объекта.

Параметры

bbool

set_zorder(level)[source]

Установить z-порядок для объекта. Объекты с меньшими значениями zorder рисуются первыми.

Параметры

levelfloat

show(warn=True)[source]

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

Если фигура не была создана с помощью figure, у неё не будет FigureManagerBase, и этот метод вызовет AttributeError.

Предупреждение

Это не управляет циклом событий GUI. Следовательно, фигура может быть отображена ненадолго или не отображаться вообще, если вы или ваша среда не управляете циклом событий.

Правильные случаи использования Figure.show включают выполнение этого из графического приложения или оболочки IPython.

Если вы работаете в чистой оболочке Python или выполняете скрипт Python без GUI, вы должны использовать matplotlib.pyplot.show вместо этого, который позаботится об управлении циклом событий за вас.

Параметры

warnbool, по умолчанию: True: Если True и мы не работаем в режиме headless (например, на Linux без установленного DISPLAY), выдать предупреждение при вызове на бэкенде без GUI.

свойствоstale: Является ли объект 'старым' и необходимо ли его перерисовать, чтобы вывод соответствовал внутреннему состоянию объекта.

свойствоsticky_edges

x и y списки прилипающих границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не будет добавлен — предел просмотра «прилипает» к краю. Типичный пример использования — гистограммы, где обычно ожидается отсутствие отступа на нижнем краю (0) гистограммы.

Кроме того, расширение отступа «натыкается» на прилипающие края и не может их пересечь. Например, если верхний предел данных составляет 1.0, верхний предел просмотра, вычисленный с помощью простого применения отступа, составляет 1.2, но есть прилипающий край в 1.1, то фактический верхний предел просмотра будет 1.1.

К этому атрибуту нельзя присваивать значения; однако, списки x и y можно изменять на месте по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)[source]

Добавить подфигуру к этой фигуре или подфигуре.

Подфигура имеет те же методы для работы с объектами, что и фигура, и логически такая же, как фигура, но не может сама себя выводить. См. Подфигуры фигуры.

Параметры

nrows, ncolsint, по умолчанию: 1: Количество строк/столбцов сетки подфигуры.
squeezebool, по умолчанию: True: Если True, лишние измерения из массива подфигур удаляются.
wspace, hspacefloat, по умолчанию: None: Количество ширины/высоты, зарезервированной для пространства между подфигурами, выраженное в долях средней ширины/высоты подфигуры. Если не задано, значения будут вычислены из фигуры или rcParams при необходимости.
width_ratiosarray-like длины ncols, необязательно: Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не задано, все столбцы будут иметь одинаковую ширину.
height_ratiosarray-like длины nrows, необязательно: Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не задано, все строки будут иметь одинаковую высоту.

subplot_mosaic(mosaic, *, sharex=False, sharey=False, subplot_kw=None, gridspec_kw=None, empty_sentinel='.')[source]

Создать макет осей на основе ASCII-искусства или вложенных списков.

Это вспомогательная функция для построения сложных макетов GridSpec визуально.

Примечание

Этот API является предварительной версией и может быть пересмотрен в будущем на основе отзывов первых пользователей.

Параметры

mosaicсписок списков из {хешируемых или вложенных} или строка

Визуальный макет того, как вы хотите расположить свои оси, помеченные как строки. Например

x = [['A panel', 'A panel', 'edge'],
     ['C panel', '.',       'edge']]

производит 4 оси:

'A панель', которая имеет высоту 1 строки и охватывает первые два столбца
'edge', которая имеет высоту 2 строки и расположена на правом краю
'C панель', которая имеет ширину 1 строка и 1 столбец в левом нижнем углу
пустое место шириной 1 строка и 1 столбец в правом нижнем углу

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

Если входной параметр является строкой, то она может быть многострочной строкой вида

'''
AAE
C.E
'''

где каждый символ - столбец, а каждая строка - строка. Или это может быть однострочная строка, где строки разделены ;:

'AB;CC'

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

sharex, shareybool, по умолчанию: False

Если True, ось x (sharex) или y (sharey) будет совмещена для всех подграфиков. В этом случае видимость меток делений и единицы осей ведут себя так же, как и для subplots. Если False, каждая ось x или y подграфика будет независимой.

subplot_kwdict, необязательно

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

gridspec_kwdict, необязательно

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

empty_sentinelобъект, необязательно

Элемент в макете, означающий «оставить это место пустым». По умолчанию '.'. Обратите внимание, что если макет является строкой, она обрабатывается с помощью inspect.cleandoc для удаления начальных пробелов, что может повлиять на использование пробелов в качестве пустого маркера.

Возвращает

dict[метка, ось]: Словарь, сопоставляющий метки объектам осей. Порядок осей слева направо и сверху вниз от их позиции в общем макете.

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)[source]

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

Эта обертка-утилита делает удобным создание общих макетов подграфиков в одном вызове.

Параметры

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

Количество строк/столбцов сетки подграфиков.

sharex, shareybool или {'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 отображаются только для подграфика первого столбца. Чтобы впоследствии включить метки делений других подграфиков, используйте tick_params.

Когда подграфики имеют общую ось с единицами, вызов Axis.set_units обновит каждую ось с новыми единицами.

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

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

subplot_kwdict, необязательно

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

gridspec_kwdict, необязательно

Возвращает

Axes или массив осей: Либо один объект Axes, либо массив объектов осей, если было создано более одного подграфика. Размеры возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

См. также

pyplot.subplots
Figure.add_subplot
pyplot.subplot

Примеры

# First create some toy data:
x = np.linspace(0, 2*np.pi, 400)
y = np.sin(x**2)

# Create a figure
plt.figure()

# Create a subplot
ax = fig.subplots()
ax.plot(x, y)
ax.set_title('Simple plot')

# Create two subplots and unpack the output array immediately
ax1, ax2 = fig.subplots(1, 2, sharey=True)
ax1.plot(x, y)
ax1.set_title('Sharing Y axis')
ax2.scatter(x, y)

# Create four polar Axes and access them through the returned array
axes = fig.subplots(2, 2, subplot_kw=dict(projection='polar'))
axes[0, 0].plot(x, y)
axes[1, 1].scatter(x, y)

# Share a X axis with each column of subplots
fig.subplots(2, 2, sharex='col')

# Share a Y axis with each row of subplots
fig.subplots(2, 2, sharey='row')

# Share both X and Y axes with all subplots
fig.subplots(2, 2, sharex='all', sharey='all')

# Note that this is the same as
fig.subplots(2, 2, sharex=True, sharey=True)

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

Настройка параметров макета подграфиков.

Неустановленные параметры остаются неизменными; начальные значения заданы rcParams["figure.subplot.[name]"].

Параметры

leftfloat, необязательно: Позиция левого края подграфиков, как доля ширины фигуры.
rightfloat, необязательно: Позиция правого края подграфиков, как доля ширины фигуры.
bottomfloat, необязательно: Позиция нижнего края подграфиков, как доля высоты фигуры.
topfloat, необязательно: Позиция верхнего края подграфиков, как доля высоты фигуры.
wspacefloat, необязательно: Ширина отступа между подграфиками, как доля средней ширины области Axes.
hspacefloat, необязательно: Высота отступа между подграфиками, как доля средней высоты области Axes.

suptitle(t, **kwargs)[source]

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

Параметры

tstr: Текст заголовка.
xfloat, по умолчанию: 0.5: Позиция x текста в координатах фигуры.
yfloat, по умолчанию: 0.98: Позиция y текста в координатах фигуры.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: top: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. Смотрите Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Начертание шрифта текста. Смотрите Text.set_weight для возможных значений.

Возвращает

text: Экземпляр Text заголовка.

Другие параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные параметры являются свойствами matplotlib.text.Text.

supxlabel(t, **kwargs)[source]

Добавление центральной подписи оси X к фигуре.

Параметры

tstr: Текст подписи оси X.
xfloat, по умолчанию: 0.5: Позиция x текста в координатах фигуры.
yfloat, по умолчанию: 0.01: Позиция y текста в координатах фигуры.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: bottom: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. Смотрите Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Начертание шрифта текста. Смотрите Text.set_weight для возможных значений.

Возвращает

text: Экземпляр Text подписи оси X.

Другие параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные параметры являются свойствами matplotlib.text.Text.

supylabel(t, **kwargs)[source]

Добавить центрированную подпись к фигуре.

Параметры

tstr: Текст подписи.
xfloat, по умолчанию: 0.02: Положение текста по оси x в координатах фигуры.
yfloat, по умолчанию: 0.5: Положение текста по оси y в координатах фигуры.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: left: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: center: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text подписи.

Другие параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если fontproperties задан, значения по умолчанию для размера и веса шрифта берутся из FontProperties по умолчанию. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные параметры являются свойствами matplotlib.text.Text.

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

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

Параметры

x, yfloat: Положение для размещения текста. По умолчанию, в координатах фигуры, числа в [0, 1]. Система координат может быть изменена с помощью ключевого слова transform.
sstr: Строка текста.
fontdictdict, необязательно: Словарь для переопределения свойств текста по умолчанию. Если не задан, значения по умолчанию определяются rcParams["font.*"]. Свойства, переданные как kwargs, переопределяют соответствующие, заданные в fontdict.

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

Text

Другие параметры

**kwargsText свойства

Другие параметры параметров, смешанных с прочими.

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`animated`	bool
`backgroundcolor`	цвет
`bbox`	словарь с свойствами для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`figure`	`Figure`
`fontfamily` или family	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или font или font_properties	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или size	float или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch` или stretch	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle` или style	{'normal', 'italic', 'oblique'}
`fontvariant` или variant	{'normal', 'small-caps'}
`fontweight` или weight	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	строка
`horizontalalignment` или ha	{'center', 'right', 'left'}
`in_layout`	bool
`label`	объект
`linespacing`	float (кратное размеру шрифта)
`math_fontfamily`	строка
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`position`	(float, float)
`rasterized`	bool
`rotation`	float или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	строка
`usetex`	bool или None
`verticalalignment` или va	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
`visible`	bool
`wrap`	bool
`x`	float

`y`	вещественное число
`zorder`	вещественное число

См. также

Axes.text
pyplot.text

tight_layout(*, pad=1.08, h_pad=None, w_pad=None, rect=None)[source]

Настройка отступов между и вокруг подграфиков.

Чтобы исключить элемент на оси Axes из вычисления границ, определяющей параметры подграфиков (например, легенду или аннотацию), установите a.set_in_layout(False) для этого элемента.

Параметры

padfloat, по умолчанию: 1.08: Отступ между краем фигуры и краями подграфиков, как доля размера шрифта.
h_pad, w_padfloat, по умолчанию: pad: Отступ (высота/ширина) между краями смежных подграфиков, как доля размера шрифта.
rectкортеж (left, bottom, right, top), по умолчанию: (0, 0, 1, 1): Прямоугольник в нормализованных координатах фигуры, в который поместится вся область подграфиков (включая подписи).

См. также

Figure.set_tight_layout
pyplot.tight_layout

update(props)[source]

Обновление свойств этого элемента из словаря props.

Параметры

propsсловарь

update_from(other)[source]: Копирование свойств из other в self.

waitforbuttonpress(timeout=- 1)[source]

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

Ожидание ввода пользователя и возвращение True, если была нажата клавиша, False, если была нажата кнопка мыши, и None, если вход не был получен в течение timeout секунд. Отрицательные значения отключают timeout.

zorder=0

classmatplotlib.figure.FigureBase(**kwargs)[source]

Базовый класс для figure.Figure и figure.SubFigure, содержащий методы для добавления элементов на график или подграфик, создания осей и т. п.

add_artist(artist, clip=False)[source]

Добавляет элемент Artist на график.

Обычно элементы добавляются к объектам осей с помощью Axes.add_artist; этот метод может использоваться в редких случаях, когда нужно добавить элементы непосредственно на график, а не на оси.

Параметры

artistArtist: Элемент для добавления на график. Если у добавленного элемента нет ранее заданного преобразования, его преобразование будет установлено в figure.transSubfigure.
clipbool, по умолчанию: False: Определяет, следует ли обрезать добавленный элемент с помощью области графика.

Возвращает

Artist: Добавленный элемент.

add_axes(*args, **kwargs)[source]

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

Варианты вызова:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)

Параметры

rectпоследовательность float: Размеры новой оси [левый, нижний, ширина, высота]. Все значения в долях ширины и высоты графика.
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional: Тип проекции Axes. str — имя пользовательской проекции, см. projections. По умолчанию None, соответствует проекции 'rectilinear'.
polarbool, по умолчанию: False: Если True, эквивалентно projection='polar'.
axes_classподкласс Axes, optional: Подкласс axes.Axes, который используется для создания экземпляра. Этот параметр несовместим с projection и polar. См. axisartist для примеров.
sharex, shareyAxes, optional: Участвовать в использовании одной и той же оси x или y с sharex и/или sharey. Ось будет иметь одинаковые пределы, метки и масштаб с осью совмещенных осей.
labelstr: Метка для возвращаемой оси.

Возвращает

Axes, или подкласс Axes: Возвращаемый класс оси зависит от используемой проекции. Это Axes, если используется прямолинейная проекция, и projections.polar.PolarAxes, если используется полярная проекция.

Другие параметры

**kwargs: Этот метод также принимает ключевые параметры для возвращаемого класса осей. Ключевые параметры для класса прямолинейных осей Axes можно найти в следующей таблице, но также могут быть и другие ключевые параметры, если используется другая проекция, см. фактический класс осей.

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float размером (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	логическое значение
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	логическое значение
`autoscalex_on`	логическое значение
`autoscaley_on`	логическое значение
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	логическое значение или 'line'
`box_aspect`	число или None
`clip_box`	`Bbox`
`clip_on`	логическое значение
`clip_path`	Объект Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	логическое значение
`gid`	строка
`in_layout`	логическое значение
`label`	объект
`navigate`	логическое значение
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемая функция
`position`	[левое, нижнее, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	число с плавающей точкой или None
`rasterized`	логическое значение
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	логическое значение или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	логическое значение
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(низ: число, верх: число)
`xmargin`	число, большее, чем -0,5
`xscale`	{"линейный", "логарифмический", "симлогический", "логит", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно

`ybound`	неизвестно
`ylabel`	строка
`ylim`	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
`ymargin`	число с плавающей точкой больше -0,5
`yscale`	{"линейный", "логарифмический", "симлогический", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

См. также

Figure.add_subplot
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примечания

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

Примеры

Некоторые простые примеры:

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

add_callback(func)[source]

Параметры

funcвызываемый объект

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызываемый Artist. Значения возврата могут существовать, но игнорируются.

Возвращает

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

См. также

remove_callback

add_gridspec(nrows=1, ncols=1, **kwargs)[source]

Возвращает GridSpec, у которого эта фигура является родительским элементом. Это позволяет сложную компоновку осей в фигуре.

Параметры

nrowsint, по умолчанию: 1: Количество строк в сетке.
ncolsint, по умолчанию: 1: Количество столбцов в сетке.

Возвращает

GridSpec

Другие параметры

**kwargs: Ключевые параметры передаются в GridSpec.

См. также

matplotlib.pyplot.subplots

Примеры

Добавление подграфика, который занимает две строки:

fig = plt.figure()
gs = fig.add_gridspec(2, 2)
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[1, 0])
# spans two rows:
ax3 = fig.add_subplot(gs[:, 1])

add_subfigure(subplotspec, **kwargs)[source]

Добавление SubFigure в фигуру как части компоновки подграфиков.

Параметры

subplotspecgridspec.SubplotSpec: Определяет область в родительской сетке, где будет размещен подграфик.

Возвращает

figure.SubFigure

Другие параметры

**kwargs: Передаются в объект SubFigure.

См. также

Figure.subfigures

add_subplot(*args, **kwargs)[source]

Добавить Axes к рисунку в качестве части размещения поддиаграммы.

Варианты вызова:

add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()

Параметры

*argsint, (int, int, index), или SubplotSpec, по умолчанию: (1, 1, 1)

Положение поддиаграммы, заданное одним из:

Тремя целыми числами (nrows, ncols, index). Поддиаграмма займёт позицию index на сетке с nrows строками и ncols столбцами. index начинается с 1 в верхнем левом углу и увеличивается вправо. index также может быть двумерной кортежем, задающим (first, last) индексы (с основанием 1 и включая last) поддиаграммы, например, fig.add_subplot(3, 1, (1, 2)) создаёт поддиаграмму, занимающую верхние 2/3 рисунка.
Трехзначное целое число. Цифры интерпретируются так, как если бы они были заданы по отдельности как три однозначных числа, т.е. fig.add_subplot(235) то же, что и fig.add_subplot(2, 3, 5). Обратите внимание, что это можно использовать только в случае, если поддиаграмм не более 9.
SubplotSpec.

В редких случаях add_subplot может вызываться с одним аргументом — экземпляром Axes поддиаграммы, уже созданным в текущем рисунке, но не в списке Axes рисунка.

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional

Тип проекции поддиаграммы (Axes). str — имя пользовательской проекции, см. projections. По умолчанию None соответствует проекции 'rectilinear'.

polarbool, default: False

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

axes_classподкласс Axes, optional

Подкласс axes.Axes, который подлежит созданию. Этот параметр несовместим с projection и polar. См. axisartist для примеров.

sharex, shareyAxes, optional

Поделиться осью x или y axis с sharex и/или sharey. Ось будет иметь те же пределы, метки и масштаб, что и ось совмещенной поддиаграммы.

labelstr

Метка для возвращаемой поддиаграммы.

Возвращает

axes.SubplotBase, или другой подкласс Axes: Axes поддиаграммы. Возвращаемый базовый класс Axes зависит от используемой проекции. Это Axes, если используется проекция rectilinear, и projections.polar.PolarAxes, если используется проекция polar. Возвращаемый Axes является тогда подклассом поддиаграммы базового класса.

Другие параметры

**kwargs: Этот метод также принимает ключевые аргументы для возвращаемого базового класса Axes; за исключением аргумента figure. Ключевые аргументы для прямолинейного базового класса Axes можно найти в следующей таблице, но также могут быть другие ключевые аргументы, если используется другая проекция.

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, а возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} или float
`autoscale_on`	bool
`autoscalex_on`	bool
`autoscaley_on`	bool
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	float или None
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	объект
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`position`	[левый, нижний, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	float или None
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`title`	str
`transform`	`Transform`
`url`	str
`visible`	bool
`xbound`	неизвестно
`xlabel`	str
`xlim`	(нижний: float, верхний: float)
`xmargin`	float больше, чем -0.5
`xscale`	{"линейный", "логарифмический", "симлогарифмический", "логит", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно

`ybound`	неизвестно
`ylabel`	строка
`ylim`	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
`ymargin`	число с плавающей точкой, больше -0,5
`yscale`	{"линейный", "логарифмический", "симлогирифмический", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

См. также

Figure.add_axes
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примеры

fig = plt.figure()

fig.add_subplot(231)
ax1 = fig.add_subplot(2, 3, 1)  # equivalent but more general

fig.add_subplot(232, frameon=False)  # subplot with no frame
fig.add_subplot(233, projection='polar')  # polar subplot
fig.add_subplot(234, sharex=ax1)  # subplot sharing x-axis with ax1
fig.add_subplot(235, facecolor="red")  # red subplot

ax1.remove()  # delete ax1 from the figure
fig.add_subplot(ax1)  # add ax1 back to the figure

align_labels(axs=None)[source]

Выравнивает метки x и y подграфиков в одном ряду или столбце подграфиков, если выравнивание меток происходит автоматически (т. е. положение метки не задано вручную).

Выравнивание сохраняется для событий отрисовки после вызова этой функции.

Параметры

axsсписок Axes: Необязательный список (или массив) Axes для выравнивания меток. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels

align_xlabels(axs=None)[source]

Выравнивает метки x подграфиков в одном столбце подграфиков, если выравнивание меток происходит автоматически (т. е. положение метки не задано вручную).

Выравнивание сохраняется для событий отрисовки после вызова этой функции.

Если метка находится внизу, она выравнивается с метками на осях, которые также имеют метку внизу и имеют тот же самый самый нижний ряд подграфиков. Если метка находится вверху, она выравнивается с метками на осях с тем же самым верхним рядом.

Параметры

axsсписок Axes: Необязательный список (или массив) Axes для выравнивания меток x. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels

Примечания

Предполагается, что axs взяты из одного и того же GridSpec, так что их позиции SubplotSpec соответствуют позициям на рисунке.

Примеры

Пример с повернутыми метками xtick:

fig, axs = plt.subplots(1, 2)
for tick in axs[0].get_xticklabels():
    tick.set_rotation(55)
axs[0].set_xlabel('XLabel 0')
axs[1].set_xlabel('XLabel 1')
fig.align_xlabels()

align_ylabels(axs=None)[source]

Выравнивает метки y подграфиков в одном столбце подграфиков, если выравнивание меток происходит автоматически (т. е. положение метки не задано вручную).

Выравнивание сохраняется для событий отрисовки после вызова этой функции.

Если метка слева, она выравнивается с метками на осях, которые также имеют метку слева и имеют тот же самый самый левый столбец подграфиков. Если метка справа, она выравнивается с метками на осях с тем же самым самым правым столбцом.

Параметры

axsсписок Axes: Необязательный список (или массив) Axes для выравнивания меток y. По умолчанию выравниваются все оси на рисунке.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_labels

Примечания

Примеры

Пример с большими метками yticks:

fig, axs = plt.subplots(2, 1)
axs[0].plot(np.arange(0, 1000, 50))
axs[0].set_ylabel('YLabel 0')
axs[1].set_ylabel('YLabel 1')
fig.align_ylabels()

autofmt_xdate(bottom=0.2, rotation=30, ha='right', which='major')[source]

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

Parameters

bottomfloat, по умолчанию: 0.2: Нижняя граница подграфиков для subplots_adjust.
rotationfloat, по умолчанию: 30 градусов: Угол поворота меток на оси x в градусах.
ha{'left', 'center', 'right'}, по умолчанию: 'right': Горизонтальное выравнивание меток на оси x.
which{'major', 'minor', 'both'}, по умолчанию: 'major': Выбирает, какие метки поворачивать.

propertyaxes: Экземпляр Axes, в котором находится элемент графика, или None.

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

Добавить цветковую шкалу к графику.

Параметры

mappable

Объект matplotlib.cm.ScalarMappable (например, AxesImage, ContourSet и т.д.), к которому относится эта цветовая шкала. Этот параметр обязателен для метода Figure.colorbar, но необязателен для функции pyplot.colorbar, которая устанавливает текущее изображение по умолчанию.

Обратите внимание, что можно создать ScalarMappable «на лету» для создания цветовых шкал, не привязанных к ранее нарисованному элементу, например:

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)

caxAxes, необязательно

Ось, на которую будет нарисована цветовая шкала.

axAxes, список осей, необязательно

Одна или несколько родительских осей, из которых будет взято пространство для новой оси цветовой шкалы, если cax равно None. Это не имеет эффекта, если cax задан.

use_gridspecbool, необязательно

Если cax равно None, создается новая ось cax как экземпляр класса Axes. Если ax является экземпляром Subplot, а use_gridspec равно True, cax создается как экземпляр Subplot с использованием модуля gridspec.

Возвращает

colorbarColorbar

Примечания

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

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

locationNone или {'left', 'right', 'top', 'bottom'}: Положение, относительно родительской оси, где создается ось цветовой шкалы. Также определяет ориентацию цветовой шкалы (цветовые шкалы слева и справа вертикальные, цветовые шкалы сверху и снизу горизонтальные). Если None, положение будет взято из orientation, если оно установлено (вертикальные цветовые шкалы справа, горизонтальные снизу), или по умолчанию будет 'right', если orientation не установлено.
orientationNone или {'vertical', 'horizontal'}: Ориентация цветовой шкалы. Предпочтительно устанавливать location цветовой шкалы, так как это также определяет orientation; передача несовместимых значений для location и orientation вызовет исключение.
fractionfloat, по умолчанию: 0.15: Доля исходной оси, используемая для цветовой шкалы.
shrinkfloat, по умолчанию: 1.0: Доля, на которую нужно умножить размер цветовой шкалы.
aspectfloat, по умолчанию: 20: Соотношение длинных и коротких размеров.
padfloat, по умолчанию: 0.05 при вертикальной ориентации, 0.15 при горизонтальной: Доля исходной оси между цветовой шкалой и новой осью изображения.
anchor(float, float), необязательно: Точка привязки оси цветовой шкалы. По умолчанию (0.0, 0.5) при вертикальной ориентации; (0.5, 1.0) при горизонтальной.
panchor(float, float) или False, необязательно: Точка привязки родительской оси цветовой шкалы. Если False, точка привязки родительской оси останется без изменений. По умолчанию (1.0, 0.5) при вертикальной ориентации; (0.5, 0.0) при горизонтальной.

свойства цветовой шкалы:

Свойство	Описание
extend	{'neither', 'both', 'min', 'max'} Если не 'neither', создаются указательные концы для значений вне диапазона. Они задаются для данной цветовой карты с помощью методов colormap set_under и set_over.
extendfrac	{None, 'auto', length, lengths} Если установлено в None, как минимальные, так и максимальные треугольные расширения цветовой шкалы будут иметь длину 5% от длины внутренней цветовой шкалы (это значение по умолчанию). Если установлено в 'auto', делает треугольные расширения цветовой шкалы такими же, как внутренние прямоугольники (когда spacing установлено в 'uniform') или такими же, как соответствующие смежные внутренние прямоугольники (когда spacing установлено в 'proportional'). Если скаляр, указывает длину минимальных и максимальных треугольных расширений цветовой шкалы как долю длины внутренней цветовой шкалы. Также может быть задана последовательность из двух элементов, указывающая длину минимальных и максимальных расширений цветовой шкалы соответственно как долю длины внутренней цветовой шкалы.
extendrect	bool Если False, минимальные и максимальные расширения цветовой шкалы будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	{'uniform', 'proportional'} При равномерном распределении каждому дискретному цвету отводится одинаковое пространство; при пропорциональном распределении пространство пропорционально интервалу данных.
ticks	None или список тиков или Locator Если None, тики определяются автоматически из входных данных.
format	None или строка или Formatter Если None, используется `ScalarFormatter`. Если задана строка формата, например, '%.3f', используется она. Вместо нее можно указать альтернативный `Formatter`.
drawedges	bool Рисовать ли линии на границах цветов.
label	str Подпись на длинной оси цветовой шкалы.

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

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

Свойство

Описание

boundaries

None или последовательность

values

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

Если mappable — ContourSet, ее extend kwarg включается автоматически.

Параметр shrink предоставляет простой способ масштабирования цветовой шкалы относительно осей. Обратите внимание, что если указана cax, она определяет размер цветовой шкалы, и параметры shrink и aspect игнорируются.

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

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

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

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

contains(mouseevent)[source]

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

Возвращает

bool, {}

convert_xunits(x)[source]

Преобразует x с использованием типа единиц измерения оси x.

Если элемент не находится в пределах оси или у оси x нет единиц измерения, возвращается само x.

convert_yunits(y)[source]

Преобразовать y, используя тип единиц измерения оси y.

Если объект-графический элемент не находится внутри Axes или ось y не имеет единиц измерения, возвращается само значение y.

delaxes(ax)[source]: Удалить Axes ax из фигуры; обновить текущую ось.

draw(renderer)[source]

Отобразить элемент графика (и его дочерние элементы) с помощью заданного рендерера.

Это не имеет эффекта, если графический элемент не отображается (Artist.get_visible возвращает False).

Параметры

rendererRendererBase подкласс.

Примечания

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

findobj(match=None, include_self=True)[source]

Найти объекты элементов графика.

Рекурсивно найти все Artist экземпляры, содержащиеся в элементе графика.

Параметры

match

Критерий фильтра для сопоставлений. Может быть

None: Возвращает все объекты, содержащиеся в элементе графика.
Функция с сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только элементы графика, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только элементы графика этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки соответствия.

Возвращает

список Artist

format_cursor_data(data)[source]

Возвращает строковое представление data.

Примечание

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

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

См. также

get_cursor_data

propertyframeon: Возвращает видимость фоновой области фигуры, т.е. будет ли отображаться фон фигуры. Эквивалентно Figure.patch.get_visible().

gca(**kwargs)[source]

Получить текущую ось.

Если на этой фигуре нет оси, создается новая с помощью Figure.add_subplot. (Чтобы проверить, есть ли на фигуре ось, проверьте, пустой ли figure.axes. Чтобы проверить, есть ли в данный момент фигура на стеке фигур pyplot, проверьте, пустой ли pyplot.get_fignums().)

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

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} или float
`autoscale_on`	bool
`autoscalex_on`	bool
`autoscaley_on`	bool
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	float или None
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	объект
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемая функция
`position`	[левый, нижний, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	float или None
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`title`	str
`transform`	`Transform`
`url`	str
`visible`	bool
`xbound`	неизвестно
`xlabel`	str
`xlim`	(нижняя граница: float, верхняя граница: float)
`xmargin`	float, больше чем -0.5
`xscale`	{"линейный", "логарифмический", "симлогический", "логит", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	неизвестно

`ylabel`	строка
`ylim`	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
`ymargin`	число больше -0,5
`yscale`	{"линейный", "логарифмический", "симлогический", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

get_agg_filter()[source]: Возвращает функцию фильтра для использования с фильтром agg.

get_alpha()[source]: Возвращает значение альфа для смешивания — не поддерживается во всех бэкендах.

get_animated()[source]: Возвращает, анимирован ли элемент.

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

get_clip_box()[source]: Возвращает прямоугольник обрезки.

get_clip_on()[source]: Возвращает, использует ли элемент обрезку.

get_clip_path()[source]: Возвращает путь обрезки.

get_cursor_data(event)[source]

Возвращает данные указателя для данного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Вероятно, конечный пользователь Matplotlib не будет вызывать этот метод самостоятельно.

Данные указателя могут использоваться элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Единственное текущее применение — отображение значения z изображения AxesImage в строке состояния окна графика при перемещении мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

get_edgecolor()[source]: Получить цвет границы прямоугольника фигуры.

get_facecolor()[source]: Получить цвет заливки прямоугольника фигуры.

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_frameon()[source]: Возвращает видимость фонового элемента фигуры, т.е. будет ли отрисован фон фигуры. Эквивалентно Figure.patch.get_visible().

get_gid()[source]: Возвращает идентификатор группы.

get_in_layout()[source]

Возвращает логическое значение, True если элемент включён в вычисления макета.

Например, Руководство по ограниченным макетам, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linewidth()[source]: Получить ширину линии прямоугольника Figure.

get_path_effects()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_rasterized()[source]: Возвращает, нужно ли растрировать элемент.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, с которым длина сжимается или расширяется.

Возвращает None, если параметры наброска не были установлены.

get_snap()[source]

Возвращает параметр привязки.

Подробности см. в set_snap.

get_tightbbox(renderer, bbox_extra_artists=None)[source]

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

Обратите внимание, что FigureBase отличается от всех других элементов, которые возвращают свои Bbox в пикселях.

Элементы, которые имеют artist.set_in_layout(False) не включаются в прямоугольник.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())
bbox_extra_artistsсписок Artist или None: Список элементов для включения в ограничивающую рамку. Если None (по умолчанию), то все дочерние элементы каждого Axes включаются в ограничивающую рамку.

Возвращает

BboxBase: содержащий ограничивающую рамку (в дюймах фигуры).

get_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[source]: Возвращает область обрезки с примененной неаффинной частью ее преобразования и оставшейся аффинной частью ее преобразования.

get_url()[source]: Возвращает URL.

get_visible()[source]: Возвращает видимость.

get_window_extent(*args, **kwargs)[source]

Получить ограничивающую рамку элемента в пространстве отображения.

Ширина и высота ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в расчет "тесной" ограничивающей рамки. По умолчанию возвращается пустая ограничивающая рамка в 0, 0.

Будьте осторожны при использовании этой функции, результаты не будут обновляться, если область видимости окна элемента изменится. Область видимости может измениться из-за любых изменений в стеке преобразований, например, изменения пределов осей, размера фигуры или используемого холста (как это делается при сохранении фигуры). Это может привести к неожиданному поведению, когда интерактивные фигуры будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder()[source]: Возвращает порядок z элемента.

have_units()[source]: Возвращает, установлены ли единицы на любой оси.

is_transform_set()[source]

Возвращает, есть ли у элемента явно установленное преобразование.

Это True после вызова set_transform.

legend(*args, **kwargs)[source]

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

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

legend()
legend(handles, labels)
legend(handles=handles)
legend(labels)

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

1. Автоматическое определение элементов для отображения в легенде

Элементы, которые должны быть добавлены в легенду, автоматически определяются, если вы не передаёте дополнительных аргументов.

В этом случае метки берутся из элемента-графического объекта. Вы можете указать их при создании графического объекта или вызвав метод set_label() для графического объекта:

ax.plot([1, 2, 3], label='Inline label')
fig.legend()

или:

line, = ax.plot([1, 2, 3])
line.set_label('Label via method')
fig.legend()

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

2. Явное указание графических объектов и меток в легенде

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

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])

3. Явное указание графических объектов в легенде

Это аналогично пункту 2, но метки берутся из свойств меток графических объектов. Пример:

line1, = ax1.plot([1, 2, 3], label='label1')
line2, = ax2.plot([1, 2, 3], label='label2')
fig.legend(handles=[line1, line2])

4. Подпись существующих элементов графика

Не рекомендуется

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

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

fig, (ax1, ax2)  = plt.subplots(1, 2)
ax1.plot([1, 3, 5], color='blue')
ax2.plot([2, 4, 6], color='red')
fig.legend(['the blues', 'the reds'])

Параметры

handlesсписок Artist, необязательно

Список графических объектов (линий, областей) для добавления в легенду. Используйте это вместе с labels, если вам нужно полное управление тем, что отображается в легенде, и автоматический механизм, описанный выше, недостаточен.

Длина handles и labels должна быть одинаковой в этом случае. Если они не одинаковы, они усекаются до меньшей длины.

labelsсписок str, необязательно

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

Возвращает

Legend

Другие параметры

locстрока или пара чисел с плавающей точкой, по умолчанию: rcParams["legend.loc"] (по умолчанию: 'best') ('лучшее' для осей, 'верхний правый' для фигур)

Расположение легенды.

Строки 'upper left', 'upper right', 'lower left', 'lower right' размещают легенду в соответствующем углу осей/рисунка.

Строки 'upper center', 'lower center', 'center left', 'center right' размещают легенду в центре соответствующего края осей/рисунка.

Строка 'center' размещает легенду в центре осей/рисунка.

Строка 'best' размещает легенду в месте, среди девяти определенных ранее мест, с минимальным перекрытием с другими отрисованными элементами. Этот вариант может быть довольно медленным для графиков с большим объемом данных; ваша скорость построения графиков может улучшиться, если вы укажете конкретное местоположение.

Расположение также может быть 2-кортежем, содержащим координаты левого нижнего угла легенды в координатах осей (в этом случае bbox_to_anchor будет проигнорирован).

Для обратной совместимости, 'center right' (но не другие расположения) также может быть написано 'right', и каждое расположение "строки" также может быть задано как числовое значение:

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

bbox_to_anchorBboxBase, 2-кортеж или 4-кортеж чисел с плавающей точкой

Прямоугольник, используемый для позиционирования легенды совместно с loc. По умолчанию axes.bbox (если вызов как метод Axes.legend) или figure.bbox (если Figure.legend). Этот аргумент позволяет произвольное размещение легенды.

Координаты прямоугольника интерпретируются в системе координат, заданной bbox_transform, по умолчанию координаты осей или координаты фигуры, в зависимости от того, какой legend вызывается.

Если задан 4-кортеж или BboxBase, то он задает прямоугольник (x, y, width, height) в который помещается легенда. Чтобы поместить легенду в лучшее место в правом нижнем квадранте осей (или фигуры):

loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)

2-кортеж (x, y) помещает угол легенды, указанный loc, в x, y. Например, чтобы поместить верхний правый угол легенды в центр осей (или фигуры) можно использовать следующие ключевые слова:

loc='upper right', bbox_to_anchor=(0.5, 0.5)

ncolцелое число, по умолчанию: 1

Количество столбцов легенды.

propNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта легенды. Если None (по умолчанию), будут использованы текущие matplotlib.rcParams.

fontsizeцелое число или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

labelcolorстрока или список, по умолчанию: rcParams["legend.labelcolor"] (по умолчанию: 'None')

Цвет текста в легенде. Либо допустимая строка цвета (например, 'red'), либо список строк цвета. Цвет метки также можно сделать соответствующим цвету линии или маркера, используя 'linecolor', 'markerfacecolor' (или 'mfc'), или 'markeredgecolor' (или 'mec').

Цвет метки можно установить глобально, используя rcParams["legend.labelcolor"] (по умолчанию: 'None'). Если None, используется rcParams["text.color"] (по умолчанию: 'black').

numpointsцелое число, по умолчанию: rcParams["legend.numpoints"] (по умолчанию: 1)

Количество точек маркера в легенде при создании записи легенды для Line2D (линии).

scatterpointsцелое число, по умолчанию: rcParams["legend.scatterpoints"] (по умолчанию: 1)

Количество точек маркера в легенде при создании записи легенды для PathCollection (диаграммы рассеяния).

scatteryoffsetsитерируемый набор чисел с плавающей точкой, по умолчанию: [0.375, 0.5, 0.3125]

Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды диаграммы рассеяния. 0.0 — внизу текста легенды, а 1.0 — вверху. Чтобы все маркеры отображались на одной высоте, установите значение [0.5].

markerscaleчисло с плавающей точкой, по умолчанию: rcParams["legend.markerscale"] (по умолчанию: 1.0)

Относительный размер маркеров легенды по сравнению с первоначально нарисованными.

markerfirstбулево значение, по умолчанию: True

frameonбулево значение, по умолчанию: rcParams["legend.frameon"] (по умолчанию: True)

Определяет, должна ли легенда быть нарисована на области (рамке).

fancyboxбулево значение, по умолчанию: rcParams["legend.fancybox"] (по умолчанию: True)

Определяет, следует ли включить скругленные края вокруг FancyBboxPatch, который составляет фон легенды.

shadowбулево значение, по умолчанию: rcParams["legend.shadow"] (по умолчанию: False)

Определяет, следует ли рисовать тень за легендой.

framealphaчисло с плавающей точкой, по умолчанию: rcParams["legend.framealpha"] (по умолчанию: 0.8)

Альфа-прозрачность фона легенды. Если shadow включен и framealpha равен None, значение по умолчанию игнорируется.

facecolor"inherit" или цвет, по умолчанию: rcParams["legend.facecolor"] (по умолчанию: 'inherit')

Цвет фона легенды. Если "inherit", используется rcParams["axes.facecolor"] (по умолчанию: 'white').

edgecolor"inherit" или цвет, по умолчанию: rcParams["legend.edgecolor"] (по умолчанию: '0.8')

Цвет обводки области легенды. Если "inherit", используется rcParams["axes.edgecolor"] (по умолчанию: 'black').

mode{"expand", None}

Если mode установлен в "expand", легенда будет расширена по горизонтали, чтобы заполнить область осей (или bbox_to_anchor, если он определяет размер легенды).

bbox_transformNone или matplotlib.transforms.Transform

Преобразование для прямоугольника (bbox_to_anchor). Для значения None (по умолчанию) используется преобразование осей transAxes.

titleстрока или None

Заголовок легенды. По умолчанию заголовок отсутствует (None).

title_fontpropertiesNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта заголовка легенды. Если None (по умолчанию), используется аргумент title_fontsize, если он задан; если title_fontsize также None, используются текущие rcParams["legend.title_fontsize"] (по умолчанию: None).

Размер шрифта заголовка легенды. Примечание: Нельзя использовать совместно с title_fontproperties. Если вы хотите установить размер шрифта вместе с другими свойствами шрифта, используйте параметр size в title_fontproperties.

borderpadчисло с плавающей точкой, по умолчанию: rcParams["legend.borderpad"] (по умолчанию: 0.4)

Пространство внутри границы легенды, в единицах размера шрифта.

labelspacingчисло с плавающей точкой, по умолчанию: rcParams["legend.labelspacing"] (по умолчанию: 0.5)

Вертикальное расстояние между записями легенды, в единицах размера шрифта.

handlelengthчисло с плавающей точкой, по умолчанию: rcParams["legend.handlelength"] (по умолчанию: 2.0)

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

handleheightчисло с плавающей точкой, по умолчанию: rcParams["legend.handleheight"] (по умолчанию: 0.7)

Высота маркеров легенды, в единицах размера шрифта.
handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8): Отступ между маркером легенды и текстом, в единицах размера шрифта.
borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5): Отступ между осями и рамкой легенды, в единицах размера шрифта.
columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0): Интервал между столбцами, в единицах размера шрифта.
handler_mapdict or None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет стандартный словарь обработчиков, расположенный по адресу matplotlib.legend.Legend.get_legend_handler_map.

См. также

Axes.legend

Примечания

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

свойствоmouseover

Если это свойство установлено в True, элемент будет запрошен для получения пользовательской контекстной информации, когда курсор мыши перемещается над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged()[source]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент вызовет событие выбора, если mouseevent находится над элементом, и у элемента установлен picker.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает, можно ли выбрать элемент.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь всех свойств элемента.

remove()[source]

Удаляет элемент из фигуры, если это возможно.

Эффект будет виден только после перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Вызовите relim для обновления пределов осей, если это необходимо.

Примечание: relim не увидит коллекции, даже если коллекция была добавлена на ось с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента.

remove_callback(oid)[source]

Удаление обратного вызова по его идентификатору наблюдателя.

См. также

add_callback

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linewidth=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

Одновременная установка нескольких свойств.

Поддерживаемые свойства:

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3)
`alpha`	скаляр или None
`animated`	логическое значение
`clip_box`	`Bbox`
`clip_on`	логическое значение
`clip_path`	фигура или (путь, преобразование) или None
`edgecolor`	цвет
`facecolor`	цвет
`figure`	`Figure`
`frameon`	логическое значение
`gid`	строка
`in_layout`	логическое значение
`label`	объект
`linewidth`	число
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`rasterized`	логическое значение
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	логическое значение или None
`transform`	`Transform`
`url`	строка
`visible`	логическое значение
`zorder`	число с плавающей точкой

set_agg_filter(filter_func)[source]

Установка фильтра agg.

Параметры

filter_funcвызываемый объект: Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3).

set_alpha(alpha)[source]

Устанавливает значение альфа для смешивания — не поддерживается во всех бэкендах.

Параметры

alphaскаляр или None: alpha должен быть в диапазоне от 0 до 1 включительно.

set_animated(b)[source]

Устанавливает, предназначен ли графический элемент для использования в анимации.

Если True, графический элемент исключается из обычного рисования фигуры. Вы должны явно вызвать Figure.draw_artist / Axes.draw_artist для графического элемента. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Быстрое отображение с использованием blitting.

Параметры

bлогическое значение

set_clip_box(clipbox)[source]

Установить обрезку художника Bbox.

Параметры

clipboxBbox

set_clip_on(b)[source]

Установить, использует ли художник обрезку.

При значении False художники будут видны за пределами осей, что может привести к неожиданным результатам.

Параметры

bbool

set_clip_path(path, transform=None)[source]

Установить путь обрезки художника.

Параметры

pathPatch или Path или TransformedPath или None: Путь обрезки. Если задан Path, необходимо указать transform. Если None, ранее установленный путь обрезки удаляется.
transformTransform, необязательно: Используется только если path — Path, в этом случае заданный Path преобразуется в TransformedPath с помощью transform.

Примечания

Для повышения эффективности, если path — Rectangle, этот метод установит область обрезки соответствующему прямоугольнику и установит путь обрезки в None.

По техническим причинам (поддержка set) также принимается кортеж (path, transform).

set_edgecolor(color)[source]

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

Параметры

colorцвет

set_facecolor(color)[source]

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

Параметры

colorцвет

set_figure(fig)[source]

Установить экземпляр Figure, к которому принадлежит художник.

Параметры

figFigure

set_frameon(b)[source]

Установить видимость фонового патча фигуры, т.е. будет ли нарисован фон фигуры. Эквивалентно Figure.patch.set_visible().

Параметры

bbool

set_gid(gid)[source]

Установить идентификатор (группы) для художника.

Параметры

gidstr

set_in_layout(in_layout)[source]

Указать, будет ли художник включён в расчёт макета, например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_label(s)[source]

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

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linewidth(linewidth)[source]

Установить ширину линии прямоугольника Figure.

Параметры

linewidthчисло

set_path_effects(path_effects)[source]

Установите эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_picker(picker)[source]

Определите поведение выбора элемента.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующих:

None: Выбор отключен для этого элемента (по умолчанию).
Булево значение: если True, выбор будет включён, и элемент будет генерировать событие выбора, если указатель мыши находится над ним.
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск в точках, и элемент будет генерировать событие, если его данные находятся в пределах допуска от события указателя мыши. Для некоторых элементов, таких как линии и коллекции объектов, элемент может предоставлять дополнительные данные для события выбора, например, индексы данных, находящихся в пределах допуска от события выбора
Вызываемый объект: если picker — вызываемый объект, это пользовательская функция, определяющая, попадает ли элемент под указатель мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения проверки попадания. Если указатель мыши находится над элементом, возвращается hit=True, а props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

set_rasterized(rasterized)[source]

Принудительно растрировать (преобразовать в растровое изображение) отрисовку для векторной графики.

Это свойство игнорируется для пиксельного вывода.

См. также Растрирование для векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указан, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomnessfloat, необязательно

Множитель масштаба, по которому длина уменьшается или увеличивается (по умолчанию 16.0)

Backend PGF использует это значение как seed для генератора случайных чисел, а не как описано выше. Использование одного и того же seed приводит к одному и тому же случайному рисунку.

set_snap(snap)[source]

Установить поведение привязки.

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

Привязка в настоящее время поддерживается только бэкендами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязать вершины к центру ближайшего пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(t)[source]

Установить преобразование элемента.

Параметры

tTransform

set_url(url)[source]

Установить URL для элемента.

Параметры

urlstr

set_visible(b)[source]

Установить видимость элемента.

Параметры

bbool

set_zorder(level)[source]

Установить z-порядок элемента. Элементы с меньшими значениями z-порядка отрисовываются первыми.

Параметры

levelfloat

propertystale: Является ли элемент 'недействительным' и нуждается ли он в повторной отрисовке для соответствия внутреннему состоянию элемента.

propertysticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, тогда не будет добавлен никакой отступ — предел отображения «прилипает» к краю. Типичный пример — гистограммы, где обычно ожидается отсутствие отступа на нижней границе (0) гистограммы.

Кроме того, расширение отступа «натыкается» на привязанные края и не может их пересечь. Например, если верхний предел данных равен 1,0, а верхний предел отображения, вычисленный путём простого добавления отступа, равен 1,2, но существует привязанный край в 1,1, то фактический верхний предел отображения будет 1,1.

К этому атрибуту нельзя присваивать значения; однако, списки x и y можно изменять непосредственно по мере необходимости.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)[source]

Добавление подрисунка к этой фигуре или подрисунку.

Подрисунок имеет те же методы художника, что и фигура, и логически эквивалентен фигуре, но не может напечатать себя. См. Подрисунки фигур.

Параметры

nrows, ncolsint, по умолчанию: 1: Количество строк/столбцов сетки подрисунка.
squeezebool, по умолчанию: True: Если True, лишние измерения удаляются из возвращаемого массива подрисунков.
wspace, hspacefloat, по умолчанию: None: Количество ширины/высоты, отведенной для пробела между подрисунками, выраженное как доля от средней ширины/высоты подрисунка. Если не указано, значения будут вычислены из фигуры или rcParams при необходимости.
width_ratiosмассив-подобный длины ncols, необязательно: Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину.
height_ratiosмассив-подобный длины nrows, необязательно: Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту.

subplot_mosaic(mosaic, *, sharex=False, sharey=False, subplot_kw=None, gridspec_kw=None, empty_sentinel='.')[source]

Построение макета осей на основе ASCII-арта или вложенных списков.

Это вспомогательная функция для построения сложных макетов GridSpec визуально.

Примечание

Этот API предварительный и может быть пересмотрен в будущем на основе отзывов первых пользователей.

Параметры

mosaicсписок списков {хешируемых или вложенных} или строка

Визуальный макет того, как вы хотите расположить свои оси, помеченные строками. Например

x = [['A panel', 'A panel', 'edge'],
     ['C panel', '.',       'edge']]

производит 4 оси:

'A панель', которая имеет высоту 1 строка и охватывает первые два столбца
'edge', которая имеет высоту 2 строки и расположена на правом краю
'C панель', которая имеет ширину 1 строка и 1 столбец в левом нижнем углу
пустое место 1 строка и 1 столбец в правом нижнем углу

Любой из элементов в макете может быть списком списков той же формы для создания вложенных макетов.

Если вход — строка, то она может быть многострочной строкой вида

'''
AAE
C.E
'''

где каждый символ является столбцом, а каждая строка — строкой. Или это может быть строка из одной строки, где строки разделены ;:

'AB;CC'

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

sharex, shareybool, по умолчанию: False

Если True, ось x (sharex) или ось y (sharey) будут совмещены для всех подграфиков. В этом случае видимость меток делений и единицы осей ведут себя так же, как и для subplots. Если False, каждая ось x или y подграфика будет независимой.

subplot_kwdict, необязательно

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

gridspec_kwdict, необязательно

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

empty_sentinelобъект, необязательно

Элемент в макете, означающий «оставить это место пустым». По умолчанию '.'. Обратите внимание, если layout — строка, она обрабатывается с помощью inspect.cleandoc для удаления начальных пробелов, что может помешать использованию пробелов в качестве пустого индикатора.

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

dict[метка, ось]: Словарь, сопоставляющий метки объектам осей. Порядок осей слева направо и сверху вниз от их позиции в общем макете.

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)[source]

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

Этот утилитарный обертывающий метод упрощает создание общих макетов подграфиков в одном вызове.

Параметры

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

Количество строк/столбцов сетки подграфиков.

sharex, shareybool или {'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 отображаются только в первом подграфике столбца. Чтобы позже включить метки делений других подграфиков, используйте tick_params.

Когда подграфики имеют общую ось, имеющую единицы измерения, вызов Axis.set_units обновит каждую ось с новыми единицами.

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

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

subplot_kwdict, необязательно

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

gridspec_kwdict, необязательно

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

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

См. также

pyplot.subplots
Figure.add_subplot
pyplot.subplot

Примеры

# First create some toy data:
x = np.linspace(0, 2*np.pi, 400)
y = np.sin(x**2)

# Create a figure
plt.figure()

# Create a subplot
ax = fig.subplots()
ax.plot(x, y)
ax.set_title('Simple plot')

# Create two subplots and unpack the output array immediately
ax1, ax2 = fig.subplots(1, 2, sharey=True)
ax1.plot(x, y)
ax1.set_title('Sharing Y axis')
ax2.scatter(x, y)

# Create four polar Axes and access them through the returned array
axes = fig.subplots(2, 2, subplot_kw=dict(projection='polar'))
axes[0, 0].plot(x, y)
axes[1, 1].scatter(x, y)

# Share a X axis with each column of subplots
fig.subplots(2, 2, sharex='col')

# Share a Y axis with each row of subplots
fig.subplots(2, 2, sharey='row')

# Share both X and Y axes with all subplots
fig.subplots(2, 2, sharex='all', sharey='all')

# Note that this is the same as
fig.subplots(2, 2, sharex=True, sharey=True)

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

Настройка параметров макета подграфиков.

Неуказанные параметры остаются неизменными; начальные значения задаются rcParams["figure.subplot.[name]"].

Параметры

leftfloat, необязательно: Положение левого края подграфиков, в долях ширины рисунка.
rightfloat, необязательно: Положение правого края подграфиков, в долях ширины рисунка.
bottomfloat, необязательно: Положение нижнего края подграфиков, в долях высоты рисунка.
topfloat, необязательно: Положение верхнего края подграфиков, в долях высоты рисунка.
wspacefloat, необязательно: Ширина отступа между подграфиками, в долях средней ширины Axes.
hspacefloat, необязательно: Высота отступа между подграфиками, в долях средней высоты Axes.

suptitle(t, **kwargs)[source]

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

Параметры

tstr: Текст заголовка рисунка.
xfloat, по умолчанию: 0.5: Положение текста по оси x в координатах рисунка.
yfloat, по умолчанию: 0.98: Положение текста по оси y в координатах рисунка.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: top: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text заголовка рисунка.

Другие параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если fontproperties задан, значения по умолчанию для размера и веса шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные ключевые слова — свойства matplotlib.text.Text.

supxlabel(t, **kwargs)[source]

Добавить центрированную надпись над графиком.

Параметры

tstr: Текст надписи.
xfloat, по умолчанию: 0.5: Положение текста по оси x в координатах графика.
yfloat, по умолчанию: 0.01: Положение текста по оси y в координатах графика.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно точки (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: bottom: Вертикальное выравнивание текста относительно точки (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text надписи.

Дополнительные параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если указан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') в этом случае игнорируются.
**kwargs: Дополнительные параметры - свойства matplotlib.text.Text.

supylabel(t, **kwargs)[source]

Добавить центрированную надпись справа от графика.

Параметры

tstr: Текст надписи.
xfloat, по умолчанию: 0.02: Положение текста по оси x в координатах графика.
yfloat, по умолчанию: 0.5: Положение текста по оси y в координатах графика.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: left: Горизонтальное выравнивание текста относительно точки (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: center: Вертикальное выравнивание текста относительно точки (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text надписи.

Дополнительные параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если указан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') в этом случае игнорируются.
**kwargs: Дополнительные параметры - свойства matplotlib.text.Text.

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

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

Параметры

x, yfloat: Положение текста. По умолчанию в координатах графика, числа от 0 до 1. Систему координат можно изменить с помощью параметра transform.
sstr: Строка текста.
fontdictdict, необязательно: Словарь для переопределения свойств текста. Если не задан, используется значение по умолчанию, задаваемое rcParams["font.*"]. Свойства, переданные как kwargs, переопределяют соответствующие свойства, заданные в fontdict.

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

Text

Дополнительные параметры

**kwargsText свойства

Другие параметры текстовых параметров общего назначения.

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`animated`	bool
`backgroundcolor`	цвет
`bbox`	словарь с свойствами для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`figure`	`Figure`
`fontfamily` или family	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или font или font_properties	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или size	числовое значение или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch` или stretch	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle` или style	{'normal', 'italic', 'oblique'}
`fontvariant` или variant	{'normal', 'small-caps'}
`fontweight` или weight	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	str
`horizontalalignment` или ha	{'center', 'right', 'left'}
`in_layout`	bool
`label`	объект
`linespacing`	числовое значение (кратное размеру шрифта)
`math_fontfamily`	строка
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемый объект
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	bool
`rotation`	числовое значение или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	строка
`usetex`	bool или None
`verticalalignment` или va	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
`visible`	bool
`wrap`	bool
`x`	число с плавающей точкой

`y`	число с плавающей точкой
`zorder`	число с плавающей точкой

См. также

Axes.text
pyplot.text

update(props)[source]

Обновить свойства этого объекта от словаря props.

Параметры

propsdict

update_from(other)[source]: Скопировать свойства из other в self.

zorder=0

classmatplotlib.figure.SubFigure(parent, subplotspec, *, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, **kwargs)[source]

Логическая фигура, которая может быть размещена внутри фигуры.

Обычно создается с помощью Figure.add_subfigure или SubFigure.add_subfigure, или SubFigure.subfigures. Подфигура имеет те же методы, что и фигура, за исключением методов, тесно связанных с размером или разрешением фигуры, и ограничена заданной областью фигуры. Например, следующий код размещает две подфигуры рядом друг с другом:

fig = plt.figure()
sfigs = fig.subfigures(1, 2)
axsL = sfigs[0].subplots(1, 2)
axsR = sfigs[1].subplots(2, 1)

См. Подфигуры

Параметры

parentfigure.Figure или figure.SubFigure: Фигура или подфигура, содержащая подфигуру. Подфигуры могут быть вложены.
subplotspecgridspec.SubplotSpec: Определяет область в родительской сетке, где будет размещена подфигура.
facecolorпо умолчанию: rcParams["figure.facecolor"] (по умолчанию: 'white'): Цвет заливки области фигуры.
edgecolorпо умолчанию: rcParams["figure.edgecolor"] (по умолчанию: 'white'): Цвет границы области фигуры.
linewidthfloat: Ширина линии рамки (т.е. ширина линии границы области фигуры).
frameonbool, по умолчанию: rcParams["figure.frameon"] (по умолчанию: True): Если False, подавляет отрисовку области фона фигуры.

Другие параметры

**kwargsSubFigure свойства, необязательно

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`animated`	bool
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`edgecolor`	цвет
`facecolor`	цвет
`figure`	`Figure`
`frameon`	bool
`gid`	str
`in_layout`	bool
`label`	объект
`linewidth`	число
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`visible`	bool
`zorder`	float

add_artist(artist, clip=False)[source]

Добавить Artist к фигуре.

Обычно элементы добавляются в объекты Axes с помощью Axes.add_artist; этот метод может использоваться в редких случаях, когда нужно добавить элементы непосредственно в фигуру вместо этого.

Параметры

artistArtist: Элемент для добавления в фигуру. Если у добавленного элемента нет ранее установленного преобразования, его преобразование будет установлено в figure.transSubfigure.
clipbool, по умолчанию: False: Определяет, должен ли добавленный элемент быть обрезаем областью фигуры.

Возвращает

Artist: Добавленный элемент.

add_axes(*args, **kwargs)[source]

Добавление оси к фигуре.

Возможные варианты вызова:

add_axes(rect, projection=None, polar=False, **kwargs)
add_axes(ax)

Параметры

rectпоследовательность чисел с плавающей точкой: Размеры новой оси [левый, нижний, ширина, высота] в долях ширины и высоты фигуры.
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional: Тип проекции Axes. str — имя пользовательской проекции, см. projections. По умолчанию None, что соответствует проекции 'rectilinear'.
polarbool, по умолчанию: False: Если True, эквивалентно projection='polar'.
axes_classподкласс Axes, optional: Подкласс axes.Axes, который будет создан. Этот параметр несовместим с projection и polar. См. axisartist для примеров.
sharex, shareyAxes, optional: Общий x или y axis с sharex и/или sharey. Ось будет иметь те же пределы, метки и масштаб, что и ось у связанной оси.
labelstr: Метка возвращаемой оси.

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

Axes, или подкласс Axes: Возвращаемый класс оси зависит от используемой проекции. Это Axes при использовании проекции rectilinear и projections.polar.PolarAxes при использовании проекции polar.

Другие параметры

**kwargs: Этот метод также принимает ключевые аргументы для возвращаемого класса оси. Ключевые аргументы для класса оси rectilinear Axes можно найти в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция, см. фактический класс оси.

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(float, float) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} или float
`autoscale_on`	bool
`autoscalex_on`	bool
`autoscaley_on`	bool
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	float или None
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	str
`in_layout`	bool
`label`	объект
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`position`	[левый, нижний, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	float или None
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(нижняя граница: float, верхняя граница: float)
`xmargin`	float больше -0.5
`xscale`	{"linear", "log", "symlog", "logit", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно

`ybound`	неизвестно
`ylabel`	строка
`ylim`	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
`ymargin`	число с плавающей точкой, большее, чем -0,5
`yscale`	{"линейная", "логарифмическая", "симлогическая", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

См. также

Figure.add_subplot
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примечания

Примеры

Некоторые простые примеры:

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

add_callback(func)[source]

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

Параметры

funcвызываемый

Функция обратного вызова. Она должна иметь сигнатуру:

def func(artist: Artist) -> Any

где artist — вызывающий Artist. Значения возврата могут существовать, но игнорируются.

Возвращает

int: Идентификатор наблюдателя, связанный с обратным вызовом. Этот идентификатор может быть использован для удаления обратного вызова с помощью remove_callback позже.

См. также

remove_callback

add_gridspec(nrows=1, ncols=1, **kwargs)[source]

Возвращает GridSpec, у которого эта фигура является родителем. Это позволяет выполнять сложную компоновку осей в фигуре.

Параметры

nrowsint, по умолчанию: 1: Количество строк в сетке.
ncolsint, по умолчанию: 1: Количество столбцов в сетке.

Возвращает

GridSpec

Другие параметры

**kwargs: Ключевые аргументы передаются в GridSpec.

См. также

matplotlib.pyplot.subplots

Примеры

Добавление подграфика, который охватывает две строки:

fig = plt.figure()
gs = fig.add_gridspec(2, 2)
ax1 = fig.add_subplot(gs[0, 0])
ax2 = fig.add_subplot(gs[1, 0])
# spans two rows:
ax3 = fig.add_subplot(gs[:, 1])

add_subfigure(subplotspec, **kwargs)[source]

Добавляет SubFigure в фигуру как часть расположения подграфиков.

Параметры

subplotspecgridspec.SubplotSpec: Определяет область в родительской сетке, где будет размещен подграфик.

Возвращает

figure.SubFigure

Другие параметры

**kwargs: Передаются объекту SubFigure.

См. также

Figure.subfigures

add_subplot(*args, **kwargs)[source]

Добавить Axes на график в рамках размещения подграфиков.

Варианты вызова:

add_subplot(nrows, ncols, index, **kwargs)
add_subplot(pos, **kwargs)
add_subplot(ax)
add_subplot()

Параметры

*argsint, (int, int, index), или SubplotSpec, по умолчанию: (1, 1, 1)

Позиция подграфика, описанная одним из

Трех целых чисел (nrows, ncols, index). Подграфик займёт позицию index на сетке с nrows строками и ncols столбцами. index начинается с 1 в верхнем левом углу и увеличивается вправо. index также может быть двухобразным кортежем, определяющим (first, last) индексы (основанные на 1 и включающие last) подграфика, например, fig.add_subplot(3, 1, (1, 2)) создаёт подграфик, занимающий верхние 2/3 графика.
Трехзначное целое число. Цифры интерпретируются так, как если бы они были заданы отдельно как три однозначных целых числа, т.е. fig.add_subplot(235) равно fig.add_subplot(2, 3, 5). Обратите внимание, что это можно использовать только в случае, если подграфиков не более 9.
A SubplotSpec.

В редких случаях add_subplot может быть вызван с одним аргументом, экземпляром подграфика Axes, уже созданным в текущем графике, но не в списке Axes графика.

projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional

Тип проекции подграфика (Axes). str — имя пользовательской проекции, см. projections. По умолчанию None соответствует проекции 'rectilinear'.

polarbool, default: False

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

axes_classподкласс типа Axes, optional

Подкласс axes.Axes, который создаётся. Этот параметр несовместим с projection и polar. См. axisartist для примеров.

sharex, shareyAxes, optional

Использовать общую ось x или y с sharex и/или sharey. Ось будет иметь одинаковые пределы, деления и масштаб с осью общих осей.

labelstr

Метка для возвращаемых осей.

Возвращает

axes.SubplotBase, или другой подкласс Axes: Оси подграфика. Базовый класс возвращаемых осей зависит от используемой проекции. Это Axes, если используется проекция rectilinear, и projections.polar.PolarAxes, если используется проекция polar. Возвращаемые оси — это подкласс подграфиков базового класса.

Другие параметры

**kwargs: Этот метод также принимает ключевые аргументы для возвращаемого базового класса осей; кроме аргумента figure. Ключевые аргументы для прямолинейного базового класса Axes можно найти в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция.

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив (m, n, 3)
`alpha`	скаляр или None
`anchor`	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	булево значение
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	булево значение
`autoscalex_on`	булево значение
`autoscaley_on`	булево значение
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	булево значение или 'line'
`box_aspect`	число или None
`clip_box`	`Bbox`
`clip_on`	булево значение
`clip_path`	Объект Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	булево значение
`gid`	строка
`in_layout`	булево значение
`label`	объект
`navigate`	булево значение
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или булево значение или число с плавающей точкой или вызываемая функция
`position`	[левый, нижний, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	число с плавающей точкой или None
`rasterized`	булево значение
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	булево значение или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	булево значение
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(нижняя граница: число, верхняя граница: число)
`xmargin`	число, большее -0.5
`xscale`	{"линейный", "логарифмический", "симлогарифмический", "логит", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно

`ybound`	неизвестно
`ylabel`	строка
`ylim`	(нижняя: число с плавающей точкой, верхняя: число с плавающей точкой)
`ymargin`	число с плавающей точкой, большее -0,5
`yscale`	{"линейный", "логарифмический", "симлогирифмический", "логит", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	число с плавающей точкой

См. также

Figure.add_axes
pyplot.subplot
pyplot.axes
Figure.subplots
pyplot.subplots

Примеры

fig = plt.figure()

fig.add_subplot(231)
ax1 = fig.add_subplot(2, 3, 1)  # equivalent but more general

fig.add_subplot(232, frameon=False)  # subplot with no frame
fig.add_subplot(233, projection='polar')  # polar subplot
fig.add_subplot(234, sharex=ax1)  # subplot sharing x-axis with ax1
fig.add_subplot(235, facecolor="red")  # red subplot

ax1.remove()  # delete ax1 from the figure
fig.add_subplot(ax1)  # add ax1 back to the figure

align_labels(axs=None)[source]

Выравнивает метки оси x и y подграфиков с одинаковым рядом или столбцом подграфиков (соответственно), если выравнивание меток выполняется автоматически (т.е. позиция метки не установлена вручную).

Выравнивание сохраняется для событий рисования после вызова этой функции.

Параметры

axsсписок Axes: Необязательный список (или массив ndarray) Axes для выравнивания меток. По умолчанию все оси на рисунке выравниваются.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_ylabels

align_xlabels(axs=None)[source]

Выравнивает метки оси x подграфиков в том же столбце подграфиков, если выравнивание меток выполняется автоматически (т. е. позиция метки не задана вручную).

Выравнивание сохраняется для событий рисования после вызова этой функции.

Если метка находится внизу, она выравнивается с метками на осях, которые также имеют метку внизу и которые имеют тот же самый ряд подграфиков внизу. Если метка находится вверху, она выравнивается с метками на осях с тем же самым верхним рядом.

Параметры

axsсписок Axes: Необязательный список (или массив ndarray) Axes для выравнивания меток оси x. По умолчанию все оси на рисунке выравниваются.

См. также

matplotlib.figure.Figure.align_ylabels
matplotlib.figure.Figure.align_labels

Примечания

Примеры

Пример с повернутыми метками оси x:

fig, axs = plt.subplots(1, 2)
for tick in axs[0].get_xticklabels():
    tick.set_rotation(55)
axs[0].set_xlabel('XLabel 0')
axs[1].set_xlabel('XLabel 1')
fig.align_xlabels()

align_ylabels(axs=None)[source]

Выравнивает метки оси y подграфиков в том же столбце подграфиков, если выравнивание меток выполняется автоматически (т. е. позиция метки не задана вручную).

Выравнивание сохраняется для событий рисования после вызова этой функции.

Если метка слева, она выравнивается с метками на осях, которые также имеют метку слева и которые имеют тот же самый левый столбец подграфиков. Если метка справа, она выравнивается с метками на осях с тем же самым правым столбцом.

Параметры

axsсписок Axes: Необязательный список (или массив ndarray) Axes для выравнивания меток оси y. По умолчанию все оси на рисунке выравниваются.

См. также

matplotlib.figure.Figure.align_xlabels
matplotlib.figure.Figure.align_labels

Примечания

Примеры

Пример с большими метками оси y:

fig, axs = plt.subplots(2, 1)
axs[0].plot(np.arange(0, 1000, 50))
axs[0].set_ylabel('YLabel 0')
axs[1].set_ylabel('YLabel 1')
fig.align_ylabels()

autofmt_xdate(bottom=0.2, rotation=30, ha='right', which='major')[source]

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

Параметры

bottomfloat, значение по умолчанию: 0.2: Нижняя часть подграфиков для subplots_adjust.
rotationfloat, значение по умолчанию: 30 градусов: Угол поворота меток на оси x в градусах.
ha{'left', 'center', 'right'}, значение по умолчанию: 'right': Горизонтальное выравнивание меток на оси x.
which{'major', 'minor', 'both'}, значение по умолчанию: 'major': Выбирает, какие метки повернуть.

propertyaxes

Список осей Axes в SubFigure. Вы можете получить доступ к осям Axes и изменить их с помощью этого списка.

Не изменяйте сам список. Вместо этого используйте add_axes, add_subplot или delaxes для добавления или удаления оси Axes.

Примечание: Свойство SubFigure.axes и метод get_axes эквивалентны.

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

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

Параметры

mappable

matplotlib.cm.ScalarMappable (например, AxesImage, ContourSet и т.д.), описываемое этой цветовой шкалой. Этот аргумент является обязательным для метода Figure.colorbar, но необязательный для функции pyplot.colorbar, которая устанавливает значение по умолчанию для текущего изображения.

Обратите внимание, что можно создать ScalarMappable "на лету", чтобы создать цветовые шкалы, не привязанные к ранее нарисованному элементу, например:

fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)

caxAxes, необязательный

Оси, в которые будет нарисована цветовая шкала.

axAxes, список осей, необязательный

Одна или несколько родительских осей, от которых будет "отобран" пространство для новых осей цветовой шкалы, если cax равно None. Это не влияет, если cax задано.

use_gridspecbool, необязательный

Если cax None, новая ось cax создаётся как экземпляр оси. Если ax является экземпляром Subplot и use_gridspec True, cax создаётся как экземпляр Subplot с использованием модуля gridspec.

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

colorbarColorbar

Примечания

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

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

locationNone или {'left', 'right', 'top', 'bottom'}: Расположение относительно родительских осей, где создаются оси цветовой шкалы. Оно также определяет ориентацию цветовой шкалы (цветовые шкалы слева и справа вертикальные, сверху и снизу — горизонтальные). Если None, расположение будет взято из orientation, если оно установлено (вертикальные цветовые шкалы справа, горизонтальные — снизу), или по умолчанию будет 'right', если orientation не установлено.
orientationNone или {'vertical', 'horizontal'}: Ориентация цветовой шкалы. Предпочтительно установить location цветовой шкалы, так как это также определяет orientation; передача несовместимых значений для location и orientation вызовет исключение.
fractionfloat, по умолчанию: 0.15: Доля оригинальных осей, используемая для цветовой шкалы.
shrinkfloat, по умолчанию: 1.0: Доля, на которую нужно умножить размер цветовой шкалы.
aspectfloat, по умолчанию: 20: Соотношение длинных и коротких сторон.
padfloat, по умолчанию: 0.05 если вертикально, 0.15 если горизонтально: Доля оригинальных осей между цветовой шкалой и новыми осями изображения.
anchor(float, float), необязательный: Точка привязки осей цветовой шкалы. По умолчанию (0.0, 0.5) если вертикальная; (0.5, 1.0) если горизонтальная.
panchor(float, float), или False, необязательный: Точка привязки родительских осей цветовой шкалы. Если False, точка привязки родительских осей останется неизменной. По умолчанию (1.0, 0.5) если вертикальная; (0.5, 0.0) если горизонтальная.

свойства цветовой шкалы:

Свойство	Описание
extend	{'neither', 'both', 'min', 'max'} Если не 'neither', сделать острые концы для значений вне диапазона. Они устанавливаются для заданной цветовой схемы с помощью методов colormap set_under и set_over.
extendfrac	{None, 'auto', length, lengths} Если установлено None, как минимум, и как максимум, треугольные расширения цветовой шкалы будут иметь длину 5% от длины внутренней цветовой шкалы (это значение по умолчанию). Если установлено 'auto', треугольные расширения цветовой шкалы будут иметь те же длины, что и внутренние блоки (когда spacing установлено в 'uniform') или те же длины, что и соответствующие соседние внутренние блоки (когда spacing установлено в 'proportional'). Если скаляр, указывает длину как минимум, и как максимум, треугольных расширений цветовой шкалы как долю длины внутренней цветовой шкалы. Также можно задать двухэлементную последовательность дробей, указывающую длины расширений цветовой шкалы как минимум, и как максимум, соответственно, как долю длины внутренней цветовой шкалы.
extendrect	bool Если False, минимальные и максимальные расширения цветовой шкалы будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.
spacing	{'uniform', 'proportional'} Равномерное распределение даёт каждому дискретному цвету одинаковое пространство; пропорциональное делает пространство пропорциональным интервалу данных.
ticks	None или список меток или локеров. Если None, метки определяются автоматически из входных данных.
format	None или строка или Форматер. Если None, используется `ScalarFormatter`. Если задана строка формата, например, '%.3f', она используется. Вместо неё можно указать альтернативный `Formatter`.
drawedges	bool Рисовать ли линии на границах цветов.
label	строка Подпись по длинной оси цветовой шкалы.

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

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

Свойство

Описание

boundaries

None или последовательность

values

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

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

Аргумент shrink предоставляет простой способ масштабирования цветовой шкалы относительно осей. Обратите внимание, что если cax указан, он определяет размер цветовой шкалы, и аргументы shrink и aspect игнорируются.

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

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

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

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

contains(mouseevent)[source]

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

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

bool, {}

convert_xunits(x)[source]

Преобразование x с использованием типа единиц измерения оси x.

Если элемент не находится в Axes или если ось x не имеет единиц измерения, возвращается само x.

convert_yunits(y)[source]

Преобразовать y, используя тип единиц измерения оси y.

Если объект-графический элемент не находится в рамках Axes или ось y не имеет единиц измерения, возвращается само значение y.

delaxes(ax)[source]: Удалить Axes ax из фигуры; обновить текущую ось Axes.

propertydpi

draw(renderer)[source]

Отобразить графический элемент (и его дочерние элементы) с помощью данного рендерера.

Это не оказывает никакого влияния, если графический элемент не отображается (Artist.get_visible возвращает False).

Параметры

rendererRendererBase подкласс.

Примечания

Этот метод переопределяется в подклассах графических элементов.

findobj(match=None, include_self=True)[source]

Найти объекты графических элементов.

Рекурсивно найти все Artist экземпляры, содержащиеся в графическом элементе.

Параметры

match

Критерий фильтрации совпадений. Это может быть

None: Вернуть все объекты, содержащиеся в графическом элементе.
Функция со сигнатурой def match(artist: Artist) -> bool. Результат будет содержать только графические элементы, для которых функция возвращает True.
Экземпляр класса: например, Line2D. Результат будет содержать только графические элементы этого класса или его подклассов (проверка isinstance).

include_selfbool

Включить self в список для проверки соответствия.

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

список Artist

format_cursor_data(data)[source]

Возвращает строковое представление данных data.

Примечание

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

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

См. также

get_cursor_data

propertyframeon: Возвращает видимость фоновой области фигуры, т. е. будет ли отображаться фоновая область фигуры. Эквивалентно Figure.patch.get_visible().

gca(**kwargs)[source]

Получить текущую ось Axes.

Если на этой Figure в данный момент нет Axes, создаётся новая с использованием Figure.add_subplot. (Чтобы проверить, есть ли в данный момент Axes на Figure, проверьте, пуст ли figure.axes. Чтобы проверить, есть ли в данный момент Figure в стеке pyplot, проверьте, пуст ли pyplot.get_fignums().)

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

Свойство	Описание
`adjustable`	{'box', 'datalim'}
`agg_filter`	функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi и возвращает (m, n, 3) массив
`alpha`	скаляр или None
`anchor`	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	булево значение
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	булево значение
`autoscalex_on`	булево значение
`autoscaley_on`	булево значение
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	булево значение или 'line'
`box_aspect`	число или None
`clip_box`	`Bbox`
`clip_on`	булево значение
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	булево значение
`gid`	строка
`in_layout`	булево значение
`label`	объект
`navigate`	булево значение
`navigate_mode`	неизвестно
`path_effects`	`AbstractPathEffect`
`picker`	None или булево значение или число с плавающей точкой или вызываемая функция
`position`	[левый, нижний, ширина, высота] или `Bbox`
`prop_cycle`	неизвестно
`rasterization_zorder`	число с плавающей точкой или None
`rasterized`	булево значение
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	булево значение или None
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	булево значение
`xbound`	неизвестно
`xlabel`	строка
`xlim`	(нижний: число, верхний: число)
`xmargin`	число больше -0,5
`xscale`	{"линейный", "логарифмический", "симлогарифмический", "логит", ...} или `ScaleBase`
`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	неизвестно

`ylabel`	str
`ylim`	(нижняя граница: float, верхняя граница: float)
`ymargin`	float больше -0,5
`yscale`	{"линейная", "логарифмическая", "симлогическая", "логистическая", ...} или `ScaleBase`
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	float

get_agg_filter()[source]: Возвращает функцию фильтра для использования с agg фильтром.

get_alpha()[source]: Возвращает значение альфа-канала для смешивания (не поддерживается во всех бэкендах).

get_animated()[source]: Возвращает значение, указывающее, является ли элемент анимированным.

get_axes()[source]

Список осей в SubFigure. Вы можете получить доступ к осям и изменять их через этот список.

Не изменяйте сам список. Вместо этого используйте add_axes, add_subplot или delaxes для добавления или удаления оси.

Примечание: Свойство SubFigure.axes и метод get_axes эквивалентны.

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

get_clip_box()[source]: Возвращает область обрезки.

get_clip_on()[source]: Возвращает значение, указывающее, используется ли обрезка.

get_clip_path()[source]: Возвращает путь обрезки.

get_constrained_layout()[source]

Возвращает значение, указывающее, используется ли ограниченная компоновка.

См. Руководство по ограниченной компоновке.

get_constrained_layout_pads(relative=False)[source]

Получить отступы для constrained_layout.

Возвращает список отступов в дюймах и wspace и hspace в виде долей от подграфика.

См. Руководство по ограниченной компоновке.

Параметры

relativebool: Если True, то преобразовать из дюймов в относительные значения для графика.

get_cursor_data(event)[source]

Возвращает данные курсора для заданного события.

Примечание

Этот метод предназначен для переопределения подклассами элементов. Конечный пользователь Matplotlib, скорее всего, не вызовет этот метод самостоятельно.

Данные курсора могут быть использованы элементами для предоставления дополнительной контекстной информации для данного события. По умолчанию возвращается None.

Подклассы могут переопределять метод и возвращать произвольные данные. Однако при этом они должны гарантировать, что format_cursor_data может преобразовать данные в строковое представление.

Единственный текущий случай использования - отображение значения z AxesImage в строке состояния окна графика при перемещении курсора мыши.

Параметры

eventmatplotlib.backend_bases.MouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

get_edgecolor()[source]: Получить цвет границы прямоугольника графика.

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

get_figure()[source]: Возвращает экземпляр Figure, к которому принадлежит элемент.

get_frameon()[source]: Возвращает видимость фоновой области фигуры, т.е. будет ли отрисовываться фоновая область фигуры. Эквивалентно Figure.patch.get_visible().

get_gid()[source]: Возвращает идентификатор группы.

get_in_layout()[source]

Возвращает логический флаг, True если элемент включен в вычисления макета.

Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

get_label()[source]: Возвращает метку, используемую для этого элемента в легенде.

get_linewidth()[source]: Получить ширину линии прямоугольника Figure.

get_path_effects()[source]

get_picker()[source]

Возвращает поведение выбора элемента.

Возможные значения описаны в set_picker.

См. также

set_picker, pickable, pick

get_rasterized()[source]: Возвращает, должен ли элемент быть растрированным.

get_sketch_params()[source]

Возвращает параметры наброска для элемента.

Возвращает

кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебания перпендикулярно исходной линии.
length: Длина колебания вдоль линии.
randomness: Коэффициент масштабирования, по которому длина сжимается или расширяется.

Возвращает None, если параметры наброска не были заданы.

get_snap()[source]

Возвращает настройки привязки.

Подробности см. в set_snap.

get_tightbbox(renderer, bbox_extra_artists=None)[source]

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

Обратите внимание, что FigureBase отличается от всех других элементов, которые возвращают их Bbox в пикселях.

Элементы, у которых artist.set_in_layout(False) не включаются в область пересечения.

Параметры

rendererRendererBase подкласс: рендерер, который будет использоваться для отрисовки фигур (т.е. fig.canvas.get_renderer())
bbox_extra_artistsсписок Artist или None: Список элементов, которые нужно включить в уплотнённую область пересечения. Если None (по умолчанию), то все дочерние элементы каждого Axes включаются в уплотнённую область пересечения.

Возвращает

BboxBase: содержащую область пересечения (в дюймах фигуры).

get_transform()[source]: Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine()[source]: Возвращает обрезку пути с применённой не-аффинной частью преобразования и оставшейся аффинной частью преобразования.

get_url()[source]: Возвращает URL.

get_visible()[source]: Возвращает видимость.

get_window_extent(*args, **kwargs)[source]

Получить прямоугольник ограничивающей рамки элемента в пространстве отображения.

Ширина и высота прямоугольника ограничивающей рамки неотрицательны.

Подклассы должны переопределять для включения в вычисление прямоугольника ограничивающей рамки "плотно". По умолчанию возвращается пустой прямоугольник в точке 0, 0.

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

get_zorder()[source]: Возвращает порядок элемента по z.

have_units()[source]: Возвращает, установлены ли единицы на какой-либо оси.

is_transform_set()[source]

Возвращает, имеет ли элемент явно заданное преобразование.

Это True после вызова set_transform.

legend(*args, **kwargs)[source]

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

Подписи:

legend()
legend(handles, labels)
legend(handles=handles)
legend(labels)

Подписи соответствуют различным способам использования этого метода:

1. Автоматическое определение элементов, которые должны быть показаны в легенде

Элементы, которые должны быть добавлены в легенду, определяются автоматически, если вы не передаете дополнительных аргументов.

В этом случае метки берутся из элемента. Вы можете указать их либо при создании элемента, либо вызвав метод set_label() для элемента:

ax.plot([1, 2, 3], label='Inline label')
fig.legend()

или:

line, = ax.plot([1, 2, 3])
line.set_label('Label via method')
fig.legend()

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

2. Явное указание элементов и меток в легенде

Для полного управления элементами, имеющими запись в легенде, можно передать итерируемый список элементов легенды, за которым следует итерируемый список меток легенды соответственно:

fig.legend([line1, line2, line3], ['label1', 'label2', 'label3'])

3. Явное указание элементов в легенде

Это аналогично пункту 2, но метки берутся из свойств меток элементов. Пример:

line1, = ax1.plot([1, 2, 3], label='label1')
line2, = ax2.plot([1, 2, 3], label='label2')
fig.legend(handles=[line1, line2])

4. Подпись существующих элементов графика

Не рекомендуется

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

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

fig, (ax1, ax2)  = plt.subplots(1, 2)
ax1.plot([1, 3, 5], color='blue')
ax2.plot([2, 4, 6], color='red')
fig.legend(['the blues', 'the reds'])

Parameters

handleslist of Artist, optional

Список элементов (линий, областей) для добавления в легенду. Используйте это вместе с labels, если вам нужен полный контроль над тем, что отображается в легенде, и автоматический механизм, описанный выше, недостаточен.

Длина списков handles и labels должна быть одинаковой в этом случае. В противном случае они усекаются до меньшей длины.

labelslist of str, optional

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

Returns

Legend

Other Parameters

END_OF_DOCUMENT_MARKER

locstr или пара чисел с плавающей запятой, по умолчанию: rcParams["legend.loc"] (по умолчанию: 'best') ('best' для осей, 'верхний правый' для графиков)

Расположение легенды.

Строки 'upper left', 'upper right', 'lower left', 'lower right' помещают легенду в соответствующий угол осей/графика.

Строки 'upper center', 'lower center', 'center left', 'center right' помещают легенду в центр соответствующей стороны осей/графика.

Строка 'center' помещает легенду в центр осей/графика.

Строка 'best' помещает легенду в такое место из девяти определенных до сих пор, которое имеет минимальное пересечение с другими отрисованными элементами. Этот вариант может быть довольно медленным для графиков с большим количеством данных; скорость построения графиков может повыситься, если указать конкретное местоположение.

Для обратной совместимости, 'center right' (но не другие варианты расположения) также может быть записано как 'right', а каждое расположение, представленное "строкой", может быть также задано числовым значением:

Строка расположения	Код расположения
'best'	0
'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

bbox_to_anchorBboxBase, 2-кортеж или 4-кортеж чисел с плавающей запятой

Прямоугольник, используемый для позиционирования легенды в сочетании с loc. По умолчанию axes.bbox (если вызывается как метод для Axes.legend) или figure.bbox (если Figure.legend). Этот аргумент позволяет произвольно размещать легенду.

Координаты прямоугольника интерпретируются в системе координат, заданной bbox_transform, по умолчанию в координатах осей или графика, в зависимости от того, какой legend вызывается.

Если задан 4-кортеж или BboxBase, то он задаёт прямоугольник (x, y, width, height) , в котором размещается легенда. Чтобы поместить легенду в лучшее место в правом нижнем квадранте осей (или графика):

loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)

2-кортеж (x, y) помещает угол легенды, указанный loc, в координаты x, y. Например, чтобы разместить верхний правый угол легенды в центре осей (или графика), можно использовать следующие ключевые слова:

loc='upper right', bbox_to_anchor=(0.5, 0.5)

ncolint, по умолчанию: 1

Количество столбцов в легенде.

propNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта легенды. Если None (по умолчанию), будут использованы текущие matplotlib.rcParams.

fontsizeint или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}

Размер шрифта легенды. Если значение является числом, размер будет абсолютным размером шрифта в пунктах. Строковые значения относятся к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не указан.

labelcolorстрока или список, по умолчанию: rcParams["legend.labelcolor"] (по умолчанию: 'None')

Цвет текста в легенде. Допустимая строка цвета (например, 'red'), или список строк цветов. Цвет метки также может быть настроен для соответствия цвету линии или маркера с помощью 'linecolor', 'markerfacecolor' (или 'mfc'), или 'markeredgecolor' (или 'mec').

numpointsint, по умолчанию: rcParams["legend.numpoints"] (по умолчанию: 1)

Количество маркеров в легенде при создании элемента легенды для Line2D (линии).

scatterpointsint, по умолчанию: rcParams["legend.scatterpoints"] (по умолчанию: 1)

Количество маркеров в легенде при создании элемента легенды для PathCollection (диаграммы рассеяния).

scatteryoffsetsитерируемый объект плавающей запятой, по умолчанию: [0.375, 0.5, 0.3125]

Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для элемента легенды диаграммы рассеяния. 0.0 — в основании текста легенды, 1.0 — вверху. Чтобы отобразить все маркеры на одной высоте, установите в [0.5].

markerscalefloat, по умолчанию: rcParams["legend.markerscale"] (по умолчанию: 1.0)

Относительный размер маркеров легенды по сравнению с первоначально отрисованными.

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

frameonbool, по умолчанию: rcParams["legend.frameon"] (по умолчанию: True)

Определяет, должна ли легенда отображаться на области (рамке).

fancyboxbool, по умолчанию: rcParams["legend.fancybox"] (по умолчанию: True)

Определяет, должны ли быть закруглены углы вокруг FancyBboxPatch, образующего фон легенды.

shadowbool, по умолчанию: rcParams["legend.shadow"] (по умолчанию: False)

Определяет, нужно ли отображать тень за легендой.

framealphafloat, по умолчанию: rcParams["legend.framealpha"] (по умолчанию: 0.8)

Альфа-прозрачность фона легенды. Если shadow активировано и framealpha равно None, значение по умолчанию игнорируется.

facecolor"inherit" или цвет, по умолчанию: rcParams["legend.facecolor"] (по умолчанию: 'inherit')

Цвет фона легенды. Если "inherit", используется rcParams["axes.facecolor"] (по умолчанию: 'white').

edgecolor"inherit" или цвет, по умолчанию: rcParams["legend.edgecolor"] (по умолчанию: '0.8')

Цвет границы области фона легенды. Если "inherit", используется rcParams["axes.edgecolor"] (по умолчанию: 'black').

mode{"expand", None}

Если mode установлено в "expand", легенда будет расширена по горизонтали, чтобы заполнить область осей (или bbox_to_anchor, если определяет размер легенды).

bbox_transformNone или matplotlib.transforms.Transform

Преобразование для прямоугольника (bbox_to_anchor). Если значение равно None (по умолчанию), используется преобразование осей transAxes.

titleстрока или None

Заголовок легенды. По умолчанию заголовок отсутствует (None).

title_fontpropertiesNone или matplotlib.font_manager.FontProperties или словарь

Свойства шрифта заголовка легенды. Если None (по умолчанию), используется аргумент title_fontsize, если он присутствует; если и title_fontsize равен None, используются текущие rcParams["legend.title_fontsize"] (по умолчанию: None).

title_fontsizeint или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, по умолчанию: rcParams["legend.title_fontsize"] (по умолчанию: None)

Размер шрифта заголовка легенды. Примечание: не может быть использован вместе с title_fontproperties. Если вы хотите установить размер шрифта вместе с другими свойствами шрифта, используйте параметр size в title_fontproperties.

borderpadfloat, по умолчанию: rcParams["legend.borderpad"] (по умолчанию: 0.4)

Отступы внутри рамки легенды, в единицах размера шрифта.

labelspacingfloat, по умолчанию: rcParams["legend.labelspacing"] (по умолчанию: 0.5)

Вертикальное расстояние между элементами легенды, в единицах размера шрифта.

handlelengthfloat, по умолчанию: rcParams["legend.handlelength"] (по умолчанию: 2.0)

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

handleheightfloat, по умолчанию: rcParams["legend.handleheight"] (по умолчанию: 0.7)

Высота маркеров легенды в единицах размера шрифта.
handletextpadfloat, default: rcParams["legend.handletextpad"] (default: 0.8): Отступ между маркером легенды и текстом в единицах размера шрифта.
borderaxespadfloat, default: rcParams["legend.borderaxespad"] (default: 0.5): Отступ между осями и рамкой легенды в единицах размера шрифта.
columnspacingfloat, default: rcParams["legend.columnspacing"] (default: 2.0): Расстояние между столбцами в единицах размера шрифта.
handler_mapdict or None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет стандартный словарь обработчиков по адресу matplotlib.legend.Legend.get_legend_handler_map.

См. также

Axes.legend

Примечания

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

свойствоmouseover

Если это свойство установлено в True, к элементу управления будет обращаться за пользовательскими данными контекста при перемещении курсора мыши над ним.

См. также get_cursor_data(), ToolCursorPosition и NavigationToolbar2.

pchanged()[source]

Вызов всех зарегистрированных обратных вызовов.

Эта функция вызывается внутри при изменении свойства.

См. также

add_callback
remove_callback

pick(mouseevent)[source]

Обработка события выбора.

Каждый дочерний элемент управления сгенерирует событие выбора, если mouseevent находится над элементом управления и у элемента управления установлен параметр picker.

См. также

set_picker, get_picker, pickable

pickable()[source]

Возвращает, является ли элемент управления выбираемым.

См. также

set_picker, get_picker, pick

properties()[source]: Возвращает словарь со всеми свойствами элемента управления.

remove()[source]

Удаляет элемент управления из фигуры, если это возможно.

Эффект не будет виден до перерисовки фигуры, например, с помощью FigureCanvasBase.draw_idle. Для обновления пределов осей используйте relim.

Примечание: relim не видит коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: нет поддержки удаления записи легенды элемента управления.

remove_callback(oid)[source]

Удаление обратного вызова по его идентификатору наблюдателя.

См. также

add_callback

sca(a)[source]: Устанавливает текущую ось a и возвращает a.

Установка нескольких свойств сразу.

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

Свойство	Описание
`agg_filter`	Функция фильтра, принимающая массив float (m, n, 3) и значение dpi, и возвращающая массив float (m, n, 3).
`alpha`	скаляр или None
`animated`	bool
`clip_box`	`Bbox`
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`edgecolor`	цвет
`facecolor`	цвет
`figure`	`Figure`
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`linewidth`	число
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или float или вызываемая функция
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`transform`	`Transform`
`url`	строка
`visible`	bool
`zorder`	float

set_agg_filter(filter_func)[source]

Установка фильтра agg.

Параметры

filter_funcвызываемая функция: Функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3).

set_alpha(alpha)[source]

Установка значения альфа для смешивания - не поддерживается на всех бэкендах.

Параметры

alphaскаляр или None: alpha должен быть в диапазоне от 0 до 1 включительно.

set_animated(b)[source]

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

Если True, художник исключается из обычного отрисовки фигуры. Вам необходимо явно вызвать Figure.draw_artist / Axes.draw_artist на художнике. Этот подход используется для ускорения анимации с помощью blitting.

См. также matplotlib.animation и Более быстрое отображение с использованием blitting.

Параметры

bbool

set_clip_box(clipbox)[source]

Установите область обрезки для элемента.

Параметры

clipboxBbox

set_clip_on(b)[source]

Установите, используется ли обрезка для элемента.

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

Параметры

bbool

set_clip_path(path, transform=None)[source]

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

Параметры

pathPatch или Path или TransformedPath или None: Путь обрезки. Если указан Path, transform должен быть указан. Если None, ранее установленный путь обрезки удаляется.
transformTransform, необязательно: Используется только если path является Path, в этом случае заданный Path преобразуется в TransformedPath с использованием transform.

Примечания

Для повышения эффективности, если path является Rectangle, этот метод установит область обрезки на соответствующий прямоугольник и установит путь обрезки на None.

По техническим причинам (поддержка set), кортеж (path, transform) также принимается как единственный позиционный параметр.

set_edgecolor(color)[source]

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

Параметры

colorцвет

set_facecolor(color)[source]

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

Параметры

colorцвет

set_figure(fig)[source]

Установить экземпляр Figure, к которому принадлежит элемент.

Параметры

figFigure

set_frameon(b)[source]

Установить видимость фонового патча фигуры, то есть, будет ли отрисовываться фон фигуры. Эквивалентно Figure.patch.set_visible().

Параметры

bbool

set_gid(gid)[source]

Установить идентификатор (группы) для элемента.

Параметры

gidstr

set_in_layout(in_layout)[source]

Установить, должен ли элемент включаться в вычисления макета. Например, Руководство по ограниченному макету, Figure.tight_layout() и fig.savefig(fname, bbox_inches='tight').

Параметры

in_layoutbool

set_label(s)[source]

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

Параметры

sобъект: s будет преобразован в строку с помощью вызова str.

set_linewidth(linewidth)[source]

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

Параметры

linewidthчисло

set_path_effects(path_effects)[source]

Установить эффекты пути.

Параметры

path_effectsAbstractPathEffect

set_picker(picker)[source]

Определить поведение выбора для элемента.

Параметры

pickerNone или bool или float или вызываемый объект

Это может быть одно из следующих:

None: Выбор отключён для данного элемента (по умолчанию).
Булево значение: Если True, выбор включён, и при наведении курсора на элемент генерируется событие выбора.
Число с плавающей точкой: Если picker — число, оно интерпретируется как толерантность к погрешности в точках, и элемент сгенерирует событие выбора, если его данные находятся в пределах погрешности от события мыши. Для некоторых элементов, таких как линии и коллекции фигуры, элемент может предоставлять дополнительные данные для события выбора, например, индексы данных в пределах погрешности от события выбора
Вызываемый объект: Если picker — вызываемый объект, это пользовательская функция, которая определяет, попадает ли мышью по элементу:
```
hit, props = picker(artist, mouseevent)
```
чтобы определить проверку на попадание. Если курсор находится над элементом, вернуть hit=True, а props — словарь свойств, которые вы хотите добавить в атрибуты PickEvent.

set_rasterized(rasterized)[source]

Вынужденное растровое (битовое) рисование для векторной графики.

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

Это значение игнорируется для пиксельной выходной информации.

См. также Растеризация для векторной графики.

Параметры

rasterizedbool

set_sketch_params(scale=None, length=None, randomness=None)[source]

Установить параметры наброска.

Параметры

scalefloat, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не указано, фильтр наброска не будет предоставлен.

lengthfloat, необязательно

Длина колебаний по линии в пикселях (по умолчанию 128.0).

randomnessfloat, необязательно

Коэффициент масштабирования, с помощью которого длина сжимается или расширяется (по умолчанию 16.0).

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

set_snap(snap)[source]

Установить поведение привязки.

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

Привязка в настоящее время поддерживается только задними планами Agg и MacOSX.

Параметры

snapbool или None

Возможные значения:

True: Привязка вершин к центру ближайшего пикселя.
False: Не изменять позиции вершин.
None: (авто) Если путь содержит только прямолинейные отрезки, округлить до ближайшего центра пикселя.

set_transform(t)[source]

Установить преобразование элемента.

Параметры

tTransform

set_url(url)[source]

Установить URL для элемента.

Параметры

urlstr

set_visible(b)[source]

Установить видимость элемента.

Параметры

bbool

set_zorder(level)[source]

Установить z-порядок элемента. Элементы с меньшими значениями zorder рисуются первыми.

Параметры

levelfloat

propertystale: Является ли элемент «неисправным» и требуется ли перерисовать его, чтобы вывод соответствовал внутреннему состоянию элемента.

propertysticky_edges

x и y списки привязанных границ для автоматического масштабирования.

При выполнении автоматического масштабирования, если предел данных совпадает со значением в соответствующем списке sticky_edges, то отступ не добавляется — предел просмотра «прилипает» к краю. Типичный пример использования — гистограммы, где обычно ожидается отсутствие отступа на нижнем краю (0) гистограммы.

Кроме того, расширение отступа «натыкается» на привязанные края и не может их пересекать. Например, если верхний предел данных равен 1,0, верхний предел просмотра, вычисленный с помощью простого применения отступа, равен 1,2, но существует привязанный край в 1,1, тогда фактический верхний предел просмотра будет 1,1.

Примеры

>>> artist.sticky_edges.x[:] = (xmin, xmax)
>>> artist.sticky_edges.y[:] = (ymin, ymax)

subfigures(nrows=1, ncols=1, squeeze=True, wspace=None, hspace=None, width_ratios=None, height_ratios=None, **kwargs)[source]

Добавление подрисунка к этой фигуре или подрисунку.

Подрисунок имеет те же методы художника, что и фигура, и логически идентичен фигуре, но не может печатать себя. См. Подрисунки фигур.

Параметры

nrows, ncolsint, по умолчанию: 1: Количество строк/столбцов сетки подрисунка.
squeezebool, по умолчанию: True: Если True, лишние измерения удаляются из возвращаемого массива подрисунков.
wspace, hspacefloat, по умолчанию: None: Количество ширины/высоты, зарезервированное для промежутка между подрисунками, выраженное как доля средней ширины/высоты подрисунка. Если не указано, значения будут выведены из фигуры или rcParams при необходимости.
width_ratiosмассив-подобный объекта длиной ncols, необязательно: Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину.
height_ratiosмассив-подобный объекта длиной nrows, необязательно: Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту.

subplot_mosaic(mosaic, *, sharex=False, sharey=False, subplot_kw=None, gridspec_kw=None, empty_sentinel='.')[source]

Создание макета осей на основе ASCII-искусства или вложенных списков.

Это вспомогательная функция для создания сложных макетов GridSpec визуально.

Примечание

Этот API является предварительным и может быть пересмотрен в будущем на основе ранних отзывов пользователей.

Параметры

mosaicсписок списков {хешируемых или вложенных} или str

Визуальный макет того, как вы хотите расположить свои оси, помеченные строками. Например

x = [['A panel', 'A panel', 'edge'],
     ['C panel', '.',       'edge']]

генерирует 4 оси:

'A панель', которая имеет высоту 1 строка и охватывает первые два столбца
'edge', которая имеет высоту 2 строки и находится на правом краю
'C панель', которая имеет ширину 1 строка и 1 столбец в нижнем левом углу
пустое место шириной 1 строка и 1 столбец в нижнем центре

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

Если вход — это str, то он может быть либо многострочной строкой вида

'''
AAE
C.E
'''

где каждый символ является столбцом, а каждая строка — строкой. Или это может быть строка из одной строки, где строки разделяются ;:

'AB;CC'

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

sharex, shareybool, по умолчанию: False

Если True, ось x (sharex) или ось y (sharey) будет общей для всех подрисунков. В этом случае видимость меток и единицы оси ведут себя так же, как для subplots. Если False, каждая ось x или y подрисунка будет независимой.

subplot_kwdict, необязательно

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

gridspec_kwdict, необязательно

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

empty_sentinelобъект, необязательно

Элемент макета, обозначающий «оставить это место пустым». По умолчанию '.'. Обратите внимание, если layout — строка, она обрабатывается с помощью inspect.cleandoc для удаления начальных пробелов, которые могут помешать использовать пробелы в качестве пустого sentinela.

Возвращает

dict[метка, ось]: Словарь, сопоставляющий метки объектам осей. Порядок осей слева направо и сверху вниз в соответствии с их положением в общем макете.

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)[source]

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

Этот утилитарный оберточный метод облегчает создание распространённых макетов подграфиков в одном вызове.

Параметры

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

Количество строк/столбцов в сетке подграфиков.

sharex, shareybool или {'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 первого подграфика столбца. Чтобы впоследствии включить метки делений других подграфиков, используйте tick_params.

При совместном использовании осей с единицами, вызов Axis.set_units обновит каждую ось с новыми единицами.

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

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

subplot_kwdict, необязательно

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

gridspec_kwdict, необязательно

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

Axes или массив Axes: Либо один объект Axes, либо массив объектов Axes, если было создано более одного подграфика. Размеры возвращаемого массива можно контролировать с помощью ключевого слова squeeze, см. выше.

См. также

pyplot.subplots
Figure.add_subplot
pyplot.subplot

Примеры

# First create some toy data:
x = np.linspace(0, 2*np.pi, 400)
y = np.sin(x**2)

# Create a figure
plt.figure()

# Create a subplot
ax = fig.subplots()
ax.plot(x, y)
ax.set_title('Simple plot')

# Create two subplots and unpack the output array immediately
ax1, ax2 = fig.subplots(1, 2, sharey=True)
ax1.plot(x, y)
ax1.set_title('Sharing Y axis')
ax2.scatter(x, y)

# Create four polar Axes and access them through the returned array
axes = fig.subplots(2, 2, subplot_kw=dict(projection='polar'))
axes[0, 0].plot(x, y)
axes[1, 1].scatter(x, y)

# Share a X axis with each column of subplots
fig.subplots(2, 2, sharex='col')

# Share a Y axis with each row of subplots
fig.subplots(2, 2, sharey='row')

# Share both X and Y axes with all subplots
fig.subplots(2, 2, sharex='all', sharey='all')

# Note that this is the same as
fig.subplots(2, 2, sharex=True, sharey=True)

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

Настройка параметров макета подграфиков.

Неустановленные параметры остаются неизменными; начальные значения задаются rcParams["figure.subplot.[name]"].

Параметры

leftfloat, необязательно: Положение левого края подграфиков в долях ширины фигуры.
rightfloat, необязательно: Положение правого края подграфиков в долях ширины фигуры.
bottomfloat, необязательно: Положение нижнего края подграфиков в долях высоты фигуры.
topfloat, необязательно: Положение верхнего края подграфиков в долях высоты фигуры.
wspacefloat, необязательно: Ширина отступа между подграфиками в долях средней ширины Axes.
hspacefloat, необязательно: Высота отступа между подграфиками в долях средней высоты Axes.

suptitle(t, **kwargs)[source]

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

Параметры

tstr: Текст заголовка.
xfloat, по умолчанию: 0.5: Положение x текста в координатах фигуры.
yfloat, по умолчанию: 0.98: Положение y текста в координатах фигуры.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: top: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. Возможные значения см. в Text.set_size.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Вес шрифта текста. Возможные значения см. в Text.set_weight.

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

text: Экземпляр Text заголовка.

Другие параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и веса шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные kwargs — свойства matplotlib.text.Text.

supxlabel(t, **kwargs)[source]

Добавить центрированную надпись над графиком.

Параметры

tstr: Текст надписи.
xfloat, по умолчанию: 0.5: Позиция надписи по горизонтали в координатах графика.
yfloat, по умолчанию: 0.01: Позиция надписи по вертикали в координатах графика.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: center: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: bottom: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text надписи.

Другие параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные параметры для свойств matplotlib.text.Text.

supylabel(t, **kwargs)[source]

Добавить центрированную надпись слева от графика.

Параметры

tstr: Текст надписи.
xfloat, по умолчанию: 0.02: Позиция надписи по горизонтали в координатах графика.
yfloat, по умолчанию: 0.5: Позиция надписи по вертикали в координатах графика.
horizontalalignment, ha{'center', 'left', 'right'}, по умолчанию: left: Горизонтальное выравнивание текста относительно (x, y).
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, по умолчанию: center: Вертикальное выравнивание текста относительно (x, y).
fontsize, sizeпо умолчанию: rcParams["figure.titlesize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.titleweight"] (по умолчанию: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text надписи.

Другие параметры

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из FontProperties. rcParams["figure.titlesize"] (по умолчанию: 'large') и rcParams["figure.titleweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные параметры для свойств matplotlib.text.Text.

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

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

Параметры

x, yfloat: Позиция текста. По умолчанию в координатах графика, значения от 0 до 1. Система координат может быть изменена с помощью параметра transform.
sstr: Текст.
fontdictdict, необязательно: Словарь для переопределения свойств текста. Если не задан, значения определяются по умолчанию rcParams["font.*"]. Свойства, переданные как kwargs, переопределяют соответствующие свойства, заданные в fontdict.

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

Text

Другие параметры

**kwargsText свойства

Другие параметры текстовых параметров общего назначения.

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi и возвращает массив чисел с плавающей точкой (m, n, 3)
`alpha`	скаляр или None
`animated`	bool
`backgroundcolor`	цвет
`bbox`	словарь с параметрами для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`figure`	`Figure`
`fontfamily` или family	{FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'}
`fontproperties` или font или font_properties	`font_manager.FontProperties` или `str` или `pathlib.Path`
`fontsize` или size	число с плавающей точкой или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}
`fontstretch` или stretch	{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'}
`fontstyle` или style	{'normal', 'italic', 'oblique'}
`fontvariant` или variant	{'normal', 'small-caps'}
`fontweight` или weight	{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'}
`gid`	строка
`horizontalalignment` или ha	{'center', 'right', 'left'}
`in_layout`	bool
`label`	объект
`linespacing`	число с плавающей точкой (кратное размеру шрифта)
`math_fontfamily`	строка
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	`AbstractPathEffect`
`picker`	None или bool или число с плавающей точкой или вызываемая функция
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	bool
`rotation`	число с плавающей точкой или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	строка
`usetex`	bool или None
`verticalalignment` или va	{'center', 'top', 'bottom', 'baseline', 'center_baseline'}
`visible`	bool
`wrap`	bool
`x`	число с плавающей точкой

`y`	вещественное число
`zorder`	вещественное число

См. также

Axes.text
pyplot.text

update(props)[source]

Обновить свойства этого объекта из словаря props.

Параметры

propsdict

update_from(other)[source]: Скопировать свойства из other в self.

zorder=0

classmatplotlib.figure.SubplotParams(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source]

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

Значения по умолчанию заданы в rcParams["figure.subplot.[name]"].

Параметры

leftfloat: Позиция левой границы подграфиков, как доля ширины фигуры.
rightfloat: Позиция правой границы подграфиков, как доля ширины фигуры.
bottomfloat: Позиция нижней границы подграфиков, как доля высоты фигуры.
topfloat: Позиция верхней границы подграфиков, как доля высоты фигуры.
wspacefloat: Ширина отступа между подграфиками, как доля средней ширины области Axes.
hspacefloat: Высота отступа между подграфиками, как доля средней высоты области Axes.

update(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source]: Обновляет размеры заданных параметров. None означает неизменность.

propertyvalidate[source]

matplotlib.figure.figaspect(arg)[source]

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

В то время как высота взята из rcParams["figure.figsize"] (по умолчанию [6.4, 4.8]), ширина корректируется для соответствия желаемому соотношению сторон. Кроме того, обеспечивается, что ширина находится в диапазоне [4., 16.], а высота — в диапазоне [2., 16.]. При необходимости, по умолчанию высота корректируется.

Параметры

argfloat или 2D массив: Если число, оно определяет соотношение сторон (т. е. отношение высота / ширина). В случае массива соотношение сторон — это количество строк / количество столбцов, чтобы массив можно было разместить в фигуре без искажений.

Возвращает

width, heightfloat: Размер фигуры в дюймах.

Примечания

Если вы хотите создать область Axes внутри фигуры, сохраняющую соотношение сторон, обязательно создайте её с равной шириной и высотой. См. примеры ниже.

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

Примеры

Создайте фигуру, вдвое более высокую, чем широкую:

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)

Создайте фигуру с правильным соотношением сторон для массива:

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)