Художники

Inheritance diagram of matplotlib.patches, matplotlib.lines, matplotlib.text, matplotlib.offsetbox, matplotlib.image

matplotlib.художник

class matplotlib.artist.Artist

Bases: object

Абстрактный базовый класс для элементов, которые отображаются в FigureCanvas.

add_callback(func)

Добавляет функцию обратного вызова, которая будет вызываться всякий раз, когда изменяется одно из свойств Artist.

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

aname = 'Artist'

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

contains(mouseevent)

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

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

convert_xunits(x): Для элементов на оси, если ось x поддерживает единицы измерения, преобразует x с использованием типа единиц оси x.

convert_yunits(y): Для элементов на оси, если ось y поддерживает единицы измерения, преобразует y с использованием типа единиц оси y.

draw(renderer, *args, **kwargs): Метод рисования производных классов.

findobj(match=None, include_self=True)

Находит объекты элементов.

Рекурсивно находит все экземпляры Artist, содержащиеся в self.

match может быть

None: вернуть все объекты, содержащиеся в элементе.
функцией с сигнатурой boolean = match(artist) для фильтрации совпадений.
экземпляром класса, например, Line2D. Вернуть только элементы класса.

Если include_self равно True (по умолчанию), включить self в список для проверки совпадения.

format_cursor_data(data): Возвращает отформатированную строку данных курсора.

get_agg_filter(): Возвращает функцию фильтра для использования с фильтром agg.

get_alpha(): Возвращает значение alpha, используемое для смешения. Не поддерживается во всех бэкэндах.

get_animated(): Возвращает состояние анимации элемента.

get_axes()

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

Этот метод устарел в mpl 1.5, используйте свойство axes. Будет удален в 1.7 или 2.0.

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

get_clip_box(): Возвращает область обрезки элемента.

get_clip_on(): Возвращает, использует ли элемент обрезку.

get_clip_path(): Возвращает путь обрезки элемента.

get_contains(): Возвращает тест _contains, используемый элементом, или None для значения по умолчанию.

get_cursor_data(event): Получает данные курсора для данного события.

get_figure(): Возвращает экземпляр Figure, к которому относится элемент.

get_gid(): Возвращает идентификатор группы.

get_label(): Получает метку, используемую для этого элемента в легенде.

get_path_effects()

get_picker(): Возвращает объект пикера, используемый этим элементом.

get_rasterized(): Возвращает True, если элемент должен быть растрирован.

get_sketch_params()

Возвращает параметры наброска для элемента.

Возвращает:

Возвращает:	sketch_params : кортеж или `None` Кортеж из 3 элементов: `scale`: Амплитуда колебаний перпендикулярно исходной линии. `length`: Длина колебаний вдоль линии. `randomness`: Коэффициент масштабирования, на который уменьшается или увеличивается длина. Может возвращать `None` если параметры наброска не были заданы.

sketch_params : кортеж или None

Кортеж из 3 элементов:

scale: Амплитуда колебаний перпендикулярно исходной линии.
length: Длина колебаний вдоль линии.
randomness: Коэффициент масштабирования, на который уменьшается или увеличивается длина.

Может возвращать None если параметры наброска не были заданы.

get_snap()

Возвращает значение настройки привязки, которое может быть:

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

Поддерживается только бэкендами Agg и MacOSX.

get_transform(): Возвращает экземпляр Transform, используемый этим элементом.

get_transformed_clip_path_and_affine(): Возвращает путь обрезки с примененной частью преобразования, не связанной с аффином, и оставшейся аффинной частью преобразования.

get_url(): Возвращает URL.

get_visible(): Возвращает видимость элемента.

get_window_extent(renderer)

Получает область ограничивающего прямоугольника оси в пространстве отображения. Подклассы должны переопределять для включения в расчет области «жесткого» ограничивающего прямоугольника. По умолчанию возвращает пустую область ограничивающего прямоугольника в координатах 0, 0.

Будьте внимательны при использовании этой функции. Результаты не обновляются, если изменяется область ограничивающего прямоугольника элемента в пространстве окна. Область ограничивающего прямоугольника может измениться из-за любых изменений в стеке преобразования, таких как изменение пределов осей, размера фигуры или используемого холста (как при сохранении изображения). Это может привести к неожиданному поведению, когда интерактивные изображения будут выглядеть нормально на экране, но будут сохранены неправильно.

get_zorder(): Возвращает порядок элемента Artist.

have_units(): Возвращает True, если для осей x или y установлены единицы измерения.

hitlist(event): Выводит список дочерних элементов элемента, которые содержат событие мыши event.

is_figure_set(): Возвращает True, если элемент присвоен Figure.

is_transform_set(): Возвращает True, если у Artist явно установлено преобразование.

mouseover

pchanged(): Вызывает событие при изменении свойства, вызывая все зарегистрированные обратные вызовы.

pick(mouseevent)

подпись:

pick(mouseevent)

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

pickable(): Возвращает True, если Artist допускает выбор.

properties(): возвращает словарь сопоставлений имя свойства -> значение для всех свойств Artist

remove()

Удалить элемент графического интерфейса с фигуры, если это возможно. Эффект не будет виден до перерисовки фигуры, например, с помощью matplotlib.axes.Axes.draw_idle(). Вызовите matplotlib.axes.Axes.relim(), чтобы обновить пределы осей, если нужно.

Примечание: relim() не будет видеть коллекции, даже если коллекция была добавлена к осям с autolim = True.

Примечание: удаление записи легенды элемента графического интерфейса не поддерживается.

remove_callback(oid)

Удалить обратный вызов на основе его id.

См. также

add_callback(): Для добавления обратных вызовов

set(**kwargs): Установщик свойств по партиям. Передайте kwargs для установки свойств. Будет обрабатывать коллизии имён свойств (например, если указаны как ‘color’, так и ‘facecolor’, свойство с более высоким приоритетом устанавливается последним).

set_agg_filter(filter_func): Установить функцию agg_filter.

set_alpha(alpha)

Установить значение альфа для смешивания — не поддерживается во всех бэкендах.

ПРИНИМАЕТ: float (от 0.0 — прозрачный до 1.0 — непрозрачный)

set_animated(b)

Установить состояние анимации элемента графического интерфейса.

ПРИНИМАЕТ: [True | False]

set_axes(axes)

Установить экземпляр Axes , в котором находится элемент графического интерфейса, если он есть.

Этот метод устарел в mpl 1.5, используйте свойство axes. Удаление в 1.7 или 2.0.

ПРИНИМАЕТ: экземпляр Axes

set_clip_box(clipbox)

Установить область обрезки элемента графического интерфейса Bbox.

ПРИНИМАЕТ: экземпляр matplotlib.transforms.Bbox

set_clip_on(b)

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

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

ПРИНИМАЕТ: [True | False]

set_clip_path(path, transform=None)

Установить путь обрезки элемента графического интерфейса, который может быть:

экземпляр Patch (или подкласс)
a Path instance, in which case

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

Для повышения эффективности, если путь является прямоугольником с выровненными осями, этот метод установит прямоугольник обрезки соответствующему прямоугольнику и установит путь обрезки в None.

ПРИНИМАЕТ: [ (Path, Transform) | Patch | None ]

set_contains(picker)

Заменить тест содержимого, используемый этим элементом графического интерфейса. Новый селектор — это вызываемая функция, которая определяет, попадает ли элемент графического интерфейса под событие мыши:

hit, props = picker(artist, mouseevent)

Если событие мыши над элементом графического интерфейса, верните hit = True и props — словарь свойств, которые вы хотите вернуть с тестом содержимого.

ПРИНИМАЕТ: вызываемая функция

set_figure(fig)

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

ПРИНИМАЕТ: экземпляр matplotlib.figure.Figure

set_gid(gid)

Устанавливает (групповой) идентификатор для элемента графического интерфейса

ПРИНИМАЕТ: строку-идентификатор

set_label(s)

Установить метку на s для автоматической легенды.

ПРИНИМАЕТ: строку или любой печатаемый текст с преобразованием «%s».

set_path_effects(path_effects): Установить path_effects, которые должны быть списком экземпляров класса matplotlib.patheffect._Base или его производных.

set_picker(picker)

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

picker может быть одним из следующих:

None: выбор для этого элемента графического интерфейса отключён (по умолчанию)
Булево значение: если True, то выбор включён, и элемент графического интерфейса сгенерирует событие выбора, если курсор мыши находится над ним
Число с плавающей точкой: если picker — число, оно интерпретируется как допуск эпсилон в пунктах, и элемент графического интерфейса сгенерирует событие, если его данные находятся в пределах эпсилон от события мыши. Для некоторых элементов графического интерфейса, таких как линии и коллекции патчей, элемент графического интерфейса может предоставить дополнительный набор данных для события выбора, например, индексы данных, которые находятся в пределах эпсилон от события выбора
Функция: если picker — вызываемая функция, это пользовательская функция, которая определяет, попадает ли элемент графического интерфейса под событие мыши:
```
hit, props = picker(artist, mouseevent)
```
для определения теста попадания. если событие мыши над элементом графического интерфейса, верните hit=True и props — словарь свойств, которые вы хотите добавить к атрибутам PickEvent.

ПРИНИМАЕТ: [None|число с плавающей точкой|булево значение|вызываемая функция]

set_rasterized(rasterized)

Принудительно использовать растровое (битовое) отображение в выходных данных векторного бэкенда.

По умолчанию None, что подразумевает поведение по умолчанию бэкенда

ПРИНИМАЕТ: [True | False | None]

set_sketch_params(scale=None, length=None, randomness=None)

Устанавливает параметры эскиза.

Параметры:

Параметры:	scale : float, необязательно Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — `None`, или не предоставлено, фильтр эскиза не будет предоставлен. length : float, необязательно Длина колебаний вдоль линии в пикселях (по умолчанию 128.0) randomness : float, необязательно Множитель масштаба, по которому длина сжимается или расширяется (по умолчанию 16.0)

scale : float, необязательно

Амплитуда колебаний перпендикулярно исходной линии в пикселях. Если scale — None, или не предоставлено, фильтр эскиза не будет предоставлен.

length : float, необязательно

Длина колебаний вдоль линии в пикселях (по умолчанию 128.0)

randomness : float, необязательно

Множитель масштаба, по которому длина сжимается или расширяется (по умолчанию 16.0)

set_snap(snap)

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

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

Поддерживается только бэкендами Agg и MacOSX.

set_transform(t)

Установить экземпляр Transform, используемый этим элементом графического интерфейса.

ПРИНИМАЕТ: экземпляр Transform

set_url(url)

Устанавливает URL для элемента графического интерфейса

ПРИНИМАЕТ: строку URL

set_visible(b)

Установить видимость элемента графического интерфейса.

ПРИНИМАЕТ: [True | False]

set_zorder(level)

Установить z-порядок для элемента графического интерфейса. Элементы графического интерфейса с меньшими значениями z-порядка рисуются первыми.

ПРИНИМАЕТ: любое число

stale: Если элемент графического интерфейса «недействителен» и требует перерисовки, чтобы вывод соответствовал внутреннему состоянию элемента графического интерфейса.

update(props): Обновить свойства этого элемента графического интерфейса Artist из словаря prop.

update_from(other): Скопировать свойства из other в self.

zorder = 0

class matplotlib.artist.ArtistInspector(o)

Bases: object

Класс-помощник для проверки Artist и возвращения информации о настраиваемых свойствах и их текущих значениях.

Инициализируйте инспектор объекта с помощью Artist или последовательностью Artists. Если используется последовательность, предполагается, что она однородна (все Artists одного типа), и вы несете ответственность за подтверждение этого.

aliased_name(s)

Возвращает ‘НАЗВАНИЕ_СВОЙСТВА или псевдоним’, если у s есть псевдоним, иначе возвращает НАЗВАНИЕ_СВОЙСТВА.

Например, для свойства markerfacecolor линии с псевдонимом возвращается ‘markerfacecolor или mfc’, а для свойства transform, у которого нет псевдонима, возвращается ‘transform’.

aliased_name_rest(s, target)

Возвращает ‘НАЗВАНИЕ_СВОЙСТВА или псевдоним’, если у s есть псевдоним, иначе возвращает НАЗВАНИЕ_СВОЙСТВА в формате ReST.

findobj(match=None)

Рекурсивно находит все экземпляры matplotlib.artist.Artist, содержащиеся в self.

Если match не равно None, оно может быть:

функцией со сигнатурой boolean = match(artist)
экземпляром класса: например, Line2D

используется для фильтрации результатов.

get_aliases()

Получить словарь сопоставлений полное_имя -> псевдоним для каждого псевдонима в ArtistInspector.

Например, для линий:

{'markerfacecolor': 'mfc',
 'linewidth'      : 'lw',
}

get_setters(): Получить строки атрибутов с установщиками для объекта. Например, для линии вернуть ['markerfacecolor', 'linewidth', ....].

get_valid_values(attr)

Получить допустимые аргументы для установщика, связанного с attr.

Это делается путем запроса к строке документа функции set_attr для строки, начинающейся с ACCEPTS:

Например, для линии linestyle вернуть “[ '-' | '--' | '-.' | ':' | 'steps' | 'None' ]”

is_alias(o): Возвращает True, если объект метода o является псевдонимом другой функции.

pprint_getters(): Возвращает получатели и фактические значения в виде списка строк.

pprint_setters(prop=None, leadingspace=2)

Если prop равно None, вернуть список строк всех настраиваемых свойств и их допустимых значений.

Если prop не равно None, это допустимое имя свойства, и это свойство будет возвращено в виде строки "свойство: допустимые значения".

pprint_setters_rest(prop=None, leadingspace=2)

Если prop равно None, вернуть список строк всех настраиваемых свойств и их допустимых значений. Отформатировать вывод для ReST.

properties(): возвращает словарь, сопоставляющий имя свойства -> значение

matplotlib.artist.allow_rasterization(draw): Декоратор для метода Artist.draw. Предоставляет процедуры, которые выполняются до и после вызова draw. Функции до и после полезны для изменения атрибутов рендерера, зависящих от объекта, или для выполнения других установочных вызовов функций, таких как начало и сброс рендерера смешанного режима.

matplotlib.artist.get(obj, property=None)

Возвращает значение свойства объекта. property — необязательная строка для свойства, которое требуется вернуть.

Пример использования:

getp(obj)  # get all the object properties
getp(obj, 'linestyle')  # get the linestyle property

obj — экземпляр Artist, например, Line2D или экземпляр Axes или matplotlib.text.Text. Если property равно ‘somename’, эта функция возвращает

obj.get_somename()

getp() может использоваться для запроса всех настраиваемых свойств с getp(obj). Многие свойства имеют псевдонимы для сокращения ввода, например, ‘lw’ — псевдоним для ‘linewidth’. В выводе псевдонимы и полные имена свойств будут перечислены как:

свойство или псевдоним = значение

Например:

linewidth или lw = 2

matplotlib.artist.getp(obj, property=None)

Пример использования:

getp(obj)  # get all the object properties
getp(obj, 'linestyle')  # get the linestyle property

obj.get_somename()

свойство или псевдоним = значение

Например:

linewidth или lw = 2

matplotlib.artist.kwdoc(a)

matplotlib.artist.setp(obj, *args, **kwargs)

Установить свойство объекта художника.

matplotlib поддерживает использование setp() («установить свойство») и getp() для установки и получения свойств объекта, а также для интроспекции объекта. Например, чтобы установить стиль линии для линии штриховой, вы можете сделать следующее:

>>> line, = plot([1,2,3])
>>> setp(line, linestyle='--')

Если вы хотите узнать допустимые типы аргументов, вы можете указать имя свойства, которое хотите установить, без значения:

>>> setp(line, 'linestyle')
    linestyle: [ '-' | '--' | '-.' | ':' | 'steps' | 'None' ]

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

>>> setp(line)
    ... long output listing omitted

setp() работает с одним экземпляром или списком экземпляров. Если вы находитесь в режиме запроса, интроспектируя возможные значения, используется только первый экземпляр в последовательности. При фактической установке значений будут установлены все экземпляры. Например, предположим, у вас есть список из двух линий, следующее сделает обе линии толще и красного цвета:

>>> x = arange(0,1.0,0.01)
>>> y1 = sin(2*pi*x)
>>> y2 = sin(4*pi*x)
>>> lines = plot(x, y1, x, y2)
>>> setp(lines, linewidth=2, color='r')

setp() работает со строками/значениями в стиле MATLAB или с python-ключами. Например, следующие варианты эквивалентны:

>>> setp(lines, 'linewidth', 2, 'color', 'r')  # MATLAB style
>>> setp(lines, linewidth=2, color='r')        # python style