offsetbox

matplotlib.offsetbox

OffsetBox — это простой контейнерный элемент. Элементы-потомки должны отображаться в относительном положении к своему родителю. [VH]Packer, DrawingArea и TextArea являются производными от OffsetBox.

[VH]Packer автоматически настраивает относительные положения своих потомков, которые должны быть экземплярами OffsetBox. Это используется для выравнивания похожих элементов, например, в легенде.

DrawingArea может содержать любой элемент Artist в качестве потомка. DrawingArea имеет фиксированную ширину и высоту. Положение потомков относительно родителя фиксировано. TextArea содержит единственный элемент Text. Ширина и высота TextArea — это ширина и высота текста.

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]

Базовый класс: matplotlib.offsetbox.OffsetBox

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

loc — строка или целое число, определяющее расположение легенды. Допустимые коды расположения:

'upper right'  : 1,
'upper left'   : 2,
'lower left'   : 3,
'lower right'  : 4,
'right'        : 5, (same as 'center right', for back-compatibility)
'center left'  : 6,
'center right' : 7,
'lower center' : 8,
'upper center' : 9,
'center'       : 10,

pad : pad around the child for drawing a frame. given in: доля размера шрифта.

borderpad — отступ между рамкой offsetbox и bbox_to_anchor,

child — экземпляр OffsetBox, который будет привязан.

prop — свойства шрифта. Используются только для определения отступов.

frameon — отрисовывать рамку, если True.

bbox_to_anchor — область, к которой будет привязан контейнер. Если None, используется self.axes.bbox.

bbox_transform — преобразование, которое будет применено к bbox_to_anchor.

codes = {'center': 10, 'center left': 6, 'center right': 7, 'lower center': 8, 'lower left': 3, 'lower right': 4, 'right': 5, 'upper center': 9, 'upper left': 2, 'upper right': 1}

draw(renderer) [source]: Отрисовка элемента.

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

get_child() [source]: Возвращает дочерний элемент.

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

get_extent(renderer) [source]: Возвращает область элемента. Возвращается область потомка с добавленным отступом.

get_window_extent(renderer) [source]: Возвращает область элемента в пространстве отображения.

set_bbox_to_anchor(bbox, transform=None) [source]

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

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

set_child(child) [source]: Устанавливает дочерний элемент для привязки.

update_frame(bbox, fontsize=None) [source]

zorder = 5

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

Базовый класс: matplotlib.offsetbox.AnchoredOffsetbox

AnchoredOffsetbox с элементом Text.

Параметры:	`s : string` Текст. `loc : str` Код расположения. `pad : float, optional` Отступ между текстом и рамкой в долях размера шрифта. `borderpad : float, optional` Отступ между рамкой и осями (или bbox_to_anchor). `prop : matplotlib.font_manager.FontProperties` Свойства шрифта.

Примечания

Также допускаются другие ключевые параметры класса AnchoredOffsetbox.

class 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

Класс, подобный Annotation, но с offsetbox вместо Text.

offsetbox : экземпляр OffsetBox

xycoords : same as Annotation but can be a tuple of two: строки, интерпретируемые как координаты x и y.
boxcoords : similar to textcoords as Annotation but can be a: кортеж из двух строк, интерпретируемых как координаты x и y.
box_alignment : a tuple of two floats for a vertical and: горизонтальное выравнивание offsetbox относительно boxcoords. Левый нижний угол — (0.0), правый верхний — (1.1).

другие параметры идентичны параметрам Annotation.

anncoords

contains(event) [source]

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

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

draw(renderer) [source]: Отрисовывает объект Annotation в заданном рендерере.

get_children() [source]: Возвращает список дочерних элементов, которые содержит Artist`s this :class:`Artist.

get_fontsize(s=None) [source]: Возвращает размер шрифта в пунктах.

set_figure(fig) [source]

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

Параметры:	`fig : Figure`

set_fontsize(s=None) [source]: Устанавливает размер шрифта в пунктах.

update_positions(renderer) [source]: Обновляет пиксельные координаты отмеченной точки и текста.

xyann

zorder = 3

END_OF_DOCUMENT_MARKER

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]: Отобразить дочерние элементы

get_extent(renderer) [source]: Возвращает ширину, высоту, xdescent, ydescent рамки

get_offset() [source]: возвращает смещение контейнера.

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

get_window_extent(renderer) [source]: получить ограничивающую рамку в пространстве отображения.

set_offset(xy) [source]

установить смещение контейнера.

Принимает: кортеж с координатами 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]

class matplotlib.offsetbox.DraggableBase(ref_artist, use_blit=False) [source]

Базы: object

Вспомогательный код для перемещаемого элемента (легенды, offsetbox). Производный класс должен переопределить следующие два метода.

def save_offset(self):: pass
def update_offset(self, dx, dy):: pass

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

update_offset вызывается во время перетаскивания. dx и dy — смещение пикселей: от точки начала перетаскивания мыши.

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

def artist_picker(self, artist, evt):: return self.ref_artist.contains(evt)
def finalize_offset(self):: pass

artist_picker — метод выделения, который будет: использоваться. finalize_offset вызывается при отпускании мыши. В текущей реализации DraggableLegend и DraggableAnnotation метод update_offset просто размещает элементы в координатах отображения. А finalize_offset пересчитывает их положение в нормализованных координатах осей и задаёт соответствующий атрибут.

artist_picker(artist, evt) [source]

disconnect() [source]: отключить обработчики событий

finalize_offset() [source]

on_motion(evt) [source]

on_motion_blit(evt) [source]

on_pick(evt) [source]

on_release(event) [source]

save_offset() [source]

update_offset(dx, dy) [source]

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

END_OF_DOCUMENT_MARKER

class matplotlib.offsetbox.DrawingArea(width, height, xdescent=0.0, ydescent=0.0, clip=False) [source]

Базовое класс: matplotlib.offsetbox.OffsetBox

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

width, height : ширина и высота контейнерной области. xdescent, ydescent : спуск области по оси x и y. clip : нужно ли обрезать дочерние элементы

add_artist(a) [source]: Добавить любой Artist в контейнерную область

clip_children: Если дочерние элементы DrawingArea должны быть обрезаны по границам DrawingArea.

draw(renderer) [source]: Отрисовать дочерние элементы

get_extent(renderer) [source]: Возвращает ширину, высоту, xdescent, ydescent области

get_offset() [source]: Возвращает смещение контейнера.

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

get_window_extent(renderer) [source]: Получить область в пространстве отображения.

set_offset(xy) [source]

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

Принимает : кортеж из координат x, y в единицах отображения.

set_transform(t) [source]: set_transform игнорируется.

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

Базовое класс: matplotlib.offsetbox.PackerBase

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

Параметры:	`pad : float, optional` Отступ от границы. `sep : float, optional` Отступ между элементами. `width : float, optional` `height : float, optional` Ширина и высота контейнерной области, вычисляются, если `None`. `align : str` Выравнивание областей. `mode : str` Режим укладки.

Примечания

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

get_extent_offsets(renderer) [source]: Обновление смещения дочерних элементов и возврат размеров области

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

Базовое класс: matplotlib.artist.Artist

OffsetBox — это простой контейнерный объект. Дочерние объекты предполагается отрисовывать в относительном положении к родительскому элементу.

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

contains(mouseevent) [source]

Проверить, содержит ли объект событие мыши.

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

draw(renderer) [source]: Обновить расположение дочерних элементов при необходимости и нарисовать их для данного renderer.

get_children() [source]: Возвращает список содержащихся объектов.

get_extent(renderer) [source]: Возвращает ширину, высоту, xdescent, ydescent области.

get_extent_offsets(renderer) [source]

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

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

Принимает размеры области.

get_visible_children() [source]: Возвращает список видимых объектов.

get_window_extent(renderer) [source]: Получить область в пространстве отображения.

set_figure(fig) [source]

Установить фигуру.

Принимает экземпляр класса:Figure

set_height(height) [source]

Установить высоту.

Принимает число с плавающей точкой.

set_offset(xy) [source]

Установить смещение.

Принимает x, y, кортеж или вызываемый объект.

set_width(width) [source]

Установить ширину.

Принимает число с плавающей точкой.

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

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

draw(renderer) [source]: Отобразить дочерние элементы

get_children() [source]: Возвращает список содержащихся в нём объектов.

get_data() [source]

get_extent(renderer) [source]: Возвращает ширину, высоту, смещение по оси X и смещение по оси Y прямоугольника.

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=None, mode=None, children=None) [source]

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

Параметры:

Параметры:	`pad : float, optional` Отступ от границ. `sep : float, optional` Интервал между элементами. `width : float, optional` `height : float, optional` Ширина и высота контейнера, вычисляются, если `None`. `align : str, optional` Выравнивание блоков. Может быть одним из `top`, `bottom`, `left`, `right`, `center` и `baseline` `mode : str, optional` Режим упаковки.

pad : float, optional: Отступ от границ.
sep : float, optional: Интервал между элементами.
width : float, optional
height : float, optional: Ширина и высота контейнера, вычисляются, если None.
align : str, optional: Выравнивание блоков. Может быть одним из top, bottom, left, right, center и baseline
mode : str, optional: Режим упаковки.

Примечания

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

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

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

pad : отступ от границ

Примечание

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

draw(renderer) [source]: Обновить расположение дочерних элементов при необходимости и нарисовать их на заданном рендере.

draw_frame(renderer) [source]

get_extent_offsets(renderer) [source]: обновление смещений дочерних элементов и возвращение размеров блока

update_frame(bbox, fontsize=None) [source]

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

Базы: matplotlib.offsetbox.OffsetBox

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

Параметры:

Параметры:	`s : str` строка для отображения. `textprops : FontProperties, optional` `multilinebaseline : bool, optional` Если `True`, оснований для многострочного текста корректируется так, чтобы оно было (приблизительно) центрировано по отношению к однострочному тексту. `minimumdescent : bool, optional` Если `True`, у рамки есть минимальный спуск "p".

s : str: строка для отображения.
textprops : FontProperties, optional
multilinebaseline : bool, optional: Если True, оснований для многострочного текста корректируется так, чтобы оно было (приблизительно) центрировано по отношению к однострочному тексту.
minimumdescent : bool, optional: Если True, у рамки есть минимальный спуск "p".

draw(renderer) [source]: Отрисовать дочерние элементы

get_extent(renderer) [source]: Возвращает ширину, высоту, xdescent, ydescent рамки.

get_minimumdescent() [source]: Получить минимальный спуск.

get_multilinebaseline() [source]: Получить многострочный базовый уровень.

get_offset() [source]: Возвращает смещение контейнера.

get_text() [source]: Возвращает строковое представление текста этой области.

get_window_extent(renderer) [source]: Получить прямоугольник ограничивающей рамки в пространстве отображения.

set_minimumdescent(t) [source]

Установить минимальный спуск.

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

set_multilinebaseline(t) [source]

Установить многострочный базовый уровень.

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

set_offset(xy) [source]

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

Принимает : кортеж координат 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]

Базы: matplotlib.offsetbox.PackerBase

VPacker располагает свои дочерние элементы вертикально. Он автоматически корректирует относительное положение дочерних элементов во время отрисовки.

Параметры:

Параметры:	`pad : float, optional` Отступ от границы. `sep : float, optional` Пробел между элементами. `width : float, optional` `height : float, optional` Ширина и высота контейнера, вычисляются, если `None`. `align : str, optional` Выравнивание элементов. `mode : str, optional` Режим компоновки.

pad : float, optional: Отступ от границы.
sep : float, optional: Пробел между элементами.
width : float, optional
height : float, optional: Ширина и высота контейнера, вычисляются, если None.
align : str, optional: Выравнивание элементов.
mode : str, optional: Режим компоновки.

Примечания

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

get_extent_offsets(renderer) [source]: Обновляет смещение дочерних элементов и возвращает размеры рамки.

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