Spec-Zone.ru › Matplotlib 3.8

matplotlib.spines

classmatplotlib.spines.Spine(axes, spine_type, path, **kwargs)[source]

Bases: Patch

Линия осей — линия, отмечающая границы области данных.

Линии осей — это линии, соединяющие отметки осей и обозначающие границы области данных. Они могут быть размещены в произвольных позициях. Дополнительную информацию см. в set_position.

По умолчанию положение — ('outward', 0).

Линии осей являются подклассами Patch и наследуют большую часть своего поведения.

Линии рисуют линию, окружность или дугу в зависимости от того, был ли вызван метод set_patch_line, set_patch_circle или set_patch_arc. По умолчанию используется вид линии.

Примеры см. в Примерах линий осей.

Параметры:
axesAxes

Экземпляр Axes, содержащий линию оси.

spine_typestr

Тип линии оси.

pathPath

Экземпляр Path, используемый для рисования линии оси.

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

Допустимые ключевые аргументы:

Свойство

Описание

agg_filter

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

alpha

неизвестно

animated

bool

antialiased или aa

bool или None

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clip_box

BboxBase или None

clip_on

bool

clip_path

Patch или (Path, Transform) или None

color

цвет

edgecolor или ec

цвет или None

facecolor или fc

цвет или None

figure

Figure

fill

bool

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или ls

{'-', '--', '-.', ':', '', (offset, on-off-seq), ...}

linewidth или lw

float или None

mouseover

bool

path_effects

список AbstractPathEffect

picker

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

rasterized

bool

sketch_params

(scale: float, length: float, randomness: float)

snap

bool или None

transform

Transform

url

str

visible

bool

zorder

float

classmethodarc_spine(axes, spine_type, center, radius, theta1, theta2, **kwargs)[source]

Создать и вернуть дугу Spine.

classmethodcircular_spine(axes, center, radius, **kwargs)[source]

Создать и вернуть окружность Spine.

clear()[source]

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

draw(renderer)[source]

Отрисовать объект (и его потомков) с помощью заданного рендерера.

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

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

Примечания

Этот метод переопределяется в подклассах объекта Artist.

get_bounds()[source]

Получить границы оси.

get_patch_transform()[source]

Возвращает объект Transform, преобразующий координаты элемента в данные.

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

get_path()[source]

Возвращает путь этого элемента.

get_position()[source]

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

get_spine_transform()[source]

Возвращает преобразование оси.

get_window_extent(renderer=None)[source]

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

См. также

matplotlib.axes.Axes.get_tightbbox
matplotlib.axes.Axes.get_window_extent
classmethodlinear_spine(axes, spine_type, **kwargs)[source]

Создать и вернуть линейную Spine.

register_axis(axis)[source]

Зарегистрировать ось.

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

set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, bounds=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, patch_arc=<UNSET>, patch_circle=<UNSET>, path_effects=<UNSET>, picker=<UNSET>, position=<UNSET>, rasterized=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]

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

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

Свойство

Описание

agg_filter

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

alpha

скаляр или None

animated

bool

antialiased или aa

bool или None

bounds

(low: float, high: float)

capstyle

CapStyle или {'butt', 'projecting', 'round'}

clip_box

BboxBase или None

clip_on

bool

clip_path

Patch или (Path, Transform) или None

color

цвет

edgecolor или ec

цвет или None

facecolor или fc

цвет или None

figure

Figure

fill

bool

gid

строка

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle или {'miter', 'round', 'bevel'}

label

объект

linestyle или ls

{'-', '--', '-.', ':', '', (смещение, последовательность вкл-выкл), ...}

linewidth или lw

число с плавающей точкой или None

mouseover

bool

patch_arc

неизвестно

patch_circle

неизвестно

path_effects

список AbstractPathEffect

picker

None или bool или число с плавающей точкой или вызываемый объект

position

неизвестно

rasterized

bool

sketch_params

(масштаб: float, длина: float, случайность: float)

snap

bool или None

transform

Transform

url

строка

visible

bool

zorder

число с плавающей точкой

set_bounds(low=None, high=None)[source]

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

Параметры:
lowfloat или None, необязательно

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

Пределы также можно передать в виде кортежа (low, high) в качестве первого позиционного аргумента.

highfloat или None, необязательно

Верхний предел отрезка. Передача None оставляет предел без изменений.

set_color(c)[source]

Установить цвет границы.

Параметры:
cцвет

Примечания

Этот метод не изменяет цвет заливки (который по умолчанию "none"), в отличие от метода Patch.set_color, определенного в родительском классе. Используйте Patch.set_facecolor для установки цвета заливки.

set_patch_arc(center, radius, theta1, theta2)[source]

Установить отступ в виде дуги.

set_patch_circle(center, radius)[source]

Установить отступ в виде окружности.

set_patch_line()[source]

Установить отступ в виде прямой линии.

set_position(position)[source]

Установить позицию отступа.

Позиция отступа задаётся кортежем из двух элементов (тип позиции, значение). Типы позиций:

  • 'outward': разместить отступ за пределами области данных на указанное количество точек. (Отрицательные значения размещают отступ внутрь.)
  • 'axes': разместить отступ в указанных координатах области Axes (от 0 до 1).
  • 'data': разместить отступ в указанных координатах данных.

Кроме того, сокращённые обозначения определяют специальные позиции:

  • 'center' -> ('axes', 0.5)
  • 'zero' -> ('data', 0.0)

Примеры

Размещение отступов

classmatplotlib.spines.Spines(**kwargs)[source]

Базовое: MutableMapping

Контейнер всех Spine в области Axes.

Интерфейс похож на словарь, сопоставляющий имена (например, 'left') с объектами Spine. Кроме того, он реализует некоторые функции, похожие на pandas.Series, например, доступ к элементам по атрибуту:

spines['top'].set_visible(False)
spines.top.set_visible(False)

Несколько отступов можно адресовать одновременно, передавая список:

spines[['top', 'right']].set_visible(False)

Используйте открытый срез для обращения ко всем отступам:

spines[:].set_visible(False)

Два последних метода индексирования вернут SpinesProxy, который транслирует все вызовы методов set_*() и set() своим членам, но не может быть использован для других операций.

classmethodfrom_dict(d)[source]
classmatplotlib.spines.SpinesProxy(spine_dict)[source]

Базовое: object

Прокси для трансляции вызовов методов set_*() и set() к содержащим Spines.

Прокси нельзя использовать для других операций с его членами.

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

© 2012–2023 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.8.4/api/spines_api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API