matplotlib.figure.Figure
-
class matplotlib.figure.Figure(figsize=None, dpi=None, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None, constrained_layout=None)[source] -
Bases:
matplotlib.artist.ArtistОсновной контейнер для всех элементов графика.
Экземпляр Figure поддерживает обратные вызовы через атрибут callbacks, который является экземпляром
CallbackRegistry. События, к которым можно подключиться, это 'dpi_changed', и обратный вызов будет вызван сfunc(fig), где fig — экземплярFigure.Атрибуты: - patch
-
Экземпляр
Rectangle, представляющий область фона графика. - suppressComposite
-
Для нескольких изображений графика фигура будет создавать составные изображения в зависимости от функции параметра рендеринга option_image_nocomposite. Если suppressComposite — булево значение, это переопределит рендерер.
Параметры: -
figsize2-tuple of floats, default: rcParams["figure.figsize"] (default: [6.4, 4.8]) -
Размер графика
(width, height)в дюймах. -
dpifloat, default: rcParams["figure.dpi"] (default: 100.0) -
Точки на дюйм.
-
facecolordefault: rcParams["figure.facecolor"] (default: 'white') -
Цвет заливки области графика.
-
edgecolordefault: rcParams["figure.edgecolor"] (default: 'white') -
Цвет обводки области графика.
-
linewidthfloat -
Ширина линии рамки (т.е. ширина линии обводки области графика).
-
frameonbool, default: rcParams["figure.frameon"] (default: True) -
Если
False, подавить отрисовку области фона графика. -
subplotparsSubplotParams -
Параметры подграфиков. Если не указаны, используются параметры подграфиков по умолчанию
rcParams["figure.subplot.*"]. -
tight_layoutbool or dict, default: rcParams["figure.autolayout"] (default: False) -
Если
False, использовать subplotpars. ЕслиTrue, настроить параметры подграфиков с помощьюtight_layoutс отступами по умолчанию. При указании словаря, содержащего ключиpad,w_pad,h_pad, иrect, отступы по умолчаниюtight_layoutбудут переопределены. -
constrained_layoutbool, default: rcParams["figure.constrained_layout.use"] (default: False) -
Если
True, использовать ограниченное расположение для настройки позиционирования элементов графика. Подобноtight_layout, но разработано для большей гибкости. Примеры см. в Руководстве по ограниченному расположению. (Примечание: не работает сadd_subplotилиsubplot2grid.)
-
__getstate__(self)[source]
-
__init__(self, figsize=None, dpi=None, facecolor=None, edgecolor=None, linewidth=0.0, frameon=None, subplotpars=None, tight_layout=None, constrained_layout=None)[source] -
Параметры: -
figsize2-tuple of floats, default: rcParams["figure.figsize"] (default: [6.4, 4.8]) -
Размер графика
(width, height)в дюймах. -
dpifloat, default: rcParams["figure.dpi"] (default: 100.0) -
Точки на дюйм.
-
facecolordefault: rcParams["figure.facecolor"] (default: 'white') -
Цвет заливки области графика.
-
edgecolordefault: rcParams["figure.edgecolor"] (default: 'white') -
Цвет обводки области графика.
-
linewidthfloat -
Ширина линии рамки (т.е. ширина линии обводки области графика).
-
frameonbool, default: rcParams["figure.frameon"] (default: True) -
Если
False, подавить отрисовку области фона графика. -
subplotparsSubplotParams -
Параметры подграфиков. Если не указаны, используются параметры подграфиков по умолчанию
rcParams["figure.subplot.*"]. -
tight_layoutbool or dict, default: rcParams["figure.autolayout"] (default: False) -
Если
False, использовать subplotpars. ЕслиTrue, настроить параметры подграфиков с помощьюtight_layoutс отступами по умолчанию. При указании словаря, содержащего ключиpad,w_pad,h_pad, иrect, отступы по умолчаниюtight_layoutбудут переопределены. -
constrained_layoutbool, default: rcParams["figure.constrained_layout.use"] (default: False) -
Если
True, использовать ограниченное расположение для настройки позиционирования элементов графика. Подобноtight_layout, но разработано для большей гибкости. Примеры см. в Руководстве по ограниченному расположению. (Примечание: не работает сadd_subplotилиsubplot2grid.)
-
-
__module__ = 'matplotlib.figure'
-
__repr__(self)[source] -
Возвращает repr(self).
-
__setstate__(self, state)[source]
-
__str__(self)[source] -
Возвращает str(self).
-
add_artist(self, artist, clip=False)[source] -
Добавить
Artistв график.Обычно элементы добавляются в объекты осей с помощью
Axes.add_artist; этот метод можно использовать в редких случаях, когда необходимо добавить элементы непосредственно в график.Параметры: -
artistArtist -
Элемент для добавления в график. Если у добавленного элемента нет ранее установленного преобразования, его преобразование будет установлено в
figure.transFigure. -
clipbool, default: False -
Нужно ли обрезать добавленный элемент по области графика?
Возвращает: -
Artist -
Добавленный элемент.
-
-
add_axes(self, *args, **kwargs)[source] -
Добавить область координат на график.
Варианты вызова:
add_axes(rect, projection=None, polar=False, **kwargs) add_axes(ax)
Параметры: -
rectsequence of float -
Размеры [слева, снизу, ширина, высота] новой области координат. Все величины задаются в долях ширины и высоты графика.
-
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional -
Тип проекции для
Axes. str — имя пользовательской проекции, см.projections. По умолчанию None, что соответствует 'прямолинейной' проекции. -
polarbool, default: False -
Если True, эквивалентно projection='polar'.
-
sharex, shareyAxes, optional -
Делится с sharex и/или sharey по осям x или y. Ось будет иметь те же пределы, деления и масштаб, что и ось совмещенной области координат.
-
labelstr -
Метка для возвращенной области координат.
Возвращает: -
Axes, or a subclass ofAxes -
Возвращаемый класс области координат зависит от используемой проекции. Это
Axes, если используется прямолинейная проекция, иprojections.polar.PolarAxes, если полярная.
Другие параметры: - **kwargs
-
Этот метод также принимает ключевые аргументы для возвращаемого класса области координат. Ключевые аргументы для класса прямолинейной области координат
Axesможно найти в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция, см. фактический класс области координат.
-
-
Свойство Описание adjustable{'box', 'datalim'} agg_filterфункция фильтра, которая принимает массив чисел с плавающей точкой размера (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой размера (m, n, 3) alphaчисло с плавающей точкой или None anchor2-кортеж чисел с плавающей точкой или {'C', 'SW', 'S', 'SE', ...} animatedлогическое значение aspect{'auto'} или число autoscale_onлогическое значение autoscalex_onлогическое значение autoscaley_onлогическое значение axes_locatorФункция, принимающая [Axes, Renderer] и возвращающая Bbox axisbelowлогическое значение или 'line' box_aspectNone или число clip_boxBboxclip_onлогическое значение clip_pathОбъект Patch или (Path, Transform) или None containsнеизвестно facecolorили fcцвет figureFigureframe_onлогическое значение gidстрока in_layoutлогическое значение labelобъект navigateлогическое значение navigate_modeнеизвестно path_effectsAbstractPathEffectpickerNone или логическое значение или вызываемая функция position[левый, нижний, ширина, высота] или Bboxprop_cycleнеизвестно rasterization_zorderчисло с плавающей точкой или None rasterizedлогическое значение или None sketch_params(масштаб: число, длина: число, случайность: число) snapлогическое значение или None titleстрока transformTransformurlстрока visibleлогическое значение xboundнеизвестно xlabelстрока xlim(нижняя: число, верхняя: число) xmarginчисло больше -0.5 xscale{"линейный", "логарифмический", "симлогарифмический", "логит", ...} xticklabelsнеизвестно xticksнеизвестно yboundнеизвестно ylabelстрока ylim(нижняя: число, верхняя: число) ymarginчисло больше -0.5
yscale{"линейный", "логарифмический", "симлогарифмический", "логит", ...} yticklabelsнеизвестно yticksнеизвестно zorderвещественное число
Примечания
Если в графике уже есть ось с ключом (args, kwargs), то она просто станет текущей и вернётся. Это поведение устарело. В то же время, если вы не хотите этого поведения (т. е. хотите принудительно создать новую ось), вы должны использовать уникальный набор аргументов args и kwargs. Атрибут оси label был добавлен для этой цели: если вы хотите добавить две оси, которые в остальном идентичны в график, убедитесь, что вы дали им уникальные метки.
В редких случаях
add_axesможет быть вызван с одним аргументом, экземпляром оси, уже созданным в текущем графике, но не в списке осей графика.Примеры
Некоторые простые примеры:
rect = l, b, w, h fig = plt.figure() fig.add_axes(rect, label=label1) fig.add_axes(rect, label=label2) 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(self, func)[source] -
При каждом изменении состояния оси будет вызван
func(self).
-
add_gridspec(self, nrows=1, ncols=1, **kwargs)[source] -
Возвращает
GridSpec, у которого этот график является родителем. Это позволяет сложное расположение осей в графике.Параметры: -
nrowsint, default: 1 -
Количество строк в сетке.
-
ncolsint, default: 1 -
Количество столбцов в сетке.
Возвращает: Другие параметры: - **kwargs
-
Ключевые аргументы передаются в
GridSpec.
См. также
Примеры
Добавление подграфика, занимающего две строки:
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_subplot(self, *args, **kwargs)[source] -
Добавляет
Axesв график как часть расположения подграфиков.Вызов:
add_subplot(nrows, ncols, index, **kwargs) add_subplot(pos, **kwargs) add_subplot(ax) add_subplot()
Параметры: -
*argsint, (int, int, index), or SubplotSpec, default: (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может быть вызван с одним аргументом, экземпляром подграфика, уже созданным в текущем графике, но не в списке осей графика. - Три целых числа (nrows, ncols, index). Подграфик займёт позицию index на сетке с nrows строками и ncols столбцами. index начинается с 1 в верхнем левом углу и увеличивается вправо. index также может быть двумерной парой, задающей индексы (first, last) подграфика (1-основанные, включая last), например,
-
projection{None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', 'rectilinear', str}, optional -
Тип проекции подграфика (
Axes). str — имя пользовательской проекции, см.projections. По умолчанию None соответствует проекции 'прямолинейной'. -
polarbool, default: False -
Если True, эквивалентно projection='polar'.
-
sharex, shareyAxes, optional -
Общий x или y
axisс sharex и/или sharey. Ось будет иметь те же пределы, деления и масштаб, что и ось общей оси. -
labelstr -
Метка возвращаемой оси.
Возвращает: -
axes.SubplotBase, or another subclass ofAxes -
Ось подграфика. Возвращаемый базовый класс оси зависит от используемой проекции. Это
Axes, если используется прямолинейная проекция, иprojections.polar.PolarAxes, если используется полярная проекция. Возвращаемая ось является подклассом базового класса для подграфика.
Другие параметры: - **kwargs
-
Этот метод также принимает ключевые аргументы для возвращаемого базового класса оси; за исключением аргумента figure. Ключевые аргументы для прямолинейного базового класса
Axesможно найти в следующей таблице, но могут быть и другие ключевые аргументы, если используется другая проекция.
-
Свойство Описание adjustable{'box', 'datalim'} agg_filterфункция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) alphafloat или None anchor2-кортеж чисел с плавающей точкой или {'C', 'SW', 'S', 'SE', ...} animatedbool aspect{'auto'} или число autoscale_onbool autoscalex_onbool autoscaley_onbool axes_locatorCallable[[Axes, Renderer], Bbox] axisbelowbool или 'line' box_aspectNone или число clip_boxBboxclip_onbool clip_pathPatch или (Path, Transform) или None containsнеизвестно facecolorили fcцвет figureFigureframe_onbool gidстрока in_layoutbool labelобъект navigatebool navigate_modeнеизвестно path_effectsAbstractPathEffectpickerNone или bool или вызываемая функция position[left, bottom, width, height] или Bboxprop_cycleнеизвестно rasterization_zorderfloat или None rasterizedbool или None sketch_params(scale: float, length: float, randomness: float) snapbool или None titleстрока transformTransformurlстрока visiblebool xboundнеизвестно xlabelстрока xlim(нижняя: float, верхняя: float) xmarginfloat больше -0.5 xscale{"линейный", "логарифмический", "симлогарифмический", "логит", ...} xticklabelsнеизвестно xticksнеизвестно yboundнеизвестно ylabelстрока ylim(нижняя: float, верхняя: float) ymarginfloat больше -0.5
yscale{"linear", "log", "symlog", "logit", ...} yticklabelsнеизвестно yticksнеизвестно zorderfloat
Примечания
Если в фигуре уже есть подграфик с ключом (args, kwargs), то он просто сделает этот подграфик текущим и вернет его. Это поведение устарело. В то же время, если вы не хотите этого поведения (т.е. хотите принудительно создать новый подграфик), вы должны использовать уникальный набор args и kwargs. Атрибут label осей был добавлен для этой цели: если вы хотите добавить в фигуру два подграфика, которые в остальном идентичны, убедитесь, что вы дали им уникальные метки.
Примеры
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(self, axs=None)[source] -
Выравнивает метки x и y подграфиков с одинаковым рядом или столбцом подграфиков (соответственно), если выравнивание меток выполняется автоматически (т.е. положение метки не задано вручную).
Выравнивание сохраняется для событий рисования после вызова.
Параметры: -
axslist of Axes -
Необязательный список (или массив ndarray)
Axesдля выравнивания меток. По умолчанию выравниваются все оси на фигуре.
-
-
align_xlabels(self, axs=None)[source] -
Выравнивает метки x подграфиков в том же столбце подграфиков, если выравнивание меток выполняется автоматически (т.е. положение метки не задано вручную).
Выравнивание сохраняется для событий рисования после вызова.
Если метка находится внизу, она выравнивается с метками на осях, которые также имеют метку внизу и имеют тот же самый нижний ряд подграфиков. Если метка находится вверху, она выравнивается с метками на осях с тем же самым верхним рядом.
Параметры: -
axslist of Axes -
Необязательный список (или массив ndarray)
Axesдля выравнивания меток x. По умолчанию выравниваются все оси на фигуре.
Примечания
Предполагается, что
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(self, axs=None)[source] -
Выравнивает метки y подграфиков в том же столбце подграфиков, если выравнивание меток выполняется автоматически (т.е. положение метки не задано вручную).
Выравнивание сохраняется для событий рисования после вызова.
Если метка находится слева, она выравнивается с метками на осях, которые также имеют метку слева и имеют тот же самый левый столбец подграфиков. Если метка находится справа, она выравнивается с метками на осях с тем же самым правым столбцом.
Параметры: -
axslist of Axes -
Необязательный список (или массив ndarray)
Axesдля выравнивания меток y. По умолчанию выравниваются все оси на фигуре.
Примечания
Предполагается, что
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(self, bottom=0.2, rotation=30, ha='right', which='major')[source] -
Метки даты на оси x часто перекрываются, поэтому полезно повернуть их и выровнять по правому краю. Также распространенным случаем является несколько подграфиков с общими осями x, где ось x содержит данные дат. Метки часто длинные, и это помогает повернуть их в нижнем подграфике и отключить их в других подграфиках, а также отключить метки оси x.
Параметры: -
bottomfloat, default: 0.2 -
Нижняя часть подграфиков для
subplots_adjust. -
rotationfloat, default: 30 degrees -
Угол поворота меток xtick в градусах.
-
ha{'left', 'center', 'right'}, default: 'right' -
Горизонтальное выравнивание меток xtick.
-
which{'major', 'minor', 'both'}, default: 'major' -
Выбирает, какие метки повернуть.
-
-
property axes -
Список осей на фигуре. Вы можете получить доступ к осям и изменить их в фигуре через этот список.
Не изменяйте сам список. Вместо этого используйте "
add_axes,add_subplotилиdelaxesдля добавления или удаления осей.
-
clear(self, keep_observers=False)[source] -
Очистить фигуру — синоним для
clf.
-
clf(self, keep_observers=False)[source] -
Очистить фигуру.
Установите keep_observers в True, если, например, виджет gui отслеживает оси на фигуре.
-
colorbar(self, mappable, cax=None, ax=None, use_gridspec=True, **kw)[source] -
Создайте полосу цвета для экземпляра ScalarMappable, mappable.
Документация для тонкого обёртки pyplot:
Добавить полосу цвета к графику.
Подписи функций для интерфейса
pyplot; все, кроме первой, также являются подписями методов для методаcolorbar:colorbar(**kwargs) colorbar(mappable, **kwargs) colorbar(mappable, cax=cax, **kwargs) colorbar(mappable, ax=ax, **kwargs)
Параметры: - mappable
-
matplotlib.cm.ScalarMappable(т.е.,AxesImage,ContourSetи т.д.), описываемый этой полосой цвета. Этот аргумент является обязательным для методаFigure.colorbar, но необязательным для функцииpyplot.colorbar, которая устанавливает значение по умолчанию на текущем изображении.Обратите внимание, что можно создать
ScalarMappable«на лету», чтобы создать полосы цвета, не привязанные к ранее нарисованному элементу, например:fig.colorbar(cm.ScalarMappable(norm=norm, cmap=cmap), ax=ax)
-
caxAxes, optional -
Ось, на которой будет нарисована полоса цвета.
-
axAxes, list of Axes, optional -
Родительская ось, из которой будет отобрано пространство для новой оси полосы цвета. Если указан список осей, все они будут изменены в размерах, чтобы освободить место для оси полосы цвета.
-
use_gridspecbool, optional -
Если cax —
None, новая cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec —True, cax создается как экземпляр Subplot с использованием модуляgridspec.
Возвращает: -
colorbarColorbar -
См. также базовый класс
ColorbarBase.
Примечания
Дополнительные ключевые аргументы бывают двух типов:
свойства осей:
-
fractionfloat, default: 0.15 - Доля исходной оси, используемая для полосы цвета.
-
shrinkfloat, default: 1.0 - Доля, на которую нужно умножить размер полосы цвета.
-
aspectfloat, default: 20 - Соотношение длинных и коротких размеров.
-
padfloat, default: 0.05 if vertical, 0.15 if horizontal - Доля исходной оси между полосой цвета и новыми осями изображения.
-
anchor(float, float), optional - Точка привязки оси полосы цвета. По умолчанию (0,0, 0,5) для вертикальной; (0,5, 1,0) для горизонтальной.
-
panchor(float, float), or False, optional - Точка привязки родительской оси полосы цвета. Если False, точка привязки родительской оси не изменяется. По умолчанию (1,0, 0,5) для вертикальной; (0,5, 0,0) для горизонтальной.
свойства полосы цвета:
Свойство Описание extend {'ничего', 'оба', 'мин', 'макс'} Если не 'ничего', создать наклонённые концы для значений вне диапазона. Они устанавливаются для заданной цветовой карты с использованием методов set_under и set_over цветовой карты. extendfrac {None, 'auto', длина, длины} Если None, минимальное и максимальное треугольные расширения полосы цвета будут иметь длину 5% от длины внутренней полосы цвета (это значение по умолчанию). Если 'auto', устанавливает длину треугольных расширений полосы цвета равной длинам внутренних прямоугольников (когда spacing установлен в 'uniform') или равной длинам соответствующих соседних внутренних прямоугольников (когда spacing установлен в 'proportional'). Если скаляр, указывает длину минимального и максимального треугольных расширений полосы цвета как дробь от длины внутренней полосы цвета. Также может быть задана двухелементная последовательность дробей, указывающая длины минимального и максимального расширений полосы цвета соответственно как дробь от длины внутренней полосы цвета. extendrect bool Если False, минимальное и максимальное расширения полосы цвета будут треугольными (по умолчанию). Если True, расширения будут прямоугольными. spacing {'равномерный', 'пропорциональный'} Равномерное распределение даёт каждому дискретному цвету одинаковое пространство; пропорциональное — делает пространство пропорциональным интервалу данных. ticks None или список меток или Locator Если None, метки определяются автоматически из ввода. format None или str или Formatter Если None, используется ScalarFormatter. Если задана строка форматирования, например, '%.3f', она используется. Вместо этого можно указать альтернативныйFormatter.drawedges bool Рисовать ли линии на границах цветов. label str Метка по длинной оси полосы цвета. Следующее, вероятно, будет полезно только в контексте индексированных цветов (то есть, когда у mappable norm=NoNorm()), или в других необычных обстоятельствах.
Свойство Описание boundaries None или последовательность values None или последовательность, длина которой на 1 меньше, чем последовательность boundaries. Для каждого региона, ограниченного соседними элементами в boundaries, будет использоваться цвет, сопоставленный соответствующему значению в values. Если mappable —
ContourSet, его параметр extend автоматически включён.Параметр shrink предоставляет простой способ масштабирования полосы цвета относительно осей. Обратите внимание, что если указан cax, он определяет размер полосы цвета, и параметры shrink и aspect игнорируются.
Для более точного управления вы можете вручную указать позиции объектов осей, на которых нарисованы mappable и полоса цвета. В этом случае не используйте параметры осей.
Известно, что некоторые просмотрщики векторной графики (svg и pdf) отображают белые пробелы между сегментами полосы цвета. Это связано с ошибками в просмотрщиках, а не с Matplotlib. Как временное решение, полоса цвета может быть отображена с перекрывающимися сегментами:
cbar = colorbar() cbar.solids.set_edgecolor("face") draw()Однако это имеет негативные последствия в других обстоятельствах, например, с полупрозрачными изображениями (alpha < 1) и расширениями полосы цвета; поэтому это временное решение не используется по умолчанию (см. выпуск #1188).
-
contains(self, mouseevent)[source] -
Проверить, произошла ли обработка события мыши на рисунке.
Возвращает: - bool, {}
-
delaxes(self, ax)[source] -
Удалить
Axesax из рисунка; обновить текущую ось.
-
property dpi -
Разрешение в точках на дюйм.
-
draw(self, renderer)[source] -
Отрисовать элемент-артист (и его потомков) с использованием данного рендерера.
Это не имеет эффекта, если элемент-артист не отображается (
Artist.get_visibleвозвращает False).Параметры: -
rendererRendererBase subclass.
Примечания
Этот метод переопределяется в подклассах элементов-артистов.
-
-
draw_artist(self, a)[source] -
Только отрисовать экземпляр
Artista.Этот метод можно вызывать только после отрисовки рисунка.
-
-
execute_constrained_layout(self, renderer=None)[source] -
Используйте
layoutboxдля определения позиций pos внутри осей.См. также
set_constrained_layout_pads.
-
figimage(self, X, xo=0, yo=0, alpha=None, norm=None, cmap=None, vmin=None, vmax=None, origin=None, resize=False, **kwargs)[source] -
Добавление необработанного изображения в рисунок.
Изображение прикрепляется к нижнему или верхнему левому углу в зависимости от origin.
Параметры: - X
-
Данные изображения. Это массив одного из следующих типов:
- MxN: значения яркости (серого цвета)
- MxNx3: значения RGB
- MxNx4: значения RGBA
-
xo, yoint -
Смещение изображения по x/y в пикселях.
-
alphaNone or float -
Значение альфа-смешивания.
-
normmatplotlib.colors.Normalize -
Экземпляр
Normalizeдля сопоставления яркости с интервалом [0, 1]. -
cmapstr or matplotlib.colors.Colormap, default: rcParams["image.cmap"] (default: 'viridis') -
Цветовая карта для использования.
-
vmin, vmaxfloat -
Если norm не задан, эти значения устанавливают пределы данных для цветовой карты.
-
origin{'upper', 'lower'}, default: rcParams["image.origin"] (default: 'upper') -
Указывает, где индекс [0, 0] массива находится в верхнем левом или нижнем левом углу осей.
-
resizebool -
Если True, размер фигуры изменяется для соответствия заданному размеру изображения.
Возвращает: Другие параметры: - **kwargs
-
Дополнительные kwargs - это
Artistkwargs, передаваемыеFigureImage.
Примечания
figimage дополняет изображение осей (
imshow), которое будет пересэмплировано для соответствия текущим осям. Если вы хотите пересэмплированное изображение, заполняющее всю фигуру, вы можете определитьAxesс extents [0, 0, 1, 1].Примеры
f = plt.figure() nx = int(f.get_figwidth() * f.dpi) ny = int(f.get_figheight() * f.dpi) data = np.random.random((ny, nx)) f.figimage(data) plt.show()
-
property frameon -
Возвращает видимость фонового патча фигуры, т. е. будет ли нарисован фоновый цвет фигуры. Эквивалентно
Figure.patch.get_visible().
-
gca(self, **kwargs)[source] -
Получить текущие оси, создав их при необходимости.
Для обеспечения соответствия возвращаемых осей заданным проекциям и т. д., а также для создания осей, если активные оси не существуют, поддерживаются следующие параметры:
-
Свойство Описание adjustable{'box', 'datalim'} agg_filterфункция фильтра, принимающая массив (m, n, 3) чисел с плавающей точкой и значение dpi, и возвращающая массив (m, n, 3) alphaчисло с плавающей точкой или None anchor2-кортеж чисел с плавающей точкой или {'C', 'SW', 'S', 'SE', ...} animatedбулево значение aspect{'auto'} или число autoscale_onбулево значение autoscalex_onбулево значение autoscaley_onбулево значение axes_locatorCallable[[Axes, Renderer], Bbox] axisbelowбулево значение или 'line' box_aspectNone или число clip_boxBboxclip_onбулево значение clip_pathPatch или (Path, Transform) или None containsнеизвестно facecolorили fcцвет figureFigureframe_onбулево значение gidстрока in_layoutбулево значение labelобъект navigateбулево значение navigate_modeнеизвестно path_effectsAbstractPathEffectpickerNone или булево значение или вызываемый объект position[left, bottom, width, height] или Bboxprop_cycleнеизвестно rasterization_zorderчисло с плавающей точкой или None rasterizedбулево значение или None sketch_params(scale: число с плавающей точкой, length: число с плавающей точкой, randomness: число с плавающей точкой) snapбулево значение или None titleстрока transformTransformurlстрока visibleбулево значение xboundнеизвестно xlabelстрока xlim(нижняя граница: число с плавающей точкой, верхняя граница: число с плавающей точкой) xmarginчисло с плавающей точкой, большее чем -0.5 xscale{"linear", "log", "symlog", "logit", ...} xticklabelsнеизвестно xticksнеизвестно yboundнеизвестно ylabelстрока ylim(нижняя граница: число с плавающей точкой, верхняя граница: число с плавающей точкой) ymarginчисло с плавающей точкой, большее чем -0.5 yscale{"linear", "log", "symlog", "logit", ...}
yticklabelsunknown yticksunknown zorderfloat
-
get_axes(self)[source] -
Возвращает список осей в Figure. Вы можете получить доступ к осям в Figure и изменить их с помощью этого списка.
Не изменяйте сам список. Вместо этого используйте
add_axes,add_subplotилиdelaxesдля добавления или удаления оси.Примечание: Это эквивалентно свойству
axes.
-
get_children(self)[source] -
Возвращает список элементов, содержащихся в фигуре.
-
get_constrained_layout(self)[source] -
Возвращает, используется ли ограниченное расположение.
-
get_constrained_layout_pads(self, relative=False)[source] -
Получение отступов для
constrained_layout.Возвращает список
w_pad, h_padв дюймах иwspaceиhspaceв долях подграфика.См. Руководство по ограниченному расположению.
Параметры: -
relativebool -
Если
True, то преобразовать из дюймов в относительные к фигуре.
-
-
get_default_bbox_extra_artists(self)[source]
-
get_dpi(self)[source] -
Возвращает разрешение в точках на дюйм в виде числа с плавающей точкой.
-
get_edgecolor(self)[source] -
Получить цвет рамки прямоугольника Figure.
-
get_facecolor(self)[source] -
Получить цвет заливки прямоугольника Figure.
-
get_figheight(self)[source] -
Возвращает высоту фигуры в дюймах.
-
get_figwidth(self)[source] -
Возвращает ширину фигуры в дюймах.
-
get_frameon(self)[source] -
Возвращает видимость фонового патча фигуры, т.е. будет ли отрисовываться фон фигуры. Эквивалентно
Figure.patch.get_visible().
-
get_size_inches(self)[source] -
Возвращает текущий размер фигуры в дюймах.
Возвращает: - ndarray
-
Размер фигуры (ширина, высота) в дюймах.
См. также
Примечания
Размер в пикселях можно получить, умножив на
Figure.dpi.
-
get_tight_layout(self)[source] -
Возвращает, вызывается ли
tight_layoutпри отрисовке.
-
get_tightbbox(self, renderer, bbox_extra_artists=None)[source] -
Возвращает (уплотненную) область фигуры в дюймах.
Элементы, у которых
artist.set_in_layout(False)не включены в область.Параметры: -
rendererRendererBase subclass -
рендерер, который будет использоваться для отрисовки фигур (т.е.
fig.canvas.get_renderer()) -
bbox_extra_artistslist of Artist or None -
Список элементов, которые должны быть включены в уплотненную область. Если
None(по умолчанию), то все дочерние элементы каждого графика включены в уплотненную область.
Возвращает: -
BboxBase -
содержащая область (в дюймах фигуры).
-
-
get_window_extent(self, *args, **kwargs)[source] -
Возвращает область фигуры в пространстве отображения. Аргументы игнорируются.
-
ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=<MouseButton.LEFT: 1>, mouse_pop=<MouseButton.RIGHT: 3>, mouse_stop=<MouseButton.MIDDLE: 2>)[source] -
Блокирующий вызов для взаимодействия с фигурой.
Ожидает, пока пользователь n раз щелкнет по фигуре, и возвращает координаты каждого щелчка в списке.
Возможны три типа взаимодействий:
- Добавление точки.
- Удаление последней добавленной точки.
- Остановка взаимодействия и возврат добавленных до сих пор точек.
Действия присваиваются кнопкам мыши через аргументы mouse_add, mouse_pop и mouse_stop.
Параметры: -
nint, default: 1 -
Количество щелчков мышью для накопления. Если отрицательное, то накопление щелчков происходит до тех пор, пока ввод не будет завершён вручную.
-
timeoutfloat, default: 30 seconds -
Количество секунд ожидания перед таймаутом. Если ноль или отрицательное значение, таймаут никогда не наступит.
-
show_clicksbool, default: True -
Если True, отображает красный крест в месте каждого щелчка.
-
mouse_addMouseButton or None, default: MouseButton.LEFT -
Кнопка мыши, используемая для добавления точек.
-
mouse_popMouseButton or None, default: MouseButton.RIGHT -
Кнопка мыши, используемая для удаления последней добавленной точки.
-
mouse_stopMouseButton or None, default: MouseButton.MIDDLE -
Кнопка мыши, используемая для остановки ввода.
Возвращает: - список кортежей
-
Список координат щелчков (x, y).
Примечания
Клавиатура также может использоваться для выбора точек, если у вашей мыши отсутствует одна или несколько кнопок. Кнопки "Delete" и "Backspace" действуют как щелчки правой кнопкой мыши (т.е. удаляют последнюю точку), клавиша "Enter" завершает ввод, а любая другая клавиша (не используемая менеджером окон) выбирает точку.
-
init_layoutbox(self)[source] -
Инициализирует layoutbox для использования в constrained_layout.
-
-
legend(self, *args, **kwargs)[source] -
Размещение легенды на рисунке.
Для создания легенды из существующих элементов на каждом осевом графике:
legend()
Для создания легенды для списка линий и меток:
legend( (line1, line2, line3), ('label1', 'label2', 'label3'), loc='upper right')Эти значения также можно указать в качестве ключевых слов:
legend( handles=(line1, line2, line3), labels=('label1', 'label2', 'label3'), loc='upper right')Параметры: -
handleslist of Artist, optional -
Список элементов (линий, областей) для добавления в легенду. Используйте вместе с labels, если вам нужен полный контроль над отображаемыми элементами в легенде, а автоматический механизм недостаточен.
Длина элементов и меток должна быть одинаковой в этом случае. Если это не так, они обрезаются до меньшей длины.
-
labelslist of str, optional -
Список меток, которые будут отображаться рядом с элементами. Используйте вместе с handles, если вам нужен полный контроль над отображаемыми элементами в легенде, а автоматический механизм недостаточен.
Возвращает: Другие параметры: -
locstr or pair of floats, default: rcParams["legend.loc"] (default: 'best') ('best' for axes, 'upper right' for figures) -
Расположение легенды.
Строки
'upper left', 'upper right', 'lower left', 'lower right'размещают легенду в соответствующем углу области/рисунка.Строки
'upper center', 'lower center', 'center left', 'center right'размещают легенду в центре соответствующего края области/рисунка.Строка
'center'размещает легенду в центре области/рисунка.Строка
'best'размещает легенду в положении, среди девяти определённых ранее положений, с минимальным перекрытием с другими нарисованными элементами. Этот вариант может быть достаточно медленным для графиков с большим количеством данных; скорость построения графиков может увеличиться, если указать конкретное расположение.Расположение также может быть 2-кортежем, задающим координаты левого нижнего угла легенды в координатах области (в этом случае bbox_to_anchor будет проигнорирован).
Для обратной совместимости,
'center right'(но не другие расположения) также могут быть написаны как'right', и каждое «строковое» расположение также может быть задано числовым значением:Строковое расположение Код расположения 'best' 0 'верхний правый' 1 'верхний левый' 2 'нижний левый' 3 'нижний правый' 4 'правый' 5 'центр слева' 6 'центр справа' 7 'нижний центр' 8 'верхний центр' 9 'центр' 10 -
bbox_to_anchorBboxBase, 2-tuple, or 4-tuple of floats -
Прямоугольник, используемый для позиционирования легенды совместно с loc. По умолчанию
axes.bbox(если вызван как методAxes.legend) илиfigure.bbox(еслиFigure.legend). Этот аргумент позволяет произвольное размещение легенды.Координаты прямоугольника интерпретируются в системе координат, заданной bbox_transform, с преобразованием по умолчанию для области или рисунка в зависимости от того, к какому
legendвы обратились.Если задан 4-кортеж или
BboxBase, то он задаёт прямоугольник(x, y, width, height), в который помещается легенда. Чтобы поместить легенду в лучшее место в нижнем правом квадранте области (или рисунка):loc='best', bbox_to_anchor=(0.5, 0., 0.5, 0.5)
2-кортеж
(x, y)помещает угол легенды, указанный loc, в точку x, y. Например, чтобы поместить верхний правый угол легенды в центр области (или рисунка), можно использовать следующие ключевые слова:loc='upper right', bbox_to_anchor=(0.5, 0.5)
-
ncolint, default: 1 -
Количество столбцов в легенде.
-
propNone or matplotlib.font_manager.FontProperties or dict -
Свойства шрифта легенды. Если None (по умолчанию), будут использоваться текущие
matplotlib.rcParams. -
fontsizeint or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} -
Размер шрифта легенды. Если значение является числом, размер будет абсолютным размером шрифта в пунктах. Строковые значения относятся к текущему размеру шрифта по умолчанию. Этот аргумент используется только если prop не указан.
-
labelcolorstr or list -
Устанавливает цвет текста в легенде. Может быть строкой допустимого цвета (например, 'red'), или списком строк цветов. Цвет метки также может быть настроен для соответствия цвету линии или маркера, используя 'linecolor', 'markerfacecolor' (или 'mfc'), или 'markeredgecolor' (или 'mec').
-
numpointsint, default: rcParams["legend.numpoints"] (default: 1) -
Количество точек маркера в легенде при создании записи легенды для
Line2D(линия). -
scatterpointsint, default: rcParams["legend.scatterpoints"] (default: 1) -
Количество точек маркера в легенде при создании записи легенды для
PathCollection(график рассеяния). -
scatteryoffsetsiterable of floats, default: [0.375, 0.5, 0.3125] -
Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды графика рассеяния. 0.0 соответствует основанию текста легенды, а 1.0 — верху. Для вывода всех маркеров на одной высоте установите значение в
[0.5]. -
markerscalefloat, default: rcParams["legend.markerscale"] (default: 1.0) -
Относительный размер маркеров легенды по сравнению с исходно нарисованными.
-
markerfirstbool, default: True -
Если True, маркер легенды размещается слева от метки легенды. Если False, маркер легенды размещается справа от метки легенды.
-
frameonbool, default: rcParams["legend.frameon"] (default: True) -
Необходимо ли рисовать легенду на области (рамке).
-
fancyboxbool, default: rcParams["legend.fancybox"] (default: True) -
Необходимо ли активировать закруглённые углы вокруг
FancyBboxPatch, которые образуют фоновый прямоугольник легенды. -
shadowbool, default: rcParams["legend.shadow"] (default: False) -
Нужно ли рисовать тень за легендой.
-
framealphafloat, default: rcParams["legend.framealpha"] (default: 0.8) -
Альфа-прозрачность фона легенды. Если shadow активирован, и framealpha
None, значение по умолчанию будет проигнорировано. -
facecolor"inherit" or color, default: rcParams["legend.facecolor"] (default: 'inherit') -
Цвет фона легенды. Если
"inherit", использоватьrcParams["axes.facecolor"](по умолчанию:'white'). -
edgecolor"inherit" or color, default: rcParams["legend.edgecolor"] (default: '0.8') -
Цвет границы прямоугольника фона легенды. Если
"inherit", использоватьrcParams["axes.edgecolor"](по умолчанию:'black'). -
mode{"expand", None} -
Если mode установлен в
"expand", легенда будет горизонтально расширена для заполнения области осей (или bbox_to_anchor, если определяет размер легенды). -
bbox_transformNone or matplotlib.transforms.Transform -
Преобразование для прямоугольника (bbox_to_anchor). Для значения
None(по умолчанию) будет использоваться преобразование области осейtransAxes. -
titlestr or None -
Заголовок легенды. По умолчанию заголовок отсутствует (
None). -
title_fontsizeint or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'}, default: rcParams["legend.title_fontsize"] (default: None) -
Размер шрифта заголовка легенды.
-
borderpadfloat, default: rcParams["legend.borderpad"] (default: 0.4) -
Пробел внутри границы легенды в единицах размера шрифта.
-
labelspacingfloat, default: rcParams["legend.labelspacing"] (default: 0.5) -
Вертикальное расстояние между записями легенды в единицах размера шрифта.
-
handlelengthfloat, default: rcParams["legend.handlelength"] (default: 2.0) -
Длина элементов легенды в единицах размера шрифта.
-
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.
Примечания
Некоторые элементы не поддерживаются этой функцией. Подробности см. в Руководстве по легендам.
-
-
-
savefig(self, fname, *, transparent=None, **kwargs)[source] -
Сохранить текущую фигуру.
Вызов:
savefig(fname, dpi=None, facecolor='w', edgecolor='w', orientation='portrait', papertype=None, format=None, transparent=False, bbox_inches=None, pad_inches=0.1, frameon=None, metadata=None)Доступные форматы вывода зависят от используемого бэкэнда.
Параметры: -
fnamestr or path-like or file-like -
Путь, или объект-подобный файлу Python, или, возможно, объект, зависящий от бэкэнда, такой как
matplotlib.backends.backend_pdf.PdfPages.Если format задан, он определяет формат вывода, и файл сохраняется как fname. Обратите внимание, что fname используется дословно, и не делается попыток согласовать расширение файла fname с format, и никакого расширения не добавляется.
Если format не задан, тогда формат определяется по расширению fname, если оно есть. Если format не задан, и fname не имеет расширения, то файл сохраняется с
rcParams["savefig.format"](по умолчанию'png') и соответствующее расширение добавляется к fname.
Другие параметры: -
dpifloat or 'figure', default: rcParams["savefig.dpi"] (default: 'figure') -
Разрешение в точках на дюйм. Если 'figure', используется значение dpi фигуры.
-
qualityint, default: rcParams["savefig.jpeg_quality"] (default: 95) -
Применимо только если format равен 'jpg' или 'jpeg', в противном случае игнорируется.
Качество изображения в шкале от 1 (худшее) до 95 (лучшее). Значения выше 95 следует избегать; 100 отключает части алгоритма сжатия JPEG и приводит к большим файлам с едва заметным улучшением качества изображения.
Этот параметр устарел.
-
optimizebool, default: False -
Применимо только если format равен 'jpg' или 'jpeg', в противном случае игнорируется.
Нужно ли кодировщику сделать дополнительный проход по изображению для выбора оптимальных параметров кодирования.
Этот параметр устарел.
-
progressivebool, default: False -
Применимо только если format равен 'jpg' или 'jpeg', в противном случае игнорируется.
Изображение должно храниться как прогрессивный JPEG-файл.
Этот параметр устарел.
-
facecolorcolor or 'auto', default: rcParams["savefig.facecolor"] (default: 'auto') -
Цвет заливки фигуры. Если 'auto', используется текущий цвет заливки фигуры.
-
edgecolorcolor or 'auto', default: rcParams["savefig.edgecolor"] (default: 'auto') -
Цвет обводки фигуры. Если 'auto', используется текущий цвет обводки фигуры.
-
orientation{'landscape', 'portrait'} -
В настоящее время поддерживается только бэкэндом postscript.
-
papertypestr -
Один из 'letter', 'legal', 'executive', 'ledger', 'a0' до 'a10', 'b0' до 'b10'. Поддерживается только для вывода в формате postscript.
-
formatstr -
Формат файла, например 'png', 'pdf', 'svg' и т.д. Поведение при отсутствии этого параметра описано в разделе fname.
-
transparentbool -
Если True, все области осей будут прозрачными; область фигуры также будет прозрачной, если не заданы facecolor и/или edgecolor с помощью аргументов kwargs. Это полезно, например, для отображения графика поверх цветного фона на веб-странице. Прозрачность этих областей будет восстановлена до их исходных значений после выхода из этой функции.
-
bbox_inchesstr or Bbox, default: rcParams["savefig.bbox"] (default: None) -
Область в дюймах: сохраняется только указанная часть фигуры. Если 'tight', попытаться определить область tightbbox фигуры.
-
pad_inchesfloat, default: rcParams["savefig.pad_inches"] (default: 0.1) -
Количество отступов вокруг фигуры, когда bbox_inches равен 'tight'.
-
bbox_extra_artistslist of Artist, optional -
Список дополнительных элементов, которые будут учитываться при расчете области tight bbox.
-
backendstr, optional -
Использовать бэкэнд по умолчанию для рендеринга файла, например, для рендеринга файла png с бэкэндом "cairo" вместо значения по умолчанию "agg", или файла pdf с бэкэндом "pgf" вместо значения по умолчанию "pdf". Обратите внимание, что значение по умолчанию обычно достаточно. Список допустимых бэкэндов для каждого формата файла см. в разделе Встроенные бэкэнды. Пользовательские бэкэнды можно ссылаться как "module://...".
-
metadatadict, optional -
Ключевые пары для хранения в метаданных изображения. Поддерживаемые ключи и значения по умолчанию зависят от формата изображения и бэкэнда:
-
pil_kwargsdict, optional -
Дополнительные ключевые аргументы, передаваемые
PIL.Image.Image.saveпри сохранении фигуры.
-
-
sca(self, a)[source] -
Установить текущую ось на a и вернуть a.
-
set_canvas(self, canvas)[source] -
Установить холст, содержащий фигуру
Параметры: -
canvasFigureCanvas
-
-
set_constrained_layout(self, 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 or dict or None
-
-
set_constrained_layout_pads(self, **kwargs)[source] -
Установить отступы для
constrained_layout. Обратите внимание, что kwargs могут быть переданы как словарьfig.set_constrained_layout(**paddict).См. Руководство по ограниченному макетированию.
Параметры: -
w_padfloat -
Отступ по ширине в дюймах. Это отступ вокруг осей и предназначен для обеспечения достаточного места для нормального отображения шрифтов. По умолчанию 3 пункта = 0,04167 дюйма
-
h_padfloat -
Отступ по высоте в дюймах. По умолчанию 3 пункта.
-
wspacefloat -
Отступ по ширине между подграфиками, выраженный как доля ширины подграфика. Общий отступ равен w_pad + wspace.
-
hspacefloat -
Отступ по высоте между подграфиками, выраженный как доля ширины подграфика. Общий отступ равен h_pad + hspace.
-
-
set_dpi(self, val)[source] -
Установить разрешение фигуры в точках на дюйм.
Параметры: -
valfloat
-
-
set_edgecolor(self, color)[source] -
Установить цвет обводки прямоугольника фигуры.
Параметры: -
colorcolor
-
-
-
set_facecolor(self, color)[source] -
Установите цвет заливки прямоугольника Figure.
Параметры: -
colorcolor
-
-
set_figheight(self, val, forward=True)[source] -
Установите высоту фигуры в дюймах.
Параметры: -
valfloat -
forwardbool -
См.
set_size_inches.
-
-
set_figwidth(self, val, forward=True)[source] -
Установите ширину фигуры в дюймах.
Параметры: -
valfloat -
forwardbool -
См.
set_size_inches.
-
-
set_frameon(self, b)[source] -
Установите видимость фоновой области фигуры, т.е. будет ли отрисовываться фон фигуры. Эквивалентно
Figure.patch.set_visible().Параметры: -
bbool
-
-
set_size_inches(self, w, h=None, forward=True)[source] -
Установите размер фигуры в дюймах.
Варианты вызова:
fig.set_size_inches(w, h) # OR fig.set_size_inches((w, h))
Параметры: -
w(float, float) or float -
Ширина и высота в дюймах (если высота не указана как отдельный аргумент) или ширина.
-
hfloat -
Высота в дюймах.
-
forwardbool, default: True -
Если
True, размер холста автоматически обновляется, например, вы можете изменить размер окна фигуры из командной строки.
См. также
Примечания
Чтобы преобразовать пиксели в дюймы, разделите на
Figure.dpi. -
-
set_tight_layout(self, tight)[source] -
Установите, вызывается ли
tight_layoutпри отрисовке и как.Параметры: -
tightbool or dict with keys "pad", "w_pad", "h_pad", "rect" or None -
Если bool, задает, вызывать ли
tight_layoutпри отрисовке. ЕслиNone, используйтеfigure.autolayoutrcparam вместо этого. Если словарь, передайте его как kwargs вtight_layout, переопределяя значения по умолчанию отступов.
-
-
show(self, warn=True)[source] -
Если используется графический бэкэнд с pyplot, отобразите окно фигуры.
Если фигура не была создана с помощью
figure, ей не будет принадлежатьFigureManagerBase, и этот метод вызовет AttributeError.Предупреждение
Это не управляет циклом событий графического интерфейса пользователя. Следовательно, фигура может быть показана ненадолго или вообще не показана, если вы или ваша среда не управляете циклом событий.
Правильные случаи использования для
Figure.showвключают выполнение этого из приложения GUI или оболочки IPython.Если вы запускаете чистую оболочку Python или выполняете скрипт Python без графического интерфейса, вы должны использовать
matplotlib.pyplot.showвместо этого, который позаботится об управлении циклом событий для вас.Параметры: -
warnbool, default: True -
Если
Trueи мы не работаем в бесклавишной среде (т.е. на Linux без установленного DISPLAY), выведите предупреждение при вызове на бэкенде без графического интерфейса.
-
-
-
subplot_mosaic(self, layout, *, subplot_kw=None, gridspec_kw=None, empty_sentinel='.')[source] -
Построение макета осей на основе ASCII-искусства или вложенных списков.
Эта вспомогательная функция для построения сложных макетов GridSpec визуально.
Примечание
Этот API является предварительным и может быть пересмотрен в будущем на основе ранних отзывов пользователей.
Параметры: -
layoutlist of list of {hashable or nested} or str -
Визуальный макет того, как вы хотите расположить свои оси, обозначенные строками. Например
x = [['A panel', 'A panel', 'edge'], ['C panel', '.', 'edge']]Создает 4 оси:
- 'A panel', который имеет высоту 1 строка и охватывает первые два столбца
- 'edge', который имеет высоту 2 строки и находится на правом краю
- 'C panel', который имеет ширину 1 строка и 1 столбец в левом нижнем углу
- пустое место шириной 1 строка и 1 столбец в центре снизу
Любой из элементов макета может быть списком списков той же формы для создания вложенных макетов.
Если входной параметр — строка, то она должна иметь вид
''' AAE C.E '''
где каждый символ — столбец, а каждая строка — строка. Это позволяет использовать только метки осей с одним символом и не допускает вложенности, но очень кратко.
-
subplot_kwdict, optional -
Словарь с ключевыми словами, передаваемыми в вызов
Figure.add_subplotдля создания каждого подграфика. -
gridspec_kwdict, optional -
Словарь с ключевыми словами, передаваемыми в конструктор
GridSpecдля создания сетки, на которой размещаются подграфики. -
empty_sentinelobject, optional -
Элемент в макете, означающий «оставить это место пустым». По умолчанию
'.'. Обратите внимание, что если layout — строка, она обрабатывается с помощьюinspect.cleandocдля удаления начальных пробелов, что может помешать использовать пробелы в качестве пустого маркера.
Возвращает: - dict[метка, ось]
-
Словарь, сопоставляющий метки объектам осей.
-
-
subplots(self, nrows=1, ncols=1, *, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)[source] -
Добавление набора подграфиков к этой фигуре.
Этот утилитарный обертывающий элемент упрощает создание общих макетов подграфиков в одном вызове.
Параметры: -
nrows, ncolsint, default: 1 -
Количество строк/столбцов сетки подграфиков.
-
sharex, shareybool or {'none', 'all', 'row', 'col'}, default: 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. -
squeezebool, default: True -
- Если True, из возвращаемого массива осей удаляются дополнительные размеры:
- если создается только один подграфик (nrows=ncols=1), возвращается единственный объект оси в виде скаляра.
- для подграфиков Nx1 или 1xM возвращается 1D массив numpy объектов осей.
- для подграфиков NxM с N>1 и M>1 возвращается 2D массив.
- Если False, никакого сжатия не происходит: возвращаемый объект оси всегда является 2D массивом, содержащим объекты осей, даже если он оказывается 1x1.
- Если True, из возвращаемого массива осей удаляются дополнительные размеры:
-
subplot_kwdict, optional -
Словарь с ключевыми словами, передаваемыми в вызов
Figure.add_subplotдля создания каждого подграфика. -
gridspec_kwdict, optional -
Словарь с ключевыми словами, передаваемыми в конструктор
GridSpecдля создания сетки, на которой размещаются подграфики.
Возвращает: -
Axes or array of Axes -
Либо один объект
Axes, либо массив объектов осей, если было создано более одного подграфика. Размеры результирующего массива можно контролировать с помощью ключевого слова squeeze, см. выше.
См. также
Примеры
# First create some toy data: x = np.linspace(0, 2*np.pi, 400) y = np.sin(x**2) # Create a figure plt.figure() # Create a subplot ax = fig.subplots() ax.plot(x, y) ax.set_title('Simple plot') # Create two subplots and unpack the output array immediately ax1, ax2 = fig.subplots(1, 2, sharey=True) ax1.plot(x, y) ax1.set_title('Sharing Y axis') ax2.scatter(x, y) # Create four polar axes and access them through the returned array axes = fig.subplots(2, 2, subplot_kw=dict(polar=True)) axes[0, 0].plot(x, y) axes[1, 1].scatter(x, y) # Share a X axis with each column of subplots fig.subplots(2, 2, sharex='col') # Share a Y axis with each row of subplots fig.subplots(2, 2, sharey='row') # Share both X and Y axes with all subplots fig.subplots(2, 2, sharex='all', sharey='all') # Note that this is the same as fig.subplots(2, 2, sharex=True, sharey=True) -
-
subplots_adjust(self, left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)[source] -
Настройка параметров макета подграфиков.
Неуказанные параметры остаются неизменными; начальные значения задаются
rcParams["figure.subplot.[name]"].Параметры: -
leftfloat, optional -
Положение левого края подграфиков в долях ширины фигуры.
-
rightfloat, optional -
Положение правого края подграфиков в долях ширины фигуры.
-
bottomfloat, optional -
Положение нижнего края подграфиков в долях высоты фигуры.
-
topfloat, optional -
Положение верхнего края подграфиков в долях высоты фигуры.
-
wspacefloat, optional -
Ширина отступа между подграфиками в долях средней ширины осей.
-
hspacefloat, optional -
Высота отступа между подграфиками в долях средней высоты осей.
-
-
suptitle(self, t, **kwargs)[source] -
Добавление центрального заголовка к фигуре.
Параметры: -
tstr -
Текст заголовка.
-
xfloat, default 0.5 -
Положение x текста в координатах фигуры.
-
yfloat, default 0.98 -
Положение y текста в координатах фигуры.
-
horizontalalignment, ha{'center', 'left', right'}, default: 'center' -
Горизонтальное выравнивание текста относительно (x, y).
-
verticalalignment, va{'top', 'center', 'bottom', 'baseline'}, default: 'top' -
Вертикальное выравнивание текста относительно (x, y).
-
fontsize, sizedefault: rcParams["figure.titlesize"] (default: 'large') -
Размер шрифта текста. Возможные значения см. в
Text.set_size. -
fontweight, weightdefault: rcParams["figure.titleweight"] (default: 'normal') -
Начертание шрифта текста. Возможные значения см. в
Text.set_weight.
Возвращает: - текст
-
Экземпляр
Textзаголовка.
Другие параметры: -
fontpropertiesNone or dict, optional -
Словарь свойств шрифта. Если fontproperties задан, значения по умолчанию для размера и начертания шрифта берутся из значений по умолчанию для
FontProperties.rcParams["figure.titlesize"](по умолчанию'large') иrcParams["figure.titleweight"](по умолчанию'normal') игнорируются в этом случае. - **kwargs
-
Дополнительные kwargs — это свойства
matplotlib.text.Text.
Примеры
>>> fig.suptitle('This is the figure title', fontsize=12) -
-
-
text(self, x, y, s, fontdict=None, **kwargs)[source] -
Добавление текста на рисунок.
Параметры: -
x, yfloat -
Позиция для размещения текста. По умолчанию, это координаты рисунка, числа в интервале [0, 1]. Система координат может быть изменена с помощью ключевого слова transform.
-
sstr -
Строка текста.
-
fontdictdict, optional -
Словарь для переопределения свойств текста по умолчанию. Если не указан, значения по умолчанию определяются
rcParams["font.*"]. Свойства, переданные в качестве kwargs, переопределяют соответствующие свойства, заданные в fontdict.
Возвращает: -
-
Другие параметры: -
**kwargsText properties -
Дополнительные различные текстовые параметры.
Свойство Описание agg_filterфункция фильтра, которая принимает массив чисел с плавающей точкой (m, n, 3) и значение dpi, и возвращает массив чисел с плавающей точкой (m, n, 3) alphaчисло с плавающей точкой или None animatedбулево значение backgroundcolorцвет bboxсловарь с свойствами для patches.FancyBboxPatchclip_boxBboxclip_onбулево значение clip_pathОбъект Patch или (Path, Transform) или None colorили cцвет containsнеизвестно figureFigurefontfamilyили family{имя_шрифта, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'} fontpropertiesили font или font_propertiesfont_manager.FontPropertiesилиstrилиpathlib.Pathfontsizeили sizeчисло с плавающей точкой или {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} fontstretchили stretch{числовое значение в диапазоне 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'} fontstyleили style{'normal', 'italic', 'oblique'} fontvariantили variant{'normal', 'small-caps'} fontweightили weight{числовое значение в диапазоне 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'} gidстрока horizontalalignmentили ha{'center', 'right', 'left'} in_layoutбулево значение labelобъект linespacingчисло с плавающей точкой (кратное размеру шрифта) multialignmentили ma{'left', 'right', 'center'} path_effectsAbstractPathEffectpickerNone или булево значение или вызываемый объект position(число с плавающей точкой, число с плавающей точкой) rasterizedбулево значение или None rotationчисло с плавающей точкой или {'vertical', 'horizontal'} rotation_mode{None, 'default', 'anchor'} sketch_params(масштаб: число с плавающей точкой, длина: число с плавающей точкой, случайность: число с плавающей точкой) snapбулево значение или None textобъект transformTransformurlстрока usetexбулево значение или None verticalalignmentили va{'center', 'top', 'bottom', 'baseline', 'center_baseline'} visibleбулево значение wrapбулево значение xчисло с плавающей точкой yчисло с плавающей точкой zorderчисло с плавающей точкой
-
См. также
-
tight_layout(self, renderer=<deprecated parameter>, pad=1.08, h_pad=None, w_pad=None, rect=None)[source] -
Настройка отступов между и вокруг подграфиков.
Чтобы исключить элемент на осях из расчёта ограничивающей рамки, определяющей параметры подграфиков (например, легенду или аннотацию), установите
a.set_in_layout(False)для данного элемента.Параметры: -
renderersubclass of RendererBase, optional -
По умолчанию использует рендерер для фигуры. Устарело.
-
padfloat, default: 1.08 -
Отступ между краем фигуры и краями подграфиков, как доля размера шрифта.
-
h_pad, w_padfloat, default: pad -
Отступ (высота/ширина) между краями смежных подграфиков, как доля размера шрифта.
-
recttuple (left, bottom, right, top), default: (0, 0, 1, 1) -
Прямоугольник в нормализованных координатах фигуры, в который поместится вся область подграфиков (включая метки).
См. также
-
-
Блокирующий вызов для взаимодействия с фигурой.
Ожидает пользовательского ввода и возвращает True, если была нажата клавиша, False, если была нажата кнопка мыши, и None, если ввод не был получен в течение timeout секунд. Отрицательные значения отключают timeout.
Примеры использования matplotlib.figure.Figure
END_OF_DOCUMENT_MARKER END_OF_DOCUMENT_MARKER END_OF_DOCUMENT_MARKER END_OF_DOCUMENT_MARKER END_OF_DOCUMENT_MARKER END_OF_DOCUMENT_MARKER END_OF_DOCUMENT_MARKER END_OF_DOCUMENT_MARKER
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.3.3/api/_as_gen/matplotlib.figure.Figure.html