matplotlib.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] -
Основной контейнер для всех элементов графика.
Экземпляр Figure поддерживает обратные вызовы через атрибут callbacks, который является экземпляром
CallbackRegistry. События, к которым можно подключиться, это 'dpi_changed', и обратный вызов будет вызван сfunc(fig), где fig — экземплярFigure.Атрибуты: - patch
-
Экземпляр
Rectangle, представляющий область фигуры. - suppressComposite
-
Для нескольких изображений фигуры, фигура будет создавать составные изображения в зависимости от параметра рендеринга функции option_image_nocomposite. Если suppressComposite является булевым значением, это переопределит рендеринг.
Параметры: -
figsize : 2-tuple of floats, default: rcParams["figure.figsize"] -
Размеры фигуры
(width, height)в дюймах. -
dpi : float, default: rcParams["figure.dpi"] -
Точек на дюйм.
-
facecolor : default: rcParams["figure.facecolor"] -
Цвет заливки области фигуры.
-
edgecolor : default: rcParams["figure.edgecolor"] -
Цвет рамки фигуры.
-
linewidth : float -
Ширина линии рамки (т.е. ширина линии рамки области фигуры).
-
frameon : bool, default: rcParams["figure.frameon"] -
Если
False, подавить отрисовку рамки фигуры. -
subplotpars : SubplotParams -
Параметры подграфиков. Если не указаны, используются параметры подграфиков по умолчанию
rcParams["figure.subplot.*"]. -
tight_layout : bool or dict, default: rcParams["figure.autolayout"] -
Если
False, использовать subplotpars. ЕслиTrue, настроить параметры подграфиков с помощьюtight_layoutс отступами по умолчанию. При предоставлении словаря с ключамиpad,w_pad,h_pad, иrect, отступы по умолчаниюtight_layoutбудут переопределены. -
constrained_layout : bool -
Если
True, использовать ограниченную компоновку для регулирования позиционирования элементов графика. Подобноtight_layout, но разработано для большей гибкости. См. Руководство по ограниченной компоновке для примеров. (Примечание: не работает сsubplot()илиsubplot2grid().) По умолчаниюrcParams["figure.constrained_layout.use"].
-
add_axes(*args, **kwargs)[source] -
Добавить область в фигуру.
Вызов:
add_axes(rect, projection=None, polar=False, **kwargs)
Параметры: -
rect : sequence of float -
Размеры [левый, нижний, ширина, высота] новой области. Все значения задаются в долях ширины и высоты фигуры.
-
projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', rectilinear'}, optional -
Тип проекции области.
-
polar : boolean, optional -
Если True, эквивалентно projection='polar'.
- **kwargs
-
Этот метод также принимает ключевые параметры для
Axes.
Возвращает: -
axes : Axes -
Добавленная область.
Примеры
Некоторые простые примеры:
rect = l, b, w, h fig.add_axes(rect) fig.add_axes(rect, frameon=False, facecolor='g') fig.add_axes(rect, polar=True) fig.add_axes(rect, projection='polar') fig.add_axes(ax)
Если в фигуре уже есть область с теми же параметрами, она просто сделает эту область текущей и вернёт её. Это поведение устарело начиная с Matplotlib 2.1. Тем временем, если вы не хотите этого поведения (т.е. хотите принудительно создать новую область), вы должны использовать уникальный набор args и kwargs. Атрибут axes
labelдобавлен для этой цели: если вы хотите добавить две области, которые в остальном идентичны, убедитесь, что вы дали им уникальные метки:fig.add_axes(rect, label='axes1') fig.add_axes(rect, label='axes2')
В редких случаях add_axes может быть вызван с одним аргументом — экземпляром области, уже созданным в текущей фигуре, но не в списке областей фигуры. Например, если область была удалена с помощью
delaxes(), её можно восстановить:fig.add_axes(ax)
Во всех случаях экземпляр
Axesбудет возвращён. -
-
add_axobserver(func)[source] -
Всякий раз, когда состояние области изменяется,
func(self)будет вызван.
-
add_subplot(*args, **kwargs)[source] -
Добавить подграфик.
Вызов:
add_subplot(nrows, ncols, index, **kwargs) add_subplot(pos, **kwargs)
Параметры: - *args
-
Либо трёхзначное целое число, либо три отдельных целых числа, описывающие положение подграфика. Если три целых числа это R, C и P, подграфик займёт P-ю позицию на сетке с R строками и C столбцами.
-
projection : {None, 'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', rectilinear'}, optional -
Тип проекции области.
-
polar : boolean, optional -
Если True, эквивалентно projection='polar'.
- **kwargs
-
Этот метод также принимает ключевые параметры для
Axes.
Возвращает: -
axes : Axes -
Область подграфика.
См. также
-
matplotlib.pyplot.subplot - для объяснения аргументов.
Примечания
Если в фигуре уже есть подграфик с ключом (args, kwargs), то он просто сделает этот подграфик текущим и вернёт его. Это поведение устарело.
Примеры
fig.add_subplot(111) # equivalent but more general fig.add_subplot(1, 1, 1) # add subplot with red background fig.add_subplot(212, facecolor='r') # add a polar subplot fig.add_subplot(111, projection='polar') # add Subplot instance sub fig.add_subplot(sub)
-
align_labels(axs=None)[source] -
Выравнивает метки x и y подграфиков в одном ряду или столбце подграфиков (соответственно), если выравнивание меток выполняется автоматически (т.е. позиция метки не задана вручную).
Выравнивание сохраняется для событий отрисовки после вызова.
Параметры: -
axs : list of Axes -
Необязательный список (или массив ndarray) областей
Axesдля выравнивания меток. По умолчанию выравниваются все области в фигуре.
-
-
align_xlabels(axs=None)[source] -
Выравнивает метки y осей подграфиков в одном столбце подграфиков, если выравнивание меток выполняется автоматически (т.е. положение метки не задано вручную).
Выравнивание сохраняется для событий отрисовки после вызова этого метода.
Если метка находится внизу, она выравнивается с метками осей, у которых метка также находится внизу и у которых одинаковая самая нижняя строка подграфиков. Если метка находится вверху, она выравнивается с метками осей, имеющих одинаковую самую верхнюю строку.
Параметры: -
axs : list of Axes -
Необязательный список (или массив ndarray)
Axesдля выравнивания меток x осей. По умолчанию выравниваются все оси на рисунке.
Примечания
Предполагается, что
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 : list of Axes -
Необязательный список (или массив ndarray)
Axesдля выравнивания меток y осей. По умолчанию выравниваются все оси на рисунке.
Примечания
Предполагается, что
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=None)[source] -
Метки даты на оси x часто перекрываются, поэтому полезно повернуть их и выровнять по правому краю. Также распространенным случаем является несколько подграфиков с общей осью x, где ось x содержит данные даты. Метки часто длинные, и полезно повернуть их на нижнем подграфике и отключить на других подграфиках, а также отключить метки оси x.
Параметры: -
bottom : scalar -
Нижняя часть подграфиков для
subplots_adjust(). -
rotation : angle in degrees -
Поворот меток оси x.
-
ha : string -
Горизонтальное выравнивание меток оси x.
-
which : {None, 'major', 'minor', 'both'} -
Выбирает, какие метки повернуть. По умолчанию None, что работает так же, как и major.
-
-
axes -
Список осей на рисунке. Вы можете получить доступ к осям на рисунке через этот список. Не изменяйте сам список. Вместо этого используйте
add_axes,subplotилиdelaxesдля добавления или удаления оси.
-
clear(keep_observers=False)[source] -
Очистить рисунок — синоним для
clf().
-
clf(keep_observers=False)[source] -
Очистить рисунок.
Установите keep_observers в значение True, если, например, виджет gui отслеживает оси на рисунке.
-
-
colorbar(mappable, cax=None, ax=None, use_gridspec=True, **kw)[source] -
Создать полосу цвета для объекта ScalarMappable, mappable.
Документация для тонкого обертки pylab:
Добавить полосу цвета к графику.
Подписи функций для
pyplotинтерфейса; все, кроме первой, также являются подписями методов дляcolorbar()метода:colorbar(**kwargs) colorbar(mappable, **kwargs) colorbar(mappable, cax=cax, **kwargs) colorbar(mappable, ax=ax, **kwargs)
Параметры: - mappable :
-
Объект
Image,ContourSetи т.д., к которому применяется полоса цвета; этот аргумент обязателен для метода Figurecolorbar(), но необязателен для функции pyplotcolorbar(), которая устанавливает значение по умолчанию на текущий рисунок. -
cax : Axes object, optional -
Оси, на которых будет отображена полоса цвета.
-
ax : Axes, list of Axes, optional -
Родительские оси, из которых будет взято место для новых осей полосы цвета. Если указан список осей, все они будут изменены для размещения осей полосы цвета.
-
use_gridspec : bool, optional -
Если cax является
None, новый cax создается как экземпляр Axes. Если ax является экземпляром Subplot и use_gridspec являетсяTrue, cax создается как экземпляр Subplot с использованием модуля grid_spec.
Возвращаемые значения: - экземпляр :class:`~matplotlib.colorbar.Colorbar`
-
См. также его базовый класс,
ColorbarBase. Используйте методset_label()для подписи полосы цвета.
Примечания
Дополнительные ключевые аргументы бывают двух типов:
свойства осей:
Свойство Описание orientation вертикальное или горизонтальное fraction 0.15; доля исходных осей для использования полосой цвета pad 0.05, если вертикальное, 0.15, если горизонтальное; доля исходных осей между полосой цвета и новыми осями изображения shrink 1.0; доля, на которую умножается размер полосы цвета aspect 20; отношение длинных к коротким сторонам anchor (0.0, 0.5), если вертикальное; (0.5, 1.0), если горизонтальное; точка якоря осей полосы цвета panchor (1.0, 0.5), если вертикальное; (0.5, 0.0), если горизонтальное; точка якоря родительских осей полосы цвета. Если False, точка якоря родительских осей останется неизменной свойства полосы цвета:
Свойство Описание extend [ 'neither' | 'both' | 'min' | 'max' ] Если не 'neither', добавить указатели для значений за пределами диапазона. Они устанавливаются для данной цветовой карты с помощью методов colormap set_under и set_over. extendfrac [ None | 'auto' | длина | длины ] Если None, минимальное и максимальное треугольные расширения полосы цвета будут иметь длину 5% от длины внутренней полосы цвета (это значение по умолчанию). Если 'auto', делает треугольные расширения полосы цвета той же длины, что и внутренние прямоугольники (когда spacing задан 'uniform') или той же длины, что и соответствующие соседние внутренние прямоугольники (когда spacing задан 'proportional'). Если скаляр, указывает длину минимального и максимального треугольных расширений полосы цвета как долю от длины внутренней полосы цвета. Также может быть задана двухелементная последовательность дробей, указывающая длину минимального и максимального расширений полосы цвета соответственно как долю от длины внутренней полосы цвета. extendrect bool Если False, минимальные и максимальные расширения полосы цвета будут треугольными (значение по умолчанию). Если True, расширения будут прямоугольными. spacing [ 'uniform' | 'proportional' ] Равномерное распределение дает каждому дискретному цвету одинаковое место; пропорциональное делает распределение пропорциональным интервалу данных. ticks [ None | список тиков | объект Locator ] Если None, деления автоматически определяются из входных данных. format [ None | строка формата | объект Formatter ] Если None, используется ScalarFormatter. Если задана строка формата, например, '%.3f', она используется. Вместо нее может быть задан альтернативный объектFormatter.drawedges bool Отображать ли линии на границах цветов. Следующее, вероятно, будет полезно только в контексте индексированных цветов (то есть, когда 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(mouseevent)[source] -
Проверить, произошел ли сдвиг мыши на фигуре.
Возвращаемые значения: - bool, {}
-
delaxes(ax)[source] -
Удалить
Axesax из фигуры и обновить текущие оси.
-
dpi -
Разрешение в точках на дюйм.
-
draw(renderer)[source] -
Отобразить фигуру с помощью экземпляра
matplotlib.backend_bases.RendererBaserenderer.
-
draw_artist(a)[source] -
Отобразить только экземпляр
matplotlib.artist.Artista. Это доступно только после отображения фигуры.
-
execute_constrained_layout(renderer=None)[source] -
Использовать
layoutboxдля определения позиций внутри осей.См. также
set_constrained_layout_pads.
-
-
figimage(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, yo : int -
Смещение изображения по осям x/y в пикселях.
-
alpha : None or float -
Значение альфа-смешивания.
-
norm : matplotlib.colors.Normalize -
Экземпляр
Normalizeдля отображения яркости в интервале [0, 1]. -
cmap : str or matplotlib.colors.Colormap -
Цветовая карта для использования. По умолчанию:
rcParams["image.cmap"]. -
vmin, vmax : scalar -
Если norm не задан, эти значения устанавливают пределы данных для цветовой карты.
-
origin : {'upper', 'lower'} -
Указывает, где индекс [0, 0] массива находится в верхнем левом или нижнем левом углу осей. По умолчанию
rcParams["image.origin"]. -
resize : bool -
Если True, размер рисунка изменяется в соответствии с заданным размером изображения.
Возвращает: - :class:`matplotlib.image.FigureImage`
Другие параметры: - **kwargs
-
Дополнительные параметры kwargs являются параметрами
Artist, передаваемыми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()
-
figurePatch -
Устарело начиная с версии 2.1: Функция figurePatch устарела в версии 2.1. Используйте
Figure.patchвместо неё.
-
-
gca(**kwargs)[source] -
Получить текущую ось, создав её при необходимости.
Поддерживаются следующие ключевые слова для обеспечения того, что возвращаемая ось соответствует заданной проекции и т.д., а также для создания оси, если активная ось не существует:
Свойство Описание adjustable[ 'box' | 'datalim'] agg_filterфункция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) alphaвещественное число (от 0.0 — прозрачный до 1.0 — непрозрачный) anchor[ 'C' | 'SW' | 'S' | 'SE' | 'E' | 'NE' | 'N' | 'NW' | 'W' ] animatedбулево значение aspectнеизвестно autoscale_onбулево значение autoscalex_onбулево значение autoscaley_onбулево значение axes_locatorвызываемый объект, который принимает экземпляр оси и рендерер и возвращает bbox. axisbelow[ bool | 'line' ] clip_boxэкземпляр Bboxclip_onбулево значение clip_path[( Path,Transform) |Patch| None]containsвызываемая функция facecolorцвет fcцвет figureFigureframe_onбулево значение gidстрока идентификатора labelобъект navigateбулево значение navigate_modeнеизвестно path_effectsAbstractPathEffectpicker[None | bool | float | вызываемый объект] positionнеизвестно rasterization_zorderвещественное число или None rasterizedбулево значение или None sketch_params(масштаб: вещественное число, длина: вещественное число, случайность: вещественное число) snapбулево значение или None titleнеизвестно transformTransformurlстрока url 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' | ... ] yticklabelsсписок строковых меток yticksсписок значений меток zorderвещественное число
-
get_axes()[source] -
Возвращает список осей в Figure. Вы можете получить доступ и изменить оси в Figure через этот список.
Не изменяйте сам список. Вместо этого используйте
add_axes,subplotилиdelaxesдля добавления или удаления оси.Примечание: Это эквивалентно свойству
axes.
-
get_children()[source] -
Получить список художников, содержащихся в figure.
-
get_constrained_layout()[source] -
Возвращает булево значение: True означает, что используется ограниченное расположение.
-
get_constrained_layout_pads(relative=False)[source] -
Получить отступы для
constrained_layout.Возвращает список отступов в дюймах и
w_pad, h_padиwspaceкак доли subplot.См. Руководство по ограниченному расположению.
Параметры: -
relative : boolean -
Если
True, то преобразовать из дюймов в относительные единицы figure.
-
-
get_default_bbox_extra_artists()[source]
-
-
get_dpi()[source] -
Возвращает разрешение в точках на дюйм в виде числа с плавающей точкой.
-
get_edgecolor()[source] -
Получает цвет рамки прямоугольника Figure.
-
get_facecolor()[source] -
Получает цвет заливки прямоугольника Figure.
-
get_figheight()[source] -
Возвращает высоту рисунка в виде числа с плавающей точкой.
-
get_figwidth()[source] -
Возвращает ширину рисунка в виде числа с плавающей точкой.
-
get_frameon()[source] -
Возвращает, будет ли отрисовываться рамка рисунка.
-
get_size_inches()[source] -
Возвращает текущий размер рисунка в дюймах.
Возвращает: -
size : ndarray -
Размер рисунка (ширина, высота) в дюймах.
См. также
matplotlib.Figure.set_size_inches -
-
get_tight_layout()[source] -
Возвращает, будет ли вызываться
tight_layoutпри отрисовке.
-
get_tightbbox(renderer)[source] -
Возвращает (усечённую) область рисунка в дюймах.
Учитывает только заголовки осей, подписи осей и метки делений осей. Требуется улучшение.
-
get_window_extent(*args, **kwargs)[source] -
Возвращает область рисунка в пространстве отображения. Аргументы игнорируются.
-
ginput(n=1, timeout=30, show_clicks=True, mouse_add=1, mouse_pop=3, mouse_stop=2)[source] -
Блокирующий вызов для взаимодействия с рисунком.
Ожидает, пока пользователь n раз кликнет по рисунку, и возвращает координаты каждого клика в списке.
Кнопки, используемые для различных действий (добавление точек, удаление точек, завершение ввода), можно переопределить с помощью аргументов mouse_add, mouse_pop и mouse_stop, которые задают соответствующую кнопку мыши: 1 для левой, 2 для средней, 3 для правой.
Параметры: -
n : int, optional, default: 1 -
Количество кликов мышью для накопления. Если отрицательно, накапливает клики до тех пор, пока ввод не будет завершен вручную.
-
timeout : scalar, optional, default: 30 -
Количество секунд ожидания до истечения времени. Если ноль или отрицательно, таймаут никогда не произойдёт.
-
show_clicks : bool, optional, default: False -
Если True, отображает красный крест в месте каждого клика.
-
mouse_add : int, one of (1, 2, 3), optional, default: 1 (left click) -
Кнопка мыши, используемая для добавления точек.
-
mouse_pop : int, one of (1, 2, 3), optional, default: 3 (right click) -
Кнопка мыши, используемая для удаления последней добавленной точки.
-
mouse_stop : int, one of (1, 2, 3), optional, default: 2 (middle click) -
Кнопка мыши, используемая для остановки ввода.
Возвращает: -
points : list of tuples -
Список нажатых координат (x, y).
Примечания
Клавиши клавиатуры также могут использоваться для выбора точек, если у вашей мыши отсутствует одна или несколько кнопок. Клавиши Backspace и Delete действуют как правый щелчок (т.е. удаляют последнюю точку), клавиша Enter завершает ввод, а любая другая клавиша (не используемая менеджером окон) выбирает точку.
-
-
hold(b=None)[source] -
Устарело начиная с версии 2.0: Функция hold устарела начиная с версии 2.0.
Устанавливает состояние удержания. Если hold равно None (по умолчанию), переключает состояние удержания. В противном случае устанавливает состояние удержания в булевое значение b.
Например:
hold() # toggle hold hold(True) # hold is on hold(False) # hold is off
Все механизмы "удержания" устарели.
-
init_layoutbox()[source] -
Инициализирует layoutbox для использования в constrained_layout.
-
-
legend(*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')Параметры: -
handles : sequence of Artist, optional -
Список элементов (линий, областей), которые нужно добавить в легенду. Используйте это вместе с метками, если вам нужен полный контроль над тем, что отображается в легенде, и механизм автоматического создания не достаточен.
Длина элементов и меток в этом случае должна быть одинаковой. Если это не так, они обрезаются до меньшей длины.
-
labels : sequence of strings, optional -
Список меток, которые нужно отобразить рядом с элементами. Используйте это вместе с элементами, если вам нужен полный контроль над тем, что отображается в легенде, и механизм автоматического создания не достаточен.
Возвращает: - :class:`matplotlib.legend.Legend` экземпляр
Другие параметры: -
loc : int or string or pair of floats, default: 'upper right' -
Расположение легенды. Возможные значения:
Строковое обозначение расположения Код расположения 'лучшее' 0 'верхний правый' 1 'верхний левый' 2 'нижний левый' 3 'нижний правый' 4 'правый' 5 'центр слева' 6 'центр справа' 7 'нижний центр' 8 'верхний центр' 9 'центр' 10 В качестве альтернативы может быть 2-кортеж, задающий
x, yлевого нижнего угла легенды в координатах осей (в этом случаеbbox_to_anchorбудет игнорироваться). -
bbox_to_anchor : BboxBase or pair of floats -
Указывает произвольное расположение легенды в
bbox_transformкоординатах (по умолчанию координатах осей).Например, чтобы расположить верхний правый угол легенды в центре осей, можно использовать следующие ключевые слова:
loc='upper right', bbox_to_anchor=(0.5, 0.5)
-
ncol : integer -
Количество столбцов в легенде. По умолчанию 1.
-
prop : None or matplotlib.font_manager.FontProperties or dict -
Свойства шрифта легенды. Если None (по умолчанию), будут использоваться текущие
matplotlib.rcParams. -
fontsize : int or float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} -
Управляет размером шрифта легенды. Если значение числовое, размер будет абсолютным размером шрифта в пунктах. Строковые значения относительны к текущему размеру шрифта по умолчанию. Этот аргумент используется только если
propне указан. -
numpoints : None or int -
Количество маркеров точек в легенде при создании записи легенды для
Line2D(линия). По умолчаниюNone, которое будет получено изrcParams["legend.numpoints"]. -
scatterpoints : None or int -
Количество маркеров точек в легенде при создании записи легенды для
PathCollection(диаграмма рассеяния). По умолчаниюNone, которое будет получено изrcParams["legend.scatterpoints"]. -
scatteryoffsets : iterable of floats -
Вертикальное смещение (относительно размера шрифта) для маркеров, созданных для записи легенды диаграммы рассеяния. 0.0 — в основании текста легенды, 1.0 — вверху. Чтобы отобразить все маркеры на одной высоте, установите в
[0.5]. По умолчанию[0.375, 0.5, 0.3125]. -
markerscale : None or int or float -
Относительный размер маркеров легенды по сравнению с первоначально нарисованными. По умолчанию
None, которое будет получено изrcParams["legend.markerscale"]. -
markerfirst : bool -
Если True, маркер легенды размещается слева от метки легенды. Если False, маркер легенды размещается справа от метки легенды. По умолчанию True.
-
frameon : None or bool -
Управляет отображением легенды на области (рамке). По умолчанию
None, которое будет получено изrcParams["legend.frameon"]. -
fancybox : None or bool -
Управляет включением скругленных углов вокруг
FancyBboxPatch, формирующих фон легенды. По умолчаниюNone, которое будет получено изrcParams["legend.fancybox"]. -
shadow : None or bool -
Управляет отображением тени за легендой. По умолчанию
None, которое будет получено изrcParams["legend.shadow"]. -
framealpha : None or float -
Управляет альфа-прозрачностью фона легенды. По умолчанию
None, которое будет получено изrcParams["legend.framealpha"]. Если тень включена и framealpha равноNone, значение по умолчанию игнорируется. -
facecolor : None or "inherit" or a color spec -
Управляет цветом фона легенды. По умолчанию
None, которое будет получено изrcParams["legend.facecolor"]. Если"inherit", оно будетrcParams["axes.facecolor"]. -
edgecolor : None or "inherit" or a color spec -
Управляет цветом линии обводки области фона легенды. По умолчанию
None, которое будет получено изrcParams["legend.edgecolor"]Если"inherit", оно будетrcParams["axes.edgecolor"]. -
mode : {"expand", None} -
Если
modeустановлено в"expand", легенда будет горизонтально расширена для заполнения области осей (илиbbox_to_anchorесли определен размер легенды). -
bbox_transform : None or matplotlib.transforms.Transform -
Преобразование для ограничивающей рамки (
bbox_to_anchor). Для значенияNone(по умолчанию) будет использоваться преобразование осейtransAxes. -
title : str or None -
Заголовок легенды. По умолчанию нет заголовка (
None). -
borderpad : float or None -
Доля отступа внутри границы легенды. Измеряется в единицах размера шрифта. По умолчанию
None, которое будет получено изrcParams["legend.borderpad"]. -
labelspacing : float or None -
Вертикальное расстояние между записями легенды. Измеряется в единицах размера шрифта. По умолчанию
None, которое будет получено изrcParams["legend.labelspacing"]. -
handlelength : float or None -
Длина элементов легенды. Измеряется в единицах размера шрифта. По умолчанию
None, которое будет получено изrcParams["legend.handlelength"]. -
handletextpad : float or None -
Отступ между элементом легенды и текстом. Измеряется в единицах размера шрифта. По умолчанию
None, которое будет получено изrcParams["legend.handletextpad"]. -
borderaxespad : float or None -
Отступ между осями и границей легенды. Измеряется в единицах размера шрифта. По умолчанию
None, которое будет получено изrcParams["legend.borderaxespad"]. -
columnspacing : float or None -
Отступ между столбцами. Измеряется в единицах размера шрифта. По умолчанию
None, которое будет получено изrcParams["legend.columnspacing"]. -
handler_map : dict or None -
Пользовательский словарь, сопоставляющий экземпляры или типы с обработчиком легенды. Это
handler_mapобновляет словарь обработчиков по умолчанию, который можно найти вmatplotlib.legend.Legend.get_legend_handler_map().
Примечания
Не все типы элементов поддерживаются командой легенды. Подробности см. в Руководстве по легендам.
-
-
-
savefig(fname, **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)Доступные форматы вывода зависят от используемого бэкенда.
Параметры: -
fname : str or file-like object -
Строка, содержащая путь к файлу, или объект Python-подобного файла, или, возможно, какой-либо объект, зависящий от бэкенда, такой как
PdfPages.Если format имеет значение None и fname является строкой, формат вывода определяется из расширения имени файла. Если у имени файла нет расширения, используется значение параметра rc
savefig.format.Если fname не является строкой, обязательно укажите format, чтобы убедиться, что используется правильный бэкенд.
Другие параметры: -
dpi : [ None | scalar > 0 | 'figure'] -
Разрешение в точках на дюйм. Если None, используется значение по умолчанию
savefig.dpiв файле matplotlibrc. Если 'figure', dpi устанавливается равным значению фигуры. -
facecolor : color spec or None, optional -
Цвет заливки фигуры; если None, используется значение по умолчанию savefig.facecolor.
-
edgecolor : color spec or None, optional -
Цвет обводки фигуры; если None, используется значение по умолчанию savefig.edgecolor.
-
orientation : {'landscape', 'portrait'} -
Не поддерживается во всех бэкендах; в настоящее время поддерживается только для вывода в формате postscript.
-
papertype : str -
Один из значений 'letter', 'legal', 'executive', 'ledger', 'a0' до 'a10', 'b0' до 'b10'. Поддерживается только для вывода в формате postscript.
-
format : str -
Одно из расширений файлов, поддерживаемых активным бэкендом. Большинство бэкендов поддерживают png, pdf, ps, eps и svg.
-
transparent : bool -
Если True, области набора осей будут прозрачными; область фигуры также будет прозрачной, если не указаны facecolor и/или edgecolor с помощью параметров kwargs. Это полезно, например, для отображения графика поверх цветного фона на веб-странице. Прозрачность этих областей вернется к исходным значениям по завершении этой функции.
-
frameon : bool -
Если True, область фигуры будет окрашена, если False, фон фигуры будет прозрачным. Если не указано, используется rcParam 'savefig.frameon'.
-
bbox_inches : str or Bbox, optional -
Прямоугольник в дюймах. Сохраняется только указанная часть фигуры. Если 'tight', пытается определить прямоугольник figure в соответствии с tight bbox. Если None, используется savefig.bbox.
-
pad_inches : scalar, optional -
Количество отступов вокруг фигуры, когда bbox_inches равен 'tight'. Если None, используется savefig.pad_inches.
-
bbox_extra_artists : list of Artist, optional -
Список дополнительных элементов, которые будут учитываться при расчете прямоугольника tight bbox.
-
-
sca(a)[source] -
Установить текущую ось как a и вернуть a.
-
set_canvas(canvas)[source] -
Установить холст, содержащий фигуру
ПРИНИМАЕТ: экземпляр FigureCanvas
-
set_constrained_layout(constrained)[source] -
Установить, используется ли
constrained_layoutпри отрисовке. Если None, используется значение rcParams['figure.constrained_layout.use'].При предоставлении словаря, содержащего ключи
w_pad,h_pad, значения отступов по умолчаниюconstrained_layoutбудут переопределены. Эти отступы заданы в дюймах и по умолчанию равны 3.0/72.0.w_pad- отступ по ширине, аh_pad- отступ по высоте.ПРИНИМАЕТ: [True | False | dict | None ]
-
set_constrained_layout_pads(**kwargs)[source] -
Установить отступы для
constrained_layout. Обратите внимание, что параметры kwargs могут быть переданы в виде словаряfig.set_constrained_layout(**paddict).См. Руководство по ограниченному макетированию.
Параметры: -
w_pad : scalar -
Отступ по ширине в дюймах. Этот отступ вокруг осей предназначен для обеспечения достаточного пространства для корректного отображения шрифтов. По умолчанию равен 3 пунктам = 0,04167 дюйма.
-
h_pad : scalar -
Отступ по высоте в дюймах. По умолчанию равен 3 пунктам.
- wspace: скаляр
-
Отступ по ширине между подграфиками, выраженный как дробь ширины подграфика. Общий отступ равен w_pad + wspace.
- hspace: скаляр
-
Отступ по высоте между подграфиками, выраженный как дробь ширины подграфика. Общий отступ равен h_pad + hspace.
-
-
set_dpi(val)[source] -
Установить точки на дюйм фигуры.
ПРИНИМАЕТ: число с плавающей точкой
-
set_edgecolor(color)[source] -
Установить цвет обводки прямоугольника фигуры.
ПРИНИМАЕТ: любой цвет matplotlib - см. help(colors)
-
set_facecolor(color)[source] -
Установить цвет заливки прямоугольника фигуры.
ПРИНИМАЕТ: любой цвет matplotlib - см. help(colors)
-
set_figheight(val, forward=True)[source] -
Установить высоту фигуры в дюймах.
ПРИНИМАЕТ: число с плавающей точкой
-
set_figwidth(val, forward=True)[source] -
Установить ширину фигуры в дюймах.
ПРИНИМАЕТ: число с плавающей точкой
-
set_frameon(b)[source] -
Установить, отображается ли рамка фигуры (фон) или она скрыта.
ПРИНИМАЕТ: булево значение
-
set_size_inches(w, h=None, forward=True)[source] -
Установить размер фигуры в дюймах (1 дюйм = 2,54 см)
Использование
fig.set_size_inches(w, h) # OR fig.set_size_inches((w, h))
Дополнительный параметр forward=True автоматически обновит размер холста; например, вы можете изменить размер окна фигуры из командной строки.
ПРИНИМАЕТ: кортеж w, h с w, h в дюймах
См. также
matplotlib.Figure.get_size_inches
-
set_tight_layout(tight)[source] -
Установить, вызывается ли
tight_layoutпри отрисовке и как.Параметры: -
tight : bool or dict with keys "pad", "w_pad", "h_pad", "rect" or None -
Если bool, устанавливает, вызывать ли
tight_layoutпри отрисовке. ЕслиNone, использовать rcparamfigure.autolayoutвместо этого. Если dict, передать его как kwargs вtight_layout, переопределяя отступы по умолчанию.
-
-
-
show(warn=True)[source] -
Если используется графический бэкэнд с pyplot, отобразить окно фигуры.
Если фигура была не создана с помощью
figure(), ей может не хвататьFigureManagerBase, и будет вызвано исключение AttributeError.Параметры: -
warm : bool -
Если
True, выдать предупреждение при вызове на бэкэнде, не поддерживающем графику.
Примечания
Для бэкэндов, не поддерживающих графику, это ничего не делает, в этом случае будет выдано предупреждение, если warn
True(по умолчанию). -
-
subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True, subplot_kw=None, gridspec_kw=None)[source] -
Добавить набор подграфиков к этой фигуре.
Параметры: -
nrows, ncols : int, default: 1 -
Количество строк/столбцов сетки подграфиков.
-
sharex, sharey : bool 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(). -
squeeze : bool, optional, default: True -
-
Если True, дополнительные измерения из возвращаемого массива объектов Axes удаляются:
- если создается только один подграфик (nrows=ncols=1), возвращается единственный объект Axes в виде скаляра.
- для подграфиков Nx1 или 1xM, возвращаемый объект — одномерный numpy-массив объектов Axes.
- для подграфиков NxM, где N>1 и M>1, возвращается двумерный массив.
- Если False, никакого сжатия не происходит: возвращаемый объект Axes всегда является двумерным массивом, содержащим экземпляры Axes, даже если он оказывается 1x1.
-
-
subplot_kw : dict, default: {} -
Словарь с ключевыми словами, передаваемыми в вызов
add_subplot()для создания каждого подграфика. -
gridspec_kw : dict, default: {} -
Словарь с ключевыми словами, передаваемыми в конструктор
GridSpecдля создания сетки, на которой размещаются подграфики.
Возвращает: -
ax : single Axes object or array of Axes objects -
Добавленные оси. Размеры результирующего массива можно контролировать с помощью ключевого слова squeeze, см. выше.
См. также
-
pyplot.subplots - API pyplot; в документации содержатся примеры.
-
-
subplots_adjust(*args, **kwargs)[source] -
Вызов:
subplots_adjust(left=None, bottom=None, right=None, top=None, wspace=None, hspace=None)Обновляет
SubplotParamsс помощью kwargs (по умолчанию rc, если None) и обновляет расположение подграфиков.
-
suptitle(t, **kwargs)[source] -
Добавить централизованный заголовок к фигуре.
kwargs — свойства
matplotlib.text.Text. Используя координаты фигуры, значения по умолчанию:-
x : 0.5 - Позиция текста по оси x в координатах фигуры
-
y : 0.98 - Позиция текста по оси y в координатах фигуры
-
horizontalalignment : 'center' - Горизонтальное выравнивание текста
-
verticalalignment : 'top' - Вертикальное выравнивание текста
Если задан ключевой параметр
fontproperties, значения по умолчанию rcParams дляfontsize(figure.titlesize) иfontweight(figure.titleweight) игнорируются в пользу значений по умолчаниюFontProperties.Возвращается экземпляр
matplotlib.text.Text.Пример:
fig.suptitle('this is the figure title', fontsize=12) -
-
-
text(x, y, s, *args, **kwargs)[source] -
Добавление текста в фигуру.
Вызов:
text(x, y, s, fontdict=None, **kwargs)
Добавить текст в фигуру в координатах x, y (относительные координаты от 0 до 1). Обратитесь к
text()для значения других аргументов.Параметры kwargs управляют свойствами
Text:Свойство Описание agg_filterфункция фильтра, которая принимает массив float (m, n, 3) и значение dpi, и возвращает массив (m, n, 3) alphaвещественное число (от 0.0 — прозрачный до 1.0 — непрозрачный) animatedбулево значение backgroundcolorлюбой цвет matplotlib bboxсловарь свойств FancyBboxPatch clip_boxэкземпляр matplotlib.transforms.Bboxclip_onбулево значение clip_path[ ( Path,Transform) |Patch| None ]colorлюбой цвет matplotlib containsвызываемая функция familyили fontfamily или fontname или name[ШРИФТ | 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] figureэкземпляр Figurefontpropertiesили font_propertiesэкземпляр matplotlib.font_manager.FontPropertiesgidстрока идентификатора horizontalalignmentили ha[ 'center' | 'right' | 'left' ] labelобъект linespacingвещественное число (кратное размеру шрифта) multialignmentили ma['left' | 'right' | 'center' ] path_effectsAbstractPathEffectpicker[None | bool | float | вызываемая функция] position(x,y) rasterizedбулево значение или None rotation[ угол в градусах | 'vertical' | 'horizontal' ] rotation_mode[ None | "default" | "anchor" ] sizeили fontsize[размер в пунктах | 'xx-small' | 'x-small' | 'small' | 'medium' | 'large' | 'x-large' | 'xx-large' ] sketch_params(масштаб: float, длина: float, случайность: float) snapбулево значение или None stretchили fontstretch[числовое значение в диапазоне 0-1000 | 'ultra-condensed' | 'extra-condensed' | 'condensed' | 'semi-condensed' | 'normal' | 'semi-expanded' | 'expanded' | 'extra-expanded' | 'ultra-expanded' ] styleили fontstyle[ 'normal' | 'italic' | 'oblique'] textстрока или любой печатаемый объект с преобразованием '%s'. transformTransformurlстрока URL usetexбулево значение или None variantили fontvariant[ 'normal' | 'small-caps' ] verticalalignmentили va[ 'center' | 'top' | 'bottom' | 'baseline' ] visibleбулево значение weightили fontweight[числовое значение в диапазоне 0-1000 | 'ultralight' | 'light' | 'normal' | 'regular' | 'book' | 'medium' | 'roman' | 'semibold' | 'demibold' | 'demi' | 'bold' | 'heavy' | 'extra bold' | 'black' ] wrapбулево значение xвещественное число yвещественное число zorderвещественное число
-
-
tight_layout(renderer=None, pad=1.08, h_pad=None, w_pad=None, rect=None)[source] -
Настройка параметров подграфиков для задания указанного отступа.
Параметры: -
pad : float -
Отступ между краем фигуры и краями подграфиков, как доля размера шрифта.
-
h_pad, w_pad : float, optional -
Отступ (высота/ширина) между краями смежных подграфиков. По умолчанию
pad_inches. -
rect : tuple (left, bottom, right, top), optional -
Прямоугольник (слева, снизу, справа, сверху) в нормализованных координатах фигуры, в который будет помещена вся область подграфиков (включая метки). По умолчанию (0, 0, 1, 1).
-
-
Блокирующий вызов для взаимодействия с фигурой.
Возвращает True, если была нажата клавиша, False, если была нажата кнопка мыши, и None, если истекло время ожидания, не нажата ни одна из них.
Если timeout отрицательный, ожидания не происходит.
-
Примеры использования matplotlib.figure.Figure
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/2.2.3/api/_as_gen/matplotlib.figure.Figure.html