matplotlib.offsetbox

Контейнерные классы для Artist.

OffsetBox

Базовый класс всех контейнерных элементов, определённых в этом модуле.

AnchoredOffsetbox, AnchoredText

Привязка и выравнивание произвольного Artist или текста относительно родительских осей или определённой точки привязки.

DrawingArea

Контейнер с фиксированной шириной и высотой. Дочерние элементы имеют фиксированное положение внутри контейнера и могут быть обрезаны.

HPacker, VPacker

Контейнеры для выравнивания дочерних элементов по горизонтали или вертикали.

PaddedBox

Контейнер для добавления отступа вокруг элемента Artist.

TextArea

Содержит один объект Text.

class matplotlib.offsetbox.AnchoredOffsetbox(loc, pad=0.4, borderpad=0.5, child=None, prop=None, frameon=True, bbox_to_anchor=None, bbox_transform=None, **kwargs)[source]

Bases: matplotlib.offsetbox.OffsetBox

Объект смещения, размещаемый в соответствии с расположением loc.

AnchoredOffsetbox имеет единственного потомка. Если требуется несколько потомков, используйте дополнительный OffsetBox для их объединения. По умолчанию объект смещения привязан к родительским осям. Вы можете явно указать bbox_to_anchor.

Параметры:

locstr Расположение объекта. Поддерживаемые значения: 'верхний правый' 'верхний левый' 'нижний левый' 'нижний правый' 'центр слева' 'центр справа' 'нижний центр' 'верхний центр' 'центр' Для обратной совместимости принимаются и числовые значения. См. параметр loc в Legend для получения подробностей. padfloat, по умолчанию: 0.4 Отступ вокруг потомка в долях размера шрифта. borderpadfloat, по умолчанию: 0.5 Отступ между рамкой offsetbox и bbox_to_anchor. childOffsetBox Объект, который будет привязан. propFontProperties Используется только для отступов. Если не указано, используется rcParams["legend.fontsize"] (по умолчанию 'medium'). frameonbool Определяет, будет ли нарисована рамка вокруг объекта. bbox_to_anchorBboxBase, кортеж из 2 или 4 чисел с плавающей точкой Прямоугольник, используемый для позиционирования легенды вместе с loc. bbox_transformNone или matplotlib.transforms.Transform Преобразование для ограничивающей рамки (bbox_to_anchor). **kwargs Все остальные параметры передаются OffsetBox.

Примечания

См. Legend для подробного описания механизма привязки.

codes = {'центр': 10, 'центр слева': 6, 'центр справа': 7, 'нижний центр': 8, 'нижний левый': 3, 'нижний правый': 4, 'справа': 5, 'верхний центр': 9, 'верхний левый': 2, 'верхний правый': 1}

draw(renderer)[source]

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

get_bbox_to_anchor()[source]

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

get_child()[source]

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

get_children()[source]

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

get_extent(renderer)[source]

Возвращает размер объекта как (ширина, высота, x, y).

Это размер потомка плюс отступ.

get_window_extent(renderer)[source]

Возвращает ограничивающую рамку в пространстве отображения.

set_bbox_to_anchor(bbox, transform=None)[source]

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

bbox может быть экземпляром Bbox, списком [лево, низ, ширина, высота] или списком [лево, низ], где ширина и высота считаются нулевыми. Прямоугольник будет преобразован в координаты отображения с помощью заданного преобразования.

set_child(child)[source]

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

update_frame(bbox, fontsize=None)[source]

zorder = 5

класс matplotlib.offsetbox.AnchoredText(s, loc, pad=0.4, borderpad=0.5, prop=None, **kwargs)[source]

Базы: matplotlib.offsetbox.AnchoredOffsetbox

AnchoredOffsetbox с текстом.

Параметры:

sстрока Текст. locстрока Код расположения. См. AnchoredOffsetbox. padвещественное число, по умолчанию: 0,4 Отступ вокруг текста в долях размера шрифта. borderpadвещественное число, по умолчанию: 0,5 Отступ между рамкой offsetbox и bbox_to_anchor. propсловарь, необязательно Словарь ключевых параметров, которые будут переданы экземпляру Text, содержащемуся внутри AnchoredText. **kwargs Все остальные параметры передаются в AnchoredOffsetbox.

класс matplotlib.offsetbox.AnnotationBbox(offsetbox, xy, xybox=None, xycoords='data', boxcoords=None, frameon=True, pad=0.4, annotation_clip=None, box_alignment=(0.5, 0.5), bboxprops=None, arrowprops=None, fontsize=None, **kwargs)[source]

Базы: matplotlib.artist.Artist, matplotlib.text._AnnotationBase

Контейнер для OffsetBox, ссылающегося на определённую позицию xy.

Можно дополнительно нарисовать стрелку, указывающую от offsetbox к xy.

Это похоже на Annotation, но с OffsetBox вместо Text.

Параметры:

offsetboxOffsetBox xy(float, float) Точка (x, y) для аннотации. Система координат определяется параметром xycoords. xybox(float, float), по умолчанию: xy Позиция (x, y) для размещения текста. Система координат определяется параметром boxcoords. xycoordsстрока или Artist или Transform или вызываемый объект или (float, float), по умолчанию: 'data' Система координат, в которой заданы координаты xy. Смотрите параметр xycoords в Annotation для подробного описания. boxcoordsстрока или Artist или Transform или вызываемый объект или (float, float), по умолчанию: значение xycoords Система координат, в которой заданы координаты xybox. Смотрите параметр textcoords в Annotation для подробного описания. frameonbool, по умолчанию: True Отображать ли рамку вокруг области. padfloat, по умолчанию: 0.4 Отступ вокруг offsetbox. box_alignment(float, float) Кортеж из двух чисел для вертикального и горизонтального выравнивания offsetbox относительно boxcoords. В левом нижнем углу (0, 0), а в правом верхнем (1, 1). **kwargs Другие параметры идентичны Annotation.

свойство anncoords

contains(mouseevent)[source]

Проверка, содержит ли объект художник событие мыши.

Параметры:	mouseeventmatplotlib.backend_bases.MouseEvent
Возвращает:	containsbool Принадлежит ли какая-либо точка заданному радиусу. detailsdict Словарь, содержащий данные о контексте события, такие как точки, находящиеся в радиусе выделения. Подробности см. в классах-потомках Художников.

draw(renderer)[source]

Рисует Художника (и его потомков) с помощью данного рендерера.

Не имеет эффекта, если художник не видим (Artist.get_visible возвращает False).

Параметры:	rendererRendererBase подкласс.

Примечания

Этот метод переопределён в подклассах Художников.

get_children()[source]

Возвращает список дочерних Artist этого Artist.

get_fontsize(s=<параметр устарел>)[source]

Возвращает размер шрифта в пунктах.

get_tightbbox(renderer)[source]

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

get_window_extent(renderer)[source]

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

set_figure(fig)[source]

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

Параметры:	figFigure

set_fontsize(s=None)[source]

Устанавливает размер шрифта в пунктах.

Если s не задан, сбросьте до rcParams["legend.fontsize"] (по умолчанию 'medium').

update_positions(renderer)[source]

Обновление пиксельных позиций аннотированной точки и текста.

свойство xyann

zorder = 3

class matplotlib.offsetbox.AuxTransformBox(aux_transform)[source]

Основы: matplotlib.offsetbox.OffsetBox

Объект смещения с aux_transform. Его дочерние элементы будут преобразовываться с помощью aux_transform, а затем будут смещены. Абсолютные координаты aux_transform означают, что они будут автоматически скорректированы таким образом, чтобы левая нижняя точка области ограничивающего прямоугольника дочерних элементов была установлена в (0, 0) перед преобразованием смещения.

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

add_artist(a)[source]

Добавить Artist в контейнерную область.

draw(renderer)[source]

Обновить расположение дочерних элементов при необходимости и нарисовать их на заданном renderer.

get_extent(renderer)[source]

Возвращает кортеж width, height, xdescent, ydescent прямоугольника.

get_offset()[source]

Возвращает смещение контейнера.

get_transform()[source]

Возвращает Transform, применяемый к дочерним элементам

get_window_extent(renderer)[source]

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

set_offset(xy)[source]

Устанавливает смещение контейнера.

Параметры:	xy(float, float) Координаты смещения (x, y) в единицах отображения.

set_transform(t)[source]

set_transform игнорируется.

class matplotlib.offsetbox.DraggableAnnotation(annotation, use_blit=False)[source]

Основы: matplotlib.offsetbox.DraggableBase

save_offset()[source]

update_offset(dx, dy)[source]

класс matplotlib.offsetbox.DraggableBase(ref_artist, use_blit=False)[source]

Базовый класс для перетаскиваемого объекта (легенды, offsetbox).

Базы: object

Производные классы должны переопределить следующие методы:

def save_offset(self):
    '''
    Called when the object is picked for dragging; should save the
    reference position of the artist.
    '''

def update_offset(self, dx, dy):
    '''
    Called during the dragging; (*dx*, *dy*) is the pixel offset from
    the point where the mouse drag started.
    '''

Можно также переопределить следующие методы:

def finalize_offset(self):
    '''Called when the mouse is released.'''

В текущей реализации DraggableLegend и DraggableAnnotation, update_offset размещает объекты в координатах экрана, а finalize_offset пересчитывает их положение в координатах осей и устанавливает соответствующее атрибут.

artist_picker(artist, evt)[source]

[Устарело]

Примечания

Устарело начиная с версии 3.3:

disconnect()[source]

Отключить обратные вызовы.

finalize_offset()[source]

on_motion(evt)[source]

on_motion_blit(evt)[source]

[Устарело]

Примечания

Устарело начиная с версии 3.3:

on_pick(evt)[source]

on_release(event)[source]

save_offset()[source]

update_offset(dx, dy)[source]

класс matplotlib.offsetbox.DraggableOffsetBox(ref_artist, offsetbox, use_blit=False)[source]

Базы: matplotlib.offsetbox.DraggableBase

get_loc_in_canvas()[source]

save_offset()[source]

update_offset(dx, dy)[source]

класс matplotlib.offsetbox.DrawingArea(width, height, xdescent=0.0, ydescent=0.0, clip=False)[source]

Базы: matplotlib.offsetbox.OffsetBox

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

Параметры:	width, heightfloat Ширина и высота контейнера. xdescent, ydescentfloat Спуск (descent) контейнера по x и y. clipbool Определяет, должны ли дочерние элементы быть обрезаны до границ контейнера.

add_artist(a)[source]

Добавление Artist в контейнер.

свойство clip_children

Если дочерние элементы DrawingArea должны быть обрезаны ограничивающей рамкой DrawingArea.

draw(renderer)[source]

Обновление местоположения дочерних элементов при необходимости и их отрисовка на заданном renderer.

get_extent(renderer)[source]

Возвращает ширину, высоту, xdescent и ydescent контейнера.

get_offset()[source]

Возвращает смещение контейнера.

get_transform()[source]

Возвращает Transform, применяемый к дочерним элементам.

get_window_extent(renderer)[source]

Возвращает ограничивающую рамку в пространстве отображения.

set_offset(xy)[source]

Устанавливает смещение контейнера.

Параметры:	xy(float, float) Координаты смещения (x, y) в единицах отображения.

set_transform(t)[source]

set_transform игнорируется.

класс matplotlib.offsetbox.HPacker(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]

Базы: matplotlib.offsetbox.PackerBase

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

Параметры:

padfloat, необязательно Поля вокруг контейнера в пунктах. sepfloat, необязательно Отступ между элементами в пунктах. width, heightfloat, необязательно Ширина и высота контейнера в пикселях, рассчитывается, если None. align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, по умолчанию: 'baseline' Выравнивание элементов. mode{'fixed', 'expand', 'equal'}, по умолчанию: 'fixed' Режим выравнивания. 'fixed' размещает указанные Artist плотно с отступом sep. 'expand' использует максимальное доступное пространство для равномерного распределения элементов с одинаковым отступом между ними. 'equal': Каждый элемент занимает равную долю доступного пространства и выравнивается слева (или сверху) в нём. childrenсписок Artist Элементы для выравнивания.

Примечания

pad и sep задаются в пунктах и масштабируются с разрешением рендерера dpi, а width и height — в пикселях.

get_extent_offsets(renderer)[source]

Обновление смещения дочерних элементов и возвращение размера контейнера.

Параметры:	rendererRendererBase подкласс
Возвращает:	width height xdescent ydescent список пар (xoffset, yoffset)

класс matplotlib.offsetbox.OffsetBox(*args, **kwargs)[source]

Bases: matplotlib.artist.Artist

OffsetBox — это простой контейнерный элемент.

Элементы-потомки предназначены для отрисовки в относительных позициях к своему родителю.

Как и любой элемент, все параметры передаются в Artist.

свойствоaxes

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

contains(mouseevent)[source]

Делегирует проверку нахождения курсора в пределах элементов-потомков.

Как контейнер, OffsetBox сам не реагирует на события мыши.

Параметры:	mouseeventmatplotlib.backend_bases.MouseEvent
Возвращает:	containsbool Является ли значение в пределах радиуса. detailsdict Словарь, содержащий информацию об событии, например, какие точки находятся в пределах радиуса выделения. Подробности зависят от конкретного подкласса элемента.

См. также

Artist.contains

draw(renderer)[source]

Обновляет расположение потомков при необходимости и отрисовывает их с помощью данного renderer.

get_children()[source]

Возвращает список элементов-потомков Artist.

get_extent(renderer)[source]

Возвращает кортеж width, height, xdescent, ydescent прямоугольника.

get_extent_offsets(renderer)[source]

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

Параметры:	rendererRendererBase подкласс
Возвращает:	width height xdescent ydescent список пар (xoffset, yoffset)

get_offset(width, height, xdescent, ydescent, renderer)[source]

Возвращает смещение в виде кортежа (x, y).

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

Параметры:	width, height, xdescent, ydescent Параметры области. rendererRendererBase подкласс

get_visible_children()[source]

Возвращает список видимых элементов-потомков Artist.

get_window_extent(renderer)[source]

Возвращает область (прямоугольник) Bbox в пространстве отображения.

set_figure(fig)[source]

Устанавливает Figure для OffsetBox и всех его потомков.

Параметры:	figFigure

set_height(height)[source]

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

Параметры:	heightfloat

set_offset(xy)[source]

Устанавливает смещение.

Параметры:	xy(float, float) или функция Координаты смещения (x, y) в единицах отображения. Они могут быть заданы явно в виде кортежа (x, y) или в виде функции, которая преобразует область в смещение. Эта функция должна иметь следующий сигнатуру: def offset(width, height, xdescent, ydescent, renderer) -> (float, float)

set_width(width)[source]

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

Параметры:	widthfloat

class matplotlib.offsetbox.OffsetImage(arr, zoom=1, cmap=None, norm=None, interpolation=None, origin=None, filternorm=True, filterrad=4.0, resample=False, dpi_cor=True, **kwargs)[source]

Bases: matplotlib.offsetbox.OffsetBox

draw(renderer)[source]

Обновить расположение дочерних элементов при необходимости и нарисовать их в указанном renderer.

get_children()[source]

Возвращает список дочерних элементов Artist.

get_data()[source]

get_extent(renderer)[source]

Возвращает кортеж width, height, xdescent, ydescent области.

get_offset()[source]

Возвращает смещение контейнера.

get_window_extent(renderer)[source]

Возвращает область отображения в пространстве отображения.

get_zoom()[source]

set_data(arr)[source]

set_zoom(zoom)[source]

class matplotlib.offsetbox.PackerBase(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]

Bases: matplotlib.offsetbox.OffsetBox

Parameters:

padfloat, optional Отступ границы в пунктах. sepfloat, optional Расстояние между элементами в пунктах. width, heightfloat, optional Ширина и высота контейнерной области в пикселях, вычисляется, если None. align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, default: 'baseline' Выравнивание областей. mode{'fixed', 'expand', 'equal'}, default: 'fixed' Режим упаковки. 'fixed' упаковывает заданные Artist плотно с отступом sep. 'expand' использует максимальное доступное пространство для распределения элементов с равным отступом между ними. 'equal': Каждый элемент занимает равную долю доступного пространства и выравнивается слева (или сверху) в этом пространстве. childrenlist of Artist Элементы для упаковки.

Примечания

pad и sep указаны в пунктах и будут масштабироваться с разрешением рендерера, в то время как width и height — в пикселях.

class matplotlib.offsetbox.PaddedBox(child, pad=None, draw_frame=False, patch_attrs=None)[source]

Bases: matplotlib.offsetbox.OffsetBox

Контейнер для добавления отступа вокруг Artist.

Класс PaddedBox содержит FancyBboxPatch, который используется для визуализации при отрисовке.

Параметры:	childArtist Содержимый Artist. padfloat Отступ в пунктах. Он будет масштабироваться с разрешением рендерера. В отличие от width и height, которые указаны в пикселях и, следовательно, не масштабируются. draw_framebool Определяет, будет ли отрисовываться рамка вокруг FancyBboxPatch. patch_attrsdict or None Дополнительные параметры, передаваемые в FancyBboxPatch.

draw(renderer)[source]

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

draw_frame(renderer)[source]

get_extent_offsets(renderer)[source]

Обновляет смещение дочерних элементов и возвращает размеры области.

Параметры:	rendererRendererBase подкласс
Возвращает:	width height xdescent ydescent список пар (xoffset, yoffset)

update_frame(bbox, fontsize=None)[source]

class matplotlib.offsetbox.TextArea(s, textprops=None, multilinebaseline=False, minimumdescent=)[source]

Bases: matplotlib.offsetbox.OffsetBox

TextArea — это контейнерный элемент для одного текстового объекта.

Текст размещается в координатах (0, 0) с выравниванием по основанию и левому краю по умолчанию. Ширина и высота TextArea равны ширине и высоте содержащегося в нем текста.

Параметры:

sstr Текст для отображения. textpropsdict, по умолчанию: {} Словарь ключевых параметров, которые будут переданы экземпляру Text внутри TextArea. multilinebaselinebool, по умолчанию: False Устанавливает, будет ли выравнивание по основанию многострочного текста скорректировано так, чтобы оно (приблизительно) совпадало с выравниванием по основанию однострочного текста. minimumdescentbool, по умолчанию: True Если True, размер контейнера содержит минимум размер нисходящей части символа "p". В настоящее время это значение всегда равно True.

draw(renderer)[source]

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

get_extent(renderer)[source]

Возвращает кортеж width, height, xdescent, ydescent размеров контейнера.

get_minimumdescent()[source]

[Устарело] Возвращает minimumdescent.

Примечания

Устарело начиная с версии 3.4.

get_multilinebaseline()[source]

Возвращает multilinebaseline.

get_offset()[source]

Возвращает смещение контейнера.

get_text()[source]

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

get_window_extent(renderer)[source]

Возвращает ограничивающую рамку в пространстве отображения.

set_minimumdescent(t)[source]

[Устарело] Устанавливает minimumdescent.

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

Примечания

Устарело начиная с версии 3.4.

set_multilinebaseline(t)[source]

Устанавливает multilinebaseline.

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

set_offset(xy)[source]

Устанавливает смещение контейнера.

Параметры:	xy(float, float) Координаты смещения (x, y) в единицах отображения.

set_text(s)[source]

Устанавливает текст этой области в виде строки.

set_transform(t)[source]

set_transform игнорируется.

class matplotlib.offsetbox.VPacker(pad=None, sep=None, width=None, height=None, align='baseline', mode='fixed', children=None)[source]

Bases: matplotlib.offsetbox.PackerBase

VPacker размещает свои дочерние элементы вертикально, автоматически настраивая их относительные позиции во время отрисовки.

Параметры:

padfloat, необязательно Отступ от границ в пунктах. sepfloat, необязательно Отступ между элементами в пунктах. width, heightfloat, необязательно Ширина и высота контейнера в пикселях, вычисляются, если None. align{'top', 'bottom', 'left', 'right', 'center', 'baseline'}, по умолчанию: 'baseline' Выравнивание элементов. mode{'fixed', 'expand', 'equal'}, по умолчанию: 'fixed' Режим размещения. 'fixed' размещает заданные Artist плотно с отступом sep. 'expand' использует максимальную доступную площадь для распределения элементов с равными отступами между ними. 'equal': Каждый элемент занимает равную долю доступного пространства и выравнивается по левому (или верхнему) краю. childrenсписок Artist Элементы для размещения.

Примечания

pad и sep указаны в пунктах и масштабируются с разрешением дисплея рендерера, в то время как width и height - в пикселях.

get_extent_offsets(renderer)[source]

Обновить смещение дочерних элементов и вернуть размеры области.

Параметры:	rendererподкласс RendererBase
Возвращает:	width height xdescent ydescent список пар (xoffset, yoffset)

matplotlib.offsetbox.bbox_artist(*args, **kwargs)[source]