matplotlib.figure

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

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

Фигуры обычно создаются с помощью методов pyplot figure, subplots и subplot_mosaic.

fig, ax = plt.subplots(figsize=(2, 2), facecolor='lightskyblue',
                       layout='constrained')
fig.suptitle('Figure')
ax.set_title('Axes', loc='left', fontstyle='oblique', fontsize='medium')

(Source code, 2x.png, png)

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

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]

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

Атрибуты:

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число с плавающей запятой

Ширина линии рамки (т.е. ширина линии обводки области фигуры).

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

Если False, подавление рисования области фона фигуры.

subplotparsSubplotParams

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

tight_layoutbool или dict, по умолчанию: rcParams["figure.autolayout"] (значение по умолчанию: False)

Использовать ли механизм подгонки по размеру. См. set_tight_layout.

Отказано

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

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

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

Отказано

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

layout{'constrained', 'compressed', 'tight', 'none', LayoutEngine, None}, по умолчанию: None

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

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

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

См. Руководство по подгонке по размеру для примеров.
'none': не использовать движок макета.
экземпляр LayoutEngine. Встроенные классы макета — ConstrainedLayoutEngine и TightLayoutEngine, более легко доступные как 'constrained' и 'tight'. Передача экземпляра позволяет третьим сторонам предоставлять свой собственный движок макета.

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

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив float (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`canvas`	FigureCanvas
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`constrained_layout`	неизвестно
`constrained_layout_pads`	неизвестно
`dpi`	float
`edgecolor`	цвет
`facecolor`	цвет
`figheight`	float
`figure`	`Figure`
`figwidth`	float
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`layout_engine`	{'constrained', 'compressed', 'tight', 'none', `LayoutEngine`, None}
`linewidth`	число
`mouseover`	bool
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`rasterized`	bool
`size_inches`	(float, float) или float
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`tight_layout`	неизвестно
`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кортеж (left, bottom, width, height): Размеры (left, bottom, width, height) нового 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: Возвращаемый класс оси зависит от используемой проекции. Это Axes если используется прямоугольная проекция и projections.polar.PolarAxes если используется полярная проекция.

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

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

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

`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	(нижний: float, верхний: float)
`ylabel`	строка
`ylim`	(нижняя: float, верхняя: float)
`ymargin`	float больше -0,5
`yscale`	неизвестно
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	float

См. также

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

Примечания

В редких случаях, add_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_axobserver(func)[source]: Всякий раз, когда состояние Axes изменяется, будет вызван func(self).

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: Определяет область в родительской сетке, где будет размещен подграфик.

Возвращает:

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 с sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось совмещённой оси.

labelstr

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

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

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

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

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

Свойство	Описание
`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`	неизвестно
`autoscaley_on`	неизвестно
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	число или None
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`mouseover`	bool
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или число или вызываемый объект
`position`	[слева, снизу, ширина, высота] или `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	число или None
`rasterized`	bool
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	bool или None
`subplotspec`	неизвестно
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	(нижняя: число, верхняя: число)
`xlabel`	строка
`xlim`	(левая: число, правая: число)
`xmargin`	число больше -0,5
`xscale`	неизвестно

`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	(нижняя: float, верхняя: float)
`ylabel`	строка
`ylim`	(нижняя: float, верхняя: float)
`ymargin`	вещественное число, большее -0,5
`yscale`	неизвестно
`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

Примечания

Предполагается, что 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: Необязательный список (или ndarray) 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]

Очистить figure.

Параметры:

keep_observersbool, по умолчанию: False: Установите keep_observers в True, если, например, виджет gui отслеживает оси в figure.

clf(keep_observers=False)[source]

[Не рекомендуется] Псевдоним для метода clear().

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

Использование clf() не рекомендуется. Используйте clear() вместо этого.

Параметры:

keep_observersbool, по умолчанию: False: Установите keep_observers в True, если, например, виджет gui отслеживает оси в figure.

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

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

Параметры:

mappable

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

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

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

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

Оси, на которые будет нарисована цветовая шкала. Если None, то создаются новые оси, а место для них будет взято из осей, указанных в ax.

axAxes или итерируемый объект или numpy.ndarray осей, необязательно

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

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

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

Если cax None, новые cax создаётся как экземпляр осей. Если ax размещается с помощью subplotspec и use_gridspec True, то cax также размещается с помощью subplotspec.

Возвращает:

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'). Они устанавливаются для заданной цветовой карты с помощью методов set_under и set_over цветовой карты.

extendfrac{None, 'auto', длина, длины}

Если None, длина минимальных и максимальных треугольных расширений цветовой шкалы составит 5% от длины внутренней цветовой шкалы (это значение по умолчанию).

Если 'auto', делает треугольные расширения цветовой шкалы такими же длинными, как внутренние прямоугольники (когда spacing установлен в 'uniform') или такими же длинными, как соответствующие смежные внутренние прямоугольники (когда spacing установлен в 'proportional').

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

extendrectbool

Если False, минимальные и максимальные расширения цветовой шкалы будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.

spacing{'uniform', 'proportional'}

Для дискретных цветовых шкал (BoundaryNorm или контуров), 'uniform' даёт каждому цвету одинаковое пространство; 'proportional' делает пространство пропорциональным интервалу данных.

ticksNone или список меток или Объект локализации

Если None, метки определяются автоматически из ввода.

formatNone или str или Форматировщик

Если None, используется ScalarFormatter. Поддерживаются форматирующие строки, например, "%4.2e" или "{x:.2e}". Вместо этого может быть задан альтернативный Formatter.

drawedgesbool

Рисовать ли линии на границах цветов.

labelstr

Надпись на длинной оси цветовой шкалы.

boundaries, valuesNone или последовательность

Если не задано, цветовая карта будет отображаться в масштабе от 0 до 1. Если последовательности, values должны иметь длину на 1 меньше, чем boundaries. Для каждого региона, ограниченного смежными элементами в boundaries, будет использоваться цвет, сопоставленный соответствующему значению в values. Обычно полезно только для индексированных цветов (например, norm=NoNorm()) или других необычных случаев.

Примечания

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

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

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

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

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

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

contains(mouseevent)[source]

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

Возвращает:

bool, {}

convert_xunits(x)[source]

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

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

convert_yunits(y)[source]

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

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

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

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

draw(renderer)[source]

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

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

Parameters:

rendererRendererBase подкласс.

Примечания

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

draw_artist(a)[source]: Отобразить только Artist a.

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

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

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

(M, N): изображение со скалярными данными. Картирование цвета контролируется параметрами cmap, norm, vmin и vmax.
(M, N, 3): изображение с значениями RGB (float от 0 до 1 или int от 0 до 255).
(M, N, 4): изображение с значениями RGBA (float от 0 до 1 или int от 0 до 255), включая прозрачность.

xo, yoint

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

alphaNone или float

Значение прозрачности.

cmapstr или Colormap, по умолчанию: rcParams["image.cmap"] (по умолчанию: 'viridis')

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

Этот параметр игнорируется, если X содержит RGB(A).

normstr или Normalize, необязательно

Метод нормализации, используемый для масштабирования скалярных данных до диапазона [0, 1] перед отображением в цвета с помощью cmap. По умолчанию используется линейное масштабирование, отображающее минимальное значение в 0, а максимальное - в 1.

Если задано, это может быть одно из следующих:

Экземпляр Normalize или его подкласс (см. Нормализация цветовых карт).
Имя шкалы, например, "linear", "log", "symlog", "logit" и т. д. Список доступных шкал можно получить вызовом matplotlib.scale.get_scale_names(). В этом случае динамически генерируется и создаётся подходящий подкласс Normalize.

Этот параметр игнорируется, если X содержит RGB(A).

vmin, vmaxfloat, необязательно

При использовании скалярных данных и отсутствии явного norm, vmin и vmax определяют диапазон данных, охватываемый цветовой картой. По умолчанию цветовая карта охватывает весь диапазон значений предоставленных данных. Использование vmin/vmax при заданном norm является ошибкой (но использование str norm вместе с vmin/vmax допускается).

Этот параметр игнорируется, если X содержит RGB(A).

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. Если вы хотите ресамплированное изображение, заполняющее всю фигуру, вы можете определить область 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.

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

Параметры:

match

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

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

include_selfbool

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

Возвращает:

список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

gca()[source]

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

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

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

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

get_animated()[source]: Вернуть, является ли artist анимированным.

get_axes()[source]

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

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

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

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

get_clip_box()[source]: Вернуть область вырезания.

get_clip_on()[source]: Вернуть, использует ли artist вырезание.

get_clip_path()[source]: Вернуть путь вырезания.

get_constrained_layout()[source]

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

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

get_constrained_layout_pads(relative=False)[source]

[Устарело] Получить отступы для constrained_layout.

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

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

Параметры:

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

Примечания

Устарело в версии 3.6: Используйте fig.get_layout_engine().get() вместо этого.

get_cursor_data(event)[source]

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

Примечание

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

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

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

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

Параметры:

eventMouseEvent

См. также

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_layout_engine()[source]

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

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

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]

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

Возвращает:

tuple или None

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

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

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

get_snap()[source]

Возвращает настройку «snap».

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

get_suptitle()[source]: Возвращает suptitle в виде строки или пустую строку, если он не задан.

get_supxlabel()[source]: Возвращает суперобласть x в виде строки или пустой строкой, если она не задана.

get_supylabel()[source]: Возвращает суперобласть y в виде строки или пустой строкой, если она не задана.

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

get_tightbbox(renderer=None, *, 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(renderer=None)[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список строк, необязательно

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

Возвращает:

Legend

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

locстрока или пара чисел с плавающей точкой, по умолчанию: 'верхний правый'

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

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

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

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

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

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

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

Если рисунок использует менеджер ограниченной компоновки, строковые коды аргумента ключевого слова loc могут обеспечить лучшее поведение компоновки с префиксом 'outside'. Возможна неоднозначность в углах, поэтому 'outside верхний правый' создаст место для легенды над остальной частью осей в компоновке, а 'outside правый верхний' создаст место справа от компоновки. В дополнение к значениям loc, перечисленным выше, у нас есть 'outside правый верхний', 'outside правый нижний', 'outside левый верхний' и 'outside левый нижний'. См. Руководство по легендам для получения более подробной информации.

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)

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

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

Для обратной совместимости также поддерживается написание ncol, но от него рекомендуется отказаться. Если оба значения заданы, ncols имеет приоритет.

propNone или 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, маркер легенды размещается справа от метки легенды.

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

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

Введено в версии 3.7.

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

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

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

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

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

Определяет, должен ли быть нарисован оттенок позади легенды. Оттенок можно настроить с помощью ключевых слов Patch. Настройка через 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 или Transform

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

titleстрока или None

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

title_fontpropertiesNone или FontProperties или словарь

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

title_fontsizeint or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, default: rcParams["legend.title_fontsize"] (default: None): Размер шрифта заголовка легенды. Примечание: это нельзя комбинировать с title_fontproperties. Если вы хотите установить размер шрифта вместе с другими свойствами шрифта, используйте параметр size в title_fontproperties.
alignment{'center', 'left', 'right'}, default: 'center': Выравнивание заголовка легенды и блока записей. Записи выравниваются как один блок, так что маркеры всегда выстроены в линию.
borderpadfloat, default: rcParams["legend.borderpad"] (default: 0.4): Пробелы внутри границы легенды в единицах размера шрифта.
labelspacingfloat, default: rcParams["legend.labelspacing"] (default: 0.5): Вертикальное расстояние между записями легенды в единицах размера шрифта.
handlelengthfloat, default: rcParams["legend.handlelength"] (default: 2.0): Длина маркеров легенды в единицах размера шрифта.
handleheightfloat, default: rcParams["legend.handleheight"] (default: 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.
draggablebool, default: False: Можно ли перетаскивать легенду мышкой.

См. также

Axes.legend

Примечания

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

propertymouseover: Возвращает, запрашивается ли у этого объекта пользовательская контекстная информация при перемещении курсора мыши над ним.

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, *, transparent=None, dpi='figure', format=None,
        metadata=None, bbox_inches=None, pad_inches=0.1,
        facecolor='auto', edgecolor='auto', backend=None,
        **kwargs
       )

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

Параметры:

fnamestr или path-like или двоичный файл-like

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

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

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

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

transparentbool, по умолчанию: rcParams["savefig.transparent"] (по умолчанию: False)

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

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

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

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

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'.

Не поддерживается для 'pgf', 'raw' и 'rgba', так как эти форматы не поддерживают встраивание метаданных. В настоящее время не поддерживается 'jpg', 'tiff' или 'webp', но в будущем может быть включена поддержка встраивания метаданных EXIF.

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

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

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

Количество отступа в дюймах вокруг фигуры, когда bbox_inches равен 'tight'. Если 'layout', использует отступ из ограниченного или сжатого механизма макета; игнорируется, если один из этих механизмов не используется.

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.

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

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

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

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

sca(a)[source]: Устанавливает текущую область Axes как 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>, layout_engine=<UNSET>, linewidth=<UNSET>, mouseover=<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`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`constrained_layout`	неизвестно
`constrained_layout_pads`	неизвестно
`dpi`	float
`edgecolor`	цвет
`facecolor`	цвет
`figheight`	float
`figure`	`Figure`
`figwidth`	float
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`layout_engine`	{'constrained', 'compressed', 'tight', 'none', `LayoutEngine`, None}
`linewidth`	число
`mouseover`	bool
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемая функция
`rasterized`	bool
`size_inches`	(float, float) или float
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`tight_layout`	неизвестно
`transform`	`Transform`
`url`	строка
`visible`	bool
`zorder`	float

set_agg_filter(filter_func)[source]

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

Параметры:

filter_funcвызываемый объект: Функция фильтра, которая принимает (m, n, глубина) массив с плавающей точкой и значение dpi, и возвращает (m, n, глубина) массив и два смещения от левого нижнего угла изображения

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_canvas(canvas)[source]

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

Параметры:

canvasFigureCanvas

set_clip_box(clipbox)[source]

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

Параметры:

clipboxBboxBase или None: Обычно создается из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) - это стандартная обрезка для художника, добавленного в Axes.

set_clip_on(b)[source]

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

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

Параметры:

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

Примечания

Устарело начиная с версии 3.6: Используйте set_layout_engine('constrained') вместо этого.

set_constrained_layout_pads(**kwargs)[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.

Примечания

Устарело начиная с версии 3.6: Используйте figure.get_layout_engine().set() вместо этого.

set_dpi(val)[source]

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

Параметры:

valfloat

set_edgecolor(color)[source]

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

Параметры:

colorцвет

set_facecolor(color)[source]

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

Параметры:

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_layout_engine(layout=None, **kwargs)[source]

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

Параметры:

layout{'constrained', 'compressed', 'tight', 'none', LayoutEngine, None}

'constrained' будет использовать ConstrainedLayoutEngine
'compressed' также будет использовать ConstrainedLayoutEngine, но с корректировкой, которая пытается создать хороший макет для осей с фиксированным соотношением сторон.
'tight' использует TightLayoutEngine
'none' удаляет движок макета.

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

Если None, поведение контролируется rcParams["figure.autolayout"] (по умолчанию: False) (если True ведет себя так, как будто был передан 'tight') и rcParams["figure.constrained_layout.use"] (по умолчанию: False) (если True ведет себя так, как будто был передан 'constrained'). Если оба True, rcParams["figure.autolayout"] (по умолчанию: False) имеет приоритет.

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

**kwargs

Ключевые аргументы передаются в движок макета для установки таких параметров, как размеры отступов и отступов. Используется только если layout является строкой.

set_linewidth(linewidth)[source]

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

Параметры:

linewidthчисло

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_path_effects(path_effects)[source]

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

Параметры:

path_effectsсписок AbstractPathEffect

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_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 использует этот аргумент в качестве семени генератора случайных чисел, а не как описано выше. При использовании одного и того же семени получается одинаковая случайная форма.

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, перезаписывая значения по умолчанию для отступов.

Примечания

Устарело начиная с версии 3.6: Используйте set_layout_engine вместо этого.

set_transform(t)[source]

Установить преобразование элемента.

Параметры:

tTransform

set_url(url)[source]

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

Параметры:

urlstr

set_visible(b)[source]

Установить видимость элемента.

Параметры:

bbool

set_zorder(level)[source]

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

Параметры:

levelfloat

show(warn=True)[source]

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

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

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

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

Примеры использования Figure.show включают запуск этого из графического приложения (где постоянно работает цикл событий) или из командной оболочки, такой как IPython, которая устанавливает обработчик ввода, чтобы оболочка могла принимать ввод, пока также отображается и интерактивна фигура. Некоторые, но не все, графические библиотеки будут регистрировать обработчик ввода при импорте. См. Интеграция командной строки для получения более подробной информации.

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

Параметры:

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

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]

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

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

Примечание

Концепция подфигур появилась в версии 3.4, и API все еще предварительный.

Параметры:

nrows, ncolsint, по умолчанию: 1: Число строк/столбцов сетки подфигур.
squeezebool, по умолчанию: True: Если True, дополнительные измерения будут удалены из возвращаемого массива подфигур.
wspace, hspacefloat, по умолчанию: None: Количество ширины/высоты, зарезервированное для отступа между подфитурами, выраженное как доля от средней ширины/высоты подфигур. Если не задано, значения будут взяты из rcParams, если используется условное макетирование (см. ConstrainedLayoutEngine), или ноль, если макетный движок не используется.
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, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, per_subplot_kw=None, gridspec_kw=None)[source]

Построение макета Oсей на основе ASCII-искусства или вложенных списков.

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

См. Составление сложных и семантических изображений (subplot_mosaic) для примера и полного документации 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'

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

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

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

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

width_ratiosмассив-подобный длины ncols, необязательно

Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не указано, все столбцы будут иметь одинаковую ширину. Эквивалентно gridspec_kw={'width_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету.

height_ratiosмассив-подобный длины nrows, необязательно

Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не указано, все строки будут иметь одинаковую высоту. Эквивалентно gridspec_kw={'height_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету.

subplot_kwсловарь, необязательно

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

per_subplot_kwсловарь, необязательно

Словарь, сопоставляющий идентификаторы Oсей или кортежи идентификаторов со словарем ключевых аргументов, которые должны быть переданы в вызов Figure.add_subplot для создания каждого подграфика. Значения в этих словарях имеют преимущество перед значениями в subplot_kw.

Если mosaic — строка, и, следовательно, все ключи являются одиночными символами, можно использовать одну строку вместо кортежа в качестве ключей; т.е. "AB" эквивалентно ("A", "B").

Введено в версии 3.7.

gridspec_kwсловарь, необязательно

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

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

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

Возвращает:

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

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, width_ratios=None, height_ratios=None, 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.

width_ratiosмассив-подобный объект длиной ncols, необязательно

height_ratiosмассив-подобный объект длиной nrows, необязательно

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

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

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

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

Возвращает:

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
fig = 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 an 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]

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

Параметры:

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.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

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

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

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

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

supylabel(t, **kwargs)[source]

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

Параметры:

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.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Начертание шрифта текста. См. Text.set_weight для возможных значений.

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

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

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

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если задан fontproperties, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные 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`	логическое значение
`antialiased`	логическое значение
`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	{'left', 'center', 'right'}
`in_layout`	логическое значение
`label`	объект
`linespacing`	вещественное число (кратное размеру шрифта)
`math_fontfamily`	строка
`mouseover`	логическое значение
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	логическое значение
`path_effects`	список `AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемая функция
`position`	(число с плавающей точкой, число с плавающей точкой)
`rasterized`	логическое значение
`rotation`	вещественное число или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: вещественное число, длина: вещественное число, случайность: вещественное число)
`snap`	логическое значение или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	логическое значение
`url`	строка
`usetex`	логическое значение или None
`verticalalignment` или va	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}
`visible`	логическое значение

`wrap`	bool
`x`	float
`y`	float
`zorder`	float

См. также

Axes.text
pyplot.text

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

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

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

Параметры:

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

См. также

Figure.set_layout_engine
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 и SubFigure, содержащий методы, добавляющие элементы на график или подграфик, создание осей и т. д.

add_artist(artist, clip=False)[source]

Добавление 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кортеж (left, bottom, width, height): Размеры (left, bottom, width, height) новой 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, optional: Использовать общую ось 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`	(число, число) или {'C', 'SW', 'S', 'SE', 'E', 'NE', ...}
`animated`	bool
`aspect`	{'auto', 'equal'} или число
`autoscale_on`	bool
`autoscalex_on`	неизвестно
`autoscaley_on`	неизвестно
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	число или None
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`mouseover`	bool
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или число или вызываемая функция
`position`	[левое, нижнее, ширина, высота] или `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	число или None
`rasterized`	bool
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	bool или None
`subplotspec`	неизвестно
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	(нижний: число, верхний: число)
`xlabel`	строка
`xlim`	(левый: число, правый: число)
`xmargin`	число, большее -0,5
`xscale`	неизвестно

`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	(нижний: float, верхний: float)
`ylabel`	строка
`ylim`	(нижняя: float, верхняя: float)
`ymargin`	число, большее -0,5
`yscale`	неизвестно
`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. Возвращаемые значения могут существовать, но игнорируются.

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

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: Определяет область в родительской сетке, где будет размещена подфигура.

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

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, необязательно

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

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

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

labelstr

Метка для возвращенного подграфика Axes.

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

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

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

**kwargs: Этот метод также принимает именованные аргументы для базового класса возвращенного подграфика Axes; за исключением аргумента 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`	`BboxBase` или None
`clip_on`	логическое значение
`clip_path`	Объект Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	логическое значение
`gid`	строка
`in_layout`	логическое значение
`label`	объект
`mouseover`	логическое значение
`navigate`	логическое значение
`navigate_mode`	неизвестно
`path_effects`	список `AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемая функция
`position`	[левый, нижний, ширина, высота] или `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	число с плавающей точкой или None
`rasterized`	логическое значение
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	логическое значение или None
`subplotspec`	неизвестно
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	логическое значение
`xbound`	(нижний: число, верхний: число)
`xlabel`	строка
`xlim`	(левый: число, правый: число)
`xmargin`	число больше -0,5
`xscale`	неизвестно

`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	(нижний: float, верхний: float)
`ylabel`	строка
`ylim`	(нижняя: float, верхняя: float)
`ymargin`	число, большее -0,5
`yscale`	неизвестно
`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 для выравнивания меток. По умолчанию выравниваются все объекты Axes на рисунке.

См. также

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

align_xlabels(axs=None)[source]

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

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

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

Параметры:

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

См. также

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 подграфиков в одном столбце подграфиков, если выравнивание меток выполняется автоматически (т. е. позиция метки не установлена вручную).

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

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

Параметры:

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

См. также

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

Примечания

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

Примеры

Пример с большими метками 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 — это даты. Метки делений часто длинные, и помогает их повернуть в нижнем подграфике и отключить их в других подграфиках, а также отключить метки оси X.

Параметры:

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

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

clear(keep_observers=False)[source]

Очистить рисунок.

Параметры:

keep_observersbool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет графического интерфейса отслеживает Axes в рисунке.

clf(keep_observers=False)[source]

[Не рекомендуется] Псевдоним для метода clear().

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

Использование clf() не рекомендуется. Используйте clear() вместо него.

Параметры:

keep_observersbool, по умолчанию: False: Установите keep_observers в значение True, если, например, виджет графического интерфейса отслеживает Axes в рисунке.

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

Добавление полосы цвета к графику.

Параметры:

mappable

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

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

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

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

Оси, на которых будет нарисована полоса цвета. Если None, то создаётся новая ось, и пространство для неё будет взято из осей, указанных в ax.

axAxes или итерируемый объект или numpy.ndarray осей, необязательно

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

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

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

Если cax None, новая cax создается как экземпляр оси. Если ax размещен с помощью подсхемы, и use_gridspec True, то cax также размещается с помощью подсхемы.

Возвращает:

colorbarColorbar

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

locationNone или {'слева', 'справа', 'сверху', 'снизу'}

Расположение относительно родительской оси, где создается ось полосы цвета. Оно также определяет ориентацию полосы цвета (полосы цвета слева и справа — вертикальные, сверху и снизу — горизонтальные). Если None, расположение будет взято из orientation, если оно задано (вертикальные полосы цвета справа, горизонтальные снизу), или по умолчанию будет 'справа', если orientation не задано.

orientationNone или {'вертикальная', 'горизонтальная'}

Ориентация полосы цвета. Предпочтительно задавать 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{'ничего', 'оба', 'мин', 'макс'}

Создать концы для значений вне диапазона (если не 'ничего'). Они устанавливаются для заданной цветовой карты с помощью методов colormap set_under и set_over.

extendfrac{None, 'auto', длина, длины}

Если установлено в None, оба минимальные и максимальные треугольные расширения полосы цвета будут иметь длину 5% от длины внутренней полосы цвета (это значение по умолчанию).

Если установлено в 'auto', делает треугольные расширения полосы цвета такой же длины, как внутренние ячейки (когда spacing установлен в 'uniform') или такой же длины, как соответствующие соседние внутренние ячейки (когда spacing установлен в 'proportional').

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

extendrectbool

Если False, минимальные и максимальные расширения полосы цвета будут треугольными (значение по умолчанию). Если True, расширения будут прямоугольными.

spacing{'равномерное', 'пропорциональное'}

Для дискретных полос цвета (BoundaryNorm или контуров), 'равномерное' дает каждому цвету одинаковое пространство; 'пропорциональное' делает пространство пропорциональным интервалу данных.

ticksNone или список делений или Позиционер

Если None, деления определяются автоматически из входных данных.

formatNone или строка или Форматировщик

Если None, используется ScalarFormatter. Поддерживаются строковые форматы, например, "%4.2e" или "{x:.2e}". Вместо этого можно указать альтернативный Formatter.

drawedgesbool

Рисовать ли линии на границах цветов.

labelстрока

Подпись на длинной оси полосы цвета.

boundaries, valuesNone или последовательность

Если не установлено, цветовая карта будет отображаться в масштабе 0-1. Если последовательности, values должны иметь длину на 1 меньше, чем boundaries. Для каждого участка, ограниченного соседними элементами в boundaries, будет использован цвет, сопоставленный соответствующему значению в values. Обычно полезно только для индексированных цветов (т.е. norm=NoNorm()) или других необычных случаев.

Примечания

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

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

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

Известно, что некоторые просмотрщики векторной графики (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.

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

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

draw(renderer)[source]

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

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

Parameters:

rendererRendererBase подкласс.

Примечания

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

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

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

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

Parameters:

match

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

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

include_selfbool

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

Returns:

Список Artist

format_cursor_data(data)[source]

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

Примечание

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

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

См. также

get_cursor_data

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

gca()[source]

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

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

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]: Возвращает траекторию обрезки.

END_OF_DOCUMENT_MARKER

get_cursor_data(event)[source]

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

Примечание

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

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

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

Параметры:

eventMouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

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

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_mouseover()[source]: Возвращает, запрашивается ли у этого элемента графики пользовательская контекстная информация при перемещении курсора мыши над ним.

get_path_effects()[source]

get_picker()[source]

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

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

См. также

set_picker, pickable, pick

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

get_sketch_params()[source]

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

Возвращает:

tuple или None

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

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

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

get_snap()[source]

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

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

get_suptitle()[source]: Возвращает suptitle в виде строки или пустой строки, если он не задан.

get_supxlabel()[source]: Возвращает подзаголовок оси x как строку или пустую строку, если он не задан.

get_supylabel()[source]: Возвращает подзаголовок оси y как строку или пустую строку, если он не задан.

get_tightbbox(renderer=None, *, bbox_extra_artists=None)[source]

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

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

Объекты, у которых artist.set_in_layout(False) не включены в рамку.

Параметры:

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

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

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

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

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

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

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

get_window_extent(renderer=None)[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:

locстрока или пара чисел с плавающей точкой, по умолчанию: 'верхний правый'

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

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

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

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

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

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

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

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

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)

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

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

Для обратной совместимости также поддерживается написание ncol, но его следует избегать. Если оба заданы, ncols имеет приоритет.

propNone или FontProperties или словарь

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

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

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

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

Цвет текста в легенде. Либо допустимая строка цвета (например, 'красный'), либо список строк цвета. Цвет метки также можно сделать соответствующим цвету линии или маркера, используя '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

reverseлогическое значение, по умолчанию: False

Введено в версии 3.7.

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

Выводить ли легенду на области (рамку).

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

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

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

Рисовать ли тень под легендой. Тень можно настроить с помощью ключевых слов Patch. Настройка через rcParams["legend.shadow"] (по умолчанию: False) в настоящее время не поддерживается.

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

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 или Transform

titleстрока или None

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

title_fontpropertiesNone или 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.
alignment{'center', 'left', 'right'}, по умолчанию: 'center': Выравнивание заголовка легенды и блока записей. Записи выравниваются как единый блок, поэтому маркеры всегда выстраиваются в линию.
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, по умолчанию: rcParams["legend.handletextpad"] (по умолчанию: 0.8): Отступ между рукояткой легенды и текстом, в единицах размера шрифта.
borderaxespadfloat, по умолчанию: rcParams["legend.borderaxespad"] (по умолчанию: 0.5): Отступ между осями и границей легенды, в единицах размера шрифта.
columnspacingfloat, по умолчанию: rcParams["legend.columnspacing"] (по умолчанию: 2.0): Интервал между столбцами, в единицах размера шрифта.
handler_mapdict или None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Этот handler_map обновляет стандартный словарь обработчиков, расположенный в matplotlib.legend.Legend.get_legend_handler_map.
draggablebool, по умолчанию: False: Можно ли перетаскивать легенду с помощью мыши.

См. также

Axes.legend

Примечания

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

свойствоmouseover: Возвращает, запрашивается ли у этого объекта-артиста информация о контексте при наведении курсора мыши.

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>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает (m, n, 3) массив с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив и два смещения от левого нижнего угла изображения
`alpha`	скаляр или None
`animated`	bool
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`edgecolor`	цвет
`facecolor`	цвет
`figure`	`Figure`
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`linewidth`	число
`mouseover`	bool
`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.

Parameters:

filter_funccallable: Функция фильтра, которая принимает (m, n, глубина) массив с плавающей точкой и значение dpi, и возвращает (m, n, глубина) массив и два смещения от левого нижнего угла изображения

set_alpha(alpha)[source]

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

Parameters:

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

set_animated(b)[source]

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

См. также matplotlib.animation и Более быстрое отображение с использованием блиттинга.

Параметры:

bbool

set_clip_box(clipbox)[source]

Установите область обрезки художника Bbox.

Параметры:

clipboxBboxBase или None: Обычно создается из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является стандартной обрезкой для художника, добавленного в Axes.

set_clip_on(b)[source]

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

При значении False художники будут отображаться за пределами Axes, что может привести к неожиданным результатам.

Параметры:

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_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]

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

Параметры:

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

set_linewidth(linewidth)[source]

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

Параметры:

linewidthчисло

set_mouseover(mouseover)[source]

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

Параметры:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_path_effects(path_effects)[source]

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

Параметры:

path_effectsсписок AbstractPathEffect

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)

Фронт 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.

К этому атрибуту нельзя присваивать значения; однако списки 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]

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

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

Примечание

Концепция подрисунка нова в версии 3.4, и API всё ещё предварительный.

Параметры:

nrows, ncolsint, по умолчанию: 1: Количество строк/столбцов сетки подрисунков.
squeezebool, по умолчанию: True: Если True, дополнительные размеры удаляются из возвращаемого массива подрисунков.
wspace, hspacefloat, по умолчанию: None: Количество ширины/высоты, зарезервированных для пространства между подрисунками, выраженное как доля средней ширины/высоты подрисунков. Если не указано, значения будут взяты из rcParams, если используется ограниченное расположение (см. ConstrainedLayoutEngine), или ноль, если движок макета не используется.
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, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, per_subplot_kw=None, gridspec_kw=None)[source]

Построение макета осей на основе ASCII-арта или вложенных списков.

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

См. Составление сложных и семантических фигур (subplot_mosaic) для примера и полной документации API.

Параметры:

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

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

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

генерирует 4 оси:

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

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

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

'''
AAE
C.E
'''

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

'AB;CC'

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

Идентификаторы осей могут быть str или неитерируемым хешируемым объектом (например, tuple s не могут быть использованы).

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

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

width_ratiosмассив-подобный объект длиной ncols, необязательно

Определяет относительные ширины столбцов. Каждый столбец получает относительную ширину width_ratios[i] / sum(width_ratios). Если не задано, все столбцы будут иметь одинаковую ширину. Эквивалентно gridspec_kw={'width_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету.

height_ratiosмассив-подобный объект длиной nrows, необязательно

Определяет относительные высоты строк. Каждая строка получает относительную высоту height_ratios[i] / sum(height_ratios). Если не задано, все строки будут иметь одинаковую высоту. Эквивалентно gridspec_kw={'height_ratios': [...]}. В случае вложенных макетов этот аргумент применяется только к внешнему макету.

subplot_kwсловарь, необязательно

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

per_subplot_kwсловарь, необязательно

Словарь, сопоставляющий идентификаторы осей или кортежи идентификаторов со словарем ключевых аргументов, которые должны быть переданы в вызов Figure.add_subplot для создания каждого подграфика. Значения в этих словарях имеют приоритет над значениями в subplot_kw.

Если mosaic — строка, а значит, все ключи — одиночные символы, то можно использовать одну строку вместо кортежа в качестве ключей; например, "AB" эквивалентно ("A", "B").

Добавлена в версии 3.7.

gridspec_kwсловарь, необязательно

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

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

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

Возвращает:

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

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, width_ratios=None, height_ratios=None, 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.

width_ratiosмассив-подобный длиной ncols, необязательно

height_ratiosмассив-подобный длиной nrows, необязательно

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
fig = 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 an 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: Положение 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.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

Возвращает:

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

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

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если fontproperties задано, значения по умолчанию для размера и веса шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные 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.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

Возвращает:

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

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

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если fontproperties задано, значения по умолчанию для размера и веса шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные 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
`antialiased`	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	{'left', 'center', 'right'}
`in_layout`	bool
`label`	объект
`linespacing`	вещественное число (кратное размеру шрифта)
`math_fontfamily`	str
`mouseover`	bool
`multialignment` или ma	{'left', 'right', 'center'}
`parse_math`	bool
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`position`	(вещественное число, вещественное число)
`rasterized`	bool
`rotation`	вещественное число или {'vertical', 'horizontal'}
`rotation_mode`	{None, 'default', 'anchor'}
`sketch_params`	(масштаб: вещественное число, длина: вещественное число, случайность: вещественное число)
`snap`	bool или None
`text`	объект
`transform`	`Transform`
`transform_rotates_text`	bool
`url`	str
`usetex`	bool или None
`verticalalignment` или va	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}

`visible`	bool
`wrap`	bool
`x`	float
`y`	float
`zorder`	float

См. также

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)

См. Подфигуры фигур

Примечание

Концепция подфигуры нова в версии v3.4, и API всё ещё предварительный.

Параметры:

parentFigure или SubFigure: Фигура или подфигура, содержащая подфигуру. Подфигуры могут быть вложены.
subplotspecgridspec.SubplotSpec: Определяет область в родительской сетке, где будет размещена подфигура.
facecolorпо умолчанию: "none": Цвет заливки области фигуры; по умолчанию прозрачный.
edgecolorпо умолчанию: rcParams["figure.edgecolor"] (по умолчанию: 'white'): Цвет границы области фигуры.
linewidthfloat: Толщина линии рамки (т.е. толщина линии границы области фигуры).
frameonbool, по умолчанию: rcParams["figure.frameon"] (по умолчанию: True): Если False, подавляет отображение области фона фигуры.

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает массив (m, n, 3) чисел с плавающей точкой и значение dpi, и возвращает массив (m, n, 3) и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`dpi`	float
`edgecolor`	цвет
`facecolor`	цвет
`figure`	`Figure`
`frameon`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`linewidth`	число
`mouseover`	bool
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или callable
`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]

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

Подписи:

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

Параметры:

recttuple (левый, нижний, ширина, высота): Размеры (левый, нижний, ширина, высота) нового 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: Возвращаемый тип осей зависит от используемой проекции. Это Axes, если используется проекция rectilinear, и projections.polar.PolarAxes, если используется проекция polar.

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

**kwargs: Этот метод также принимает ключевые аргументы для класса возвращаемых осей. Ключевые аргументы для класса осей rectilinear 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`	`BboxBase` или None
`clip_on`	логическое значение
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	логическое значение
`gid`	строка
`in_layout`	логическое значение
`label`	объект
`mouseover`	логическое значение
`navigate`	логическое значение
`navigate_mode`	неизвестно
`path_effects`	список `AbstractPathEffect`
`picker`	None или логическое значение или число с плавающей точкой или вызываемая функция
`position`	[левое, нижнее, ширина, высота] или `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	число с плавающей точкой или None
`rasterized`	логическое значение
`sketch_params`	(масштаб: число, длина: число, случайность: число)
`snap`	логическое значение или None
`subplotspec`	неизвестно
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	логическое значение
`xbound`	(нижняя: число, верхняя: число)
`xlabel`	строка
`xlim`	(левая: число, правая: число)
`xmargin`	число больше -0.5
`xscale`	неизвестно

`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	(нижняя: float, верхняя: float)
`ylabel`	строка
`ylim`	(нижняя: float, верхняя: float)
`ymargin`	вещественное число больше -0,5
`yscale`	неизвестно
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	вещественное число

См. также

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

Примечания

В редких случаях add_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. Возвращаемые значения могут существовать, но игнорируются.

Возвращает:

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: Определяет область в родительской сетке, где будет размещена подфигура.

Возвращает:

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

polarbool, default: False

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

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

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

sharex, shareyAxes, optional

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

labelstr

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

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

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

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

**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`	неизвестно
`autoscaley_on`	неизвестно
`axes_locator`	Callable[[Axes, Renderer], Bbox]
`axisbelow`	bool или 'line'
`box_aspect`	float или None
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Patch или (Path, Transform) или None
`facecolor` или fc	цвет
`figure`	`Figure`
`frame_on`	bool
`gid`	строка
`in_layout`	bool
`label`	объект
`mouseover`	bool
`navigate`	bool
`navigate_mode`	неизвестно
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемый объект
`position`	[left, bottom, width, height] или `Bbox`
`prop_cycle`	`Cycler`
`rasterization_zorder`	float или None
`rasterized`	bool
`sketch_params`	(scale: float, length: float, randomness: float)
`snap`	bool или None
`subplotspec`	неизвестно
`title`	строка
`transform`	`Transform`
`url`	строка
`visible`	bool
`xbound`	(нижнее: float, верхнее: float)
`xlabel`	строка
`xlim`	(левый: float, правый: float)
`xmargin`	float больше чем -0.5
`xscale`	неизвестно

`xticklabels`	неизвестно
`xticks`	неизвестно
`ybound`	(нижняя: float, верхняя: float)
`ylabel`	строка
`ylim`	(нижняя: float, верхняя: float)
`ymargin`	float больше -0.5
`yscale`	неизвестно
`yticklabels`	неизвестно
`yticks`	неизвестно
`zorder`	float

См. также

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

Примечания

Предполагается, что 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: Необязательный список (или ndarray) 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 — даты. Метки делений обычно длинные, и помогает повернуть их в нижнем подграфике и отключить их в других подграфиках, а также отключить подписи оси 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 эквивалентны.

clear(keep_observers=False)[source]

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

Параметры:

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

clf(keep_observers=False)[source]

[Не рекомендуется] Псевдоним для метода clear().

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

Использование clf() не рекомендуется. Используйте clear() вместо этого.

Параметры:

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

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

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

Параметры:

mappable

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

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

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

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

Ось, на которой будет нарисован цветовой бар. Если None, то создаётся новая ось, и место для неё будет отнято у осей, указанных в ax.

axAxes или итерируемый объект или numpy.ndarray осей, необязательно

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

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

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

Если cax None, новая cax создаётся как экземпляр оси. Если ax размещён с помощью subplotspec и use_gridspec True, то cax также размещается с помощью subplotspec.

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

colorbarColorbar

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

locationNone или {'left', 'right', 'top', 'bottom'}

Положение, относительно родительской оси, где создаётся ось цветового бара. Оно также определяет orientation цветового бара (цветовые бары слева и справа вертикальные, цветовые бары сверху и снизу горизонтальные). Если 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').

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

extendrectbool

Если False, расширения цветового бара по минимуму и максимуму будут треугольными (по умолчанию). Если True, расширения будут прямоугольными.

spacing{'uniform', 'proportional'}

Для дискретных цветовых баров (BoundaryNorm или контуров), 'uniform' обеспечивает одинаковое пространство для каждого цвета; 'proportional' делает пространство пропорциональным интервалу данных.

ticksNone или список меток или Locator

Если None, метки определяются автоматически из входных данных.

formatNone или str или Formatter

Если None, используется ScalarFormatter. Поддерживаются строковые форматы, например, "%4.2e" или "{x:.2e}". Вместо этого может быть предоставлен альтернативный Formatter.

drawedgesbool

Рисовать ли линии на границах цветов.

labelstr

Подпись на длинной оси цветового бара.

boundaries, valuesNone или последовательность

Если не задано, цветовая карта будет отображаться в масштабе 0-1. Если последовательности, values должны иметь длину на 1 меньше, чем boundaries. Для каждого региона, ограниченного смежными записями в boundaries, будет использоваться цвет, сопоставленный соответствующему значению в values. Обычно это полезно только для индексированных цветов (т.е. norm=NoNorm()) или других необычных ситуациях.

Примечания

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

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

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

Известно, что некоторые программы просмотра векторной графики (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).

Parameters:

rendererRendererBase подкласс.

Примечания

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

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

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

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

Parameters:

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()[source]

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

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

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

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

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

get_axes()[source]

Список Axes в SubFigure. Вы можете получить доступ к Axes в SubFigure и изменить их с помощью этого списка.

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

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

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

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

END_OF_DOCUMENT_MARKER

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:

eventMouseEvent

См. также

format_cursor_data

get_default_bbox_extra_artists()[source]

get_dpi()[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_layout_engine()[source]

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

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

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_suptitle()[source]: Возвращает заголовок над подрисунками как строку или пустую строку, если не установлен.

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

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

get_tightbbox(renderer=None, *, bbox_extra_artists=None)[source]

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

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

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

Параметры:

rendererподкласс RendererBase: Отобразитель, который будет использоваться для отрисовки фигур (т.е. 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(renderer=None)[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список строк, необязательно

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

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

Legend

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

locстрока или пара чисел с плавающей точкой, по умолчанию: 'верхний правый'

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

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

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

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

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

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

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

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)

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

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

Для обратной совместимости также поддерживается написание ncol, но от него рекомендуется отказаться. Если оба значения указаны, ncols имеет приоритет.

propNone или 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

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

Введено в версии 3.7.

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

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

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

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

shadowNone, bool или словарь, по умолчанию: rcParams["legend.shadow"] (по умолчанию: False)

Определяет, следует ли рисовать тень за легендой. Тень можно настроить с помощью Patch ключевых слов. Настройка с помощью rcParams["legend.shadow"] (по умолчанию: False) в настоящее время не поддерживается.

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

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 или Transform

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

titleстрока или None

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

title_fontpropertiesNone или 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.
alignment{'center', 'left', 'right'}, по умолчанию: 'center': Выравнивание заголовка легенды и блока элементов. Элементы выравниваются как единый блок, так что маркеры всегда выстроены в одну линию.
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, по умолчанию: rcParams["legend.handletextpad"] (по умолчанию: 0.8): Отступ между маркером легенды и текстом в единицах размера шрифта.
borderaxespadfloat, по умолчанию: rcParams["legend.borderaxespad"] (по умолчанию: 0.5): Отступ между осями и границей легенды в единицах размера шрифта.
columnspacingfloat, по умолчанию: rcParams["legend.columnspacing"] (по умолчанию: 2.0): Отступ между столбцами в единицах размера шрифта.
handler_mapdict или None: Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Это handler_map обновляет стандартный словарь обработчика, найденный по адресу matplotlib.legend.Legend.get_legend_handler_map.
draggablebool, по умолчанию: False: Можно ли перетаскивать легенду мышкой.

См. также

Axes.legend

Примечания

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

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

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>, dpi=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, frameon=<UNSET>, gid=<UNSET>, in_layout=<UNSET>, label=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

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

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

Свойство	Описание
`agg_filter`	функция фильтра, которая принимает (m, n, 3) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, 3) массив и два смещения от нижнего левого угла изображения
`alpha`	скаляр или None
`animated`	bool
`clip_box`	`BboxBase` или None
`clip_on`	bool
`clip_path`	Объект Patch или (Path, Transform) или None
`dpi`	float
`edgecolor`	цвет
`facecolor`	цвет
`figure`	`Figure`
`frameon`	bool
`gid`	str
`in_layout`	bool
`label`	объект
`linewidth`	число
`mouseover`	bool
`path_effects`	список `AbstractPathEffect`
`picker`	None или bool или float или вызываемая функция
`rasterized`	bool
`sketch_params`	(масштаб: float, длина: float, случайность: float)
`snap`	bool или None
`transform`	`Transform`
`url`	str
`visible`	bool
`zorder`	float

set_agg_filter(filter_func)[source]

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

Parameters:

filter_funccallable: Функция фильтра, которая принимает (m, n, глубина) массив чисел с плавающей точкой и значение dpi, и возвращает (m, n, глубина) массив и два смещения от нижнего левого угла изображения

set_alpha(alpha)[source]

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

Parameters:

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

set_animated(b)[source]

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

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

См. также matplotlib.animation и Ускорение отрисовки с помощью блинтинга.

Параметры:

bbool

set_clip_box(clipbox)[source]

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

Параметры:

clipboxBbox или None: Обычно создаётся из TransformedBbox. Например, TransformedBbox(Bbox([[0, 0], [1, 1]]), ax.transAxes) является по умолчанию областью обрезки для элемента, добавленного в Axes.

set_clip_on(b)[source]

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

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

Параметры:

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_dpi(val)[source]

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

Параметры:

valfloat

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').

Parameters:

in_layoutbool

set_label(s)[source]

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

Parameters:

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

set_linewidth(linewidth)[source]

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

Parameters:

linewidthчисло

set_mouseover(mouseover)[source]

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

Parameters:

mouseoverbool

См. также

get_cursor_data
ToolCursorPosition
NavigationToolbar2

set_path_effects(path_effects)[source]

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

Parameters:

path_effectsсписок AbstractPathEffect

set_picker(picker)[source]

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

Parameters:

pickerNone или bool или float или вызываемый объект

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

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

set_rasterized(rasterized)[source]

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

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

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

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

Parameters:

rasterizedbool

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

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

Parameters:

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

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

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

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

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

Множитель масштаба, с которым длина уменьшается или увеличивается (по умолчанию 16.0)

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

set_snap(snap)[source]

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

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

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

Parameters:

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.

К этому атрибуту нельзя присвоить значение; однако списки 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]

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

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

Примечание

Концепция «подрисунков» появилась в версии 3.4, и API всё ещё предварительный.

Параметры:

nrows, ncolsint, по умолчанию: 1: Количество строк/столбцов сетки подрисунков.
squeezebool, по умолчанию: True: Если True, лишние измерения удаляются из возвращаемого массива подрисунков.
wspace, hspacefloat, по умолчанию: None: Количество ширины/высоты, отведенное для отступа между подрисунками, выраженное в долях от средней ширины/высоты подрисунка. Если не задано, значения будут определены из rcParams, если используется ограниченная компоновка (см. ConstrainedLayoutEngine), или нуль, если движок компоновки не используется.
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, width_ratios=None, height_ratios=None, empty_sentinel='.', subplot_kw=None, per_subplot_kw=None, gridspec_kw=None)[source]

Построение макета осей на основе ASCII-искусства или вложенных списков.

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

См. Сложное и семантическое построение фигуры (subplot_mosaic) для примера и полной документации API

Параметры:

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

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

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

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

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

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

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

'''
AAE
C.E
'''

'AB;CC'

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

Идентификаторы осей могут быть str или хешируемым объектом, не являющимся итерируемым (например, tuple s не могут использоваться).

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

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

width_ratiosмассив-подобный длиной ncols, необязательно

height_ratiosмассив-подобный длиной nrows, необязательно

subplot_kwсловарь, необязательно

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

per_subplot_kwсловарь, необязательно

Словарь, сопоставляющий идентификаторы осей или кортежи идентификаторов со словарем ключевых слов, которые будут переданы в вызов Figure.add_subplot, используемый для создания каждого подграфика. Значения в этих словарях имеют приоритет над значениями в subplot_kw.

Если mosaic — строка, а значит, все ключи — одиночные символы, можно использовать одну строку вместо кортежа в качестве ключей; например, "AB" эквивалентно ("A", "B").

Добавлена в версии 3.7.

gridspec_kwсловарь, необязательно

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

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

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

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

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

subplots(nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, width_ratios=None, height_ratios=None, 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.

width_ratiosмассив-подобный объект длины ncols, необязательно

height_ratiosмассив-подобный объект длины nrows, необязательно

subplot_kwсловарь, необязательно

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

gridspec_kwсловарь, необязательно

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

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
fig = 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 an 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]

Добавить централизованную надпись под осью 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.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text надписи под осью x.

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

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

supylabel(t, **kwargs)[source]

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

Параметры:

tstr: Текст надписи справа от оси y.
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.labelsize"] (по умолчанию: 'large'): Размер шрифта текста. См. Text.set_size для возможных значений.
fontweight, weightпо умолчанию: rcParams["figure.labelweight"] (по умолчанию: 'normal'): Вес шрифта текста. См. Text.set_weight для возможных значений.

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

text: Экземпляр Text надписи справа от оси y.

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

fontpropertiesNone или dict, необязательно: Словарь свойств шрифта. Если указано fontproperties, значения по умолчанию для размера и веса шрифта берутся из значений по умолчанию FontProperties. rcParams["figure.labelsize"] (по умолчанию: 'large') и rcParams["figure.labelweight"] (по умолчанию: 'normal') игнорируются в этом случае.
**kwargs: Дополнительные 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
`antialiased`	bool
`backgroundcolor`	цвет
`bbox`	словарь с свойствами для `patches.FancyBboxPatch`
`clip_box`	неизвестно
`clip_on`	неизвестно
`clip_path`	неизвестно
`color` или c	цвет
`figure`	`Figure`
`fontfamily` или family или fontname	{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	{'left', 'center', 'right'}
`in_layout`	bool
`label`	объект
`linespacing`	число с плавающей точкой (кратное размеру шрифта)
`math_fontfamily`	строка
`mouseover`	bool
`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	{'baseline', 'bottom', 'center', 'center_baseline', 'top'}

`visible`	bool
`wrap`	bool
`x`	float
`y`	float
`zorder`	float

См. также

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 означает неизменность.

matplotlib.figure.figaspect(arg)[source]

Вычислить ширину и высоту фигуры с заданным соотношением сторон.

В то время как высота берется из rcParams["figure.figsize"] (по умолчанию: [6.4, 4.8]), ширина корректируется для соответствия требуемому соотношению сторон. Кроме того, гарантируется, что ширина находится в диапазоне [4., 16.], а высота — в диапазоне [2., 16.]. При необходимости, высота по умолчанию корректируется для обеспечения этого.

Параметры:

argfloat или 2D массив: Если float, он определяет соотношение сторон (т. е. отношение высота / ширина). В случае массива соотношение сторон — это количество строк / количество столбцов, так что массив может быть размещён в фигуре без искажений.

Возвращает:

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)