matplotlib.patheffects

Определяет классы для эффектов траектории. Эффекты траектории поддерживаются в Text, Line2D и Patch.

См. также

Руководство по эффектам траектории

classmatplotlib.patheffects.AbstractPathEffect(offset=(0.0, 0.0))[source]

Bases: object

Базовый класс для эффектов траектории.

Подклассы должны переопределить метод draw_path для добавления функциональности эффекта.

Параметры:

offset(float, float), по умолчанию: (0, 0): Смещение (x, y) для применения к траектории, измеряемое в точках.

draw_path(renderer, gc, tpath, affine, rgbFace=None)[source]: Производные классы должны переопределить этот метод. Аргументы такие же, как в matplotlib.backend_bases.RendererBase.draw_path(), за исключением того, что первый аргумент — это рендерер.

classmatplotlib.patheffects.Normal(offset=(0.0, 0.0))[source]

Bases: AbstractPathEffect

Эффект траектории "тождество".

Единственная цель эффекта траектории Normal — нарисовать исходный объект без специального эффекта траектории.

Параметры:

offset(float, float), по умолчанию: (0, 0): Смещение (x, y) для применения к траектории, измеряемое в точках.

END_OF_DOCUMENT_MARKER

classmatplotlib.patheffects.PathEffectRenderer(path_effects, renderer)[source]

Bases: RendererBase

Реализует рендерер, содержащий другой рендерер.

Этот прокси перехватывает вызовы отрисовки, вызывая соответствующий метод отрисовки AbstractPathEffect.

Примечание

Не все методы переопределены в этом подклассе RendererBase. Возможно, потребуется добавить дополнительные методы для расширения возможностей PathEffects.

Параметры:

path_effectsитерируемый список AbstractPathEffect: Эффекты для пути, которые представляет этот рендерер.
rendererRendererBase подкласс

close_group(s)[source]

Закрывает элемент группировки с меткой s.

Используется только рендерером SVG.

copy_with_path_effect(path_effects)[source]

draw_markers(gc, marker_path, marker_trans, path, *args, **kwargs)[source]

Отрисовывает маркер в каждой вершине path (исключая контрольные точки).

Базовая (fallback) реализация выполняет несколько вызовов draw_path. Бэкэнды могут переопределить этот метод для отрисовки маркера только один раз и повторного использования его несколько раз.

Параметры:

gcGraphicsContextBase: Контекст графики.
marker_pathPath: Путь для маркера.
marker_transTransform: Аффинное преобразование, применяемое к маркеру.
pathPath: Местоположения для отрисовки маркеров.
transTransform: Аффинное преобразование, применяемое к пути.
rgbFaceцвет, необязательно

draw_path(gc, tpath, affine, rgbFace=None)[source]: Отрисовывает Path с заданным аффинным преобразованием.

draw_path_collection(gc, master_transform, paths, *args, **kwargs)[source]

Отрисовывает коллекцию paths.

Каждый путь сначала преобразуется соответствующим элементом в all_transforms (список матриц 3x3), а затем master_transform. Затем они сдвигаются соответствующим элементом в offsets, который сначала преобразуется с помощью offset_trans.

facecolors, edgecolors, linewidths, linestyles и antialiased являются списками, которые устанавливают соответствующие свойства.

offset_position больше не используется, но аргумент сохранен для обратной совместимости.

Базовая (fallback) реализация выполняет несколько вызовов draw_path. Бэкэнды могут переопределить этот метод для отрисовки каждого набора данных пути только один раз и затем многократно использовать этот путь с различными смещениями, цветами, стилями и т.д. Генераторные методы _iter_collection_raw_paths и _iter_collection предназначены для помощи (и стандартизации) реализации в разных бэкендах. Настоятельно рекомендуется использовать эти генераторы, чтобы изменения в поведении draw_path_collection могли быть внесены глобально.

open_group(s, gid=None)[source]

Открывает элемент группировки с меткой s и gid (если задано) в качестве идентификатора.

Используется только рендерером SVG.

classmatplotlib.patheffects.PathPatchEffect(offset=(0, 0), **kwargs)[source]

Bases: AbstractPathEffect

Рисует экземпляр PathPatch, путь которого взят из оригинального элемента PathEffect.

Параметры:

offset(float, float), по умолчанию: (0, 0): Смещение (x, y) пути, в пунктах.
**kwargs: Все ключевые аргументы передаются в конструктор PathPatch. Свойства, которые нельзя переопределить, это "path", "clip_box", "transform" и "clip_path".

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Производный класс должен переопределить этот метод. Аргументы такие же, как у matplotlib.backend_bases.RendererBase.draw_path(), за исключением первого аргумента, который является рендерером.

classmatplotlib.patheffects.SimpleLineShadow(offset=(2, -2), shadow_color='k', alpha=0.3, rho=0.3, **kwargs)[source]

Bases: AbstractPathEffect

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

Параметры:

offset(float, float), по умолчанию: (2, -2): Смещение (x, y) пути, в пунктах.
shadow_colorцвет, по умолчанию: 'чёрный': Цвет тени. Значение None принимает оригинальный цвет элемента с коэффициентом масштабирования rho.
alphafloat, по умолчанию: 0.3: Альфа-прозрачность создаваемого оттеночного участка.
rhofloat, по умолчанию: 0.3: Коэффициент масштабирования для применения к цвету rgbFace, если shadow_color равен None.
**kwargs: Дополнительные ключевые слова сохраняются и передаются в AbstractPathEffect._update_gc().

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Переопределяет стандартный draw_path для добавления смещения тени и необходимых изменений цвета для тени.

classmatplotlib.patheffects.SimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]

Bases: AbstractPathEffect

Простая тень с помощью заполненного участка.

Параметры:

offset(float, float), по умолчанию: (2, -2): Смещение тени (x, y) в пунктах.
shadow_rgbFaceцвет: Цвет тени.
alphafloat, по умолчанию: 0.3: Альфа-прозрачность создаваемого оттеночного участка.
rhofloat, по умолчанию: 0.3: Коэффициент масштабирования для применения к цвету rgbFace, если shadow_rgbFace не указан.
**kwargs: Дополнительные ключевые слова сохраняются и передаются в AbstractPathEffect._update_gc().

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Переопределяет стандартный draw_path для добавления смещения тени и необходимых изменений цвета для тени.

classmatplotlib.patheffects.Stroke(offset=(0, 0), **kwargs)[source]

Bases: AbstractPathEffect

PathEffect на основе линии, который перерисовывает обводку.

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

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Рисует путь с обновленным gc.

classmatplotlib.patheffects.TickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[source]

Bases: AbstractPathEffect

Эффект отображения линии с штрихами.

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

Можно управлять интервалом, длиной и углом штрихов.

Этот стиль линии иногда называют штриховой линией.

См. также пример примера эффекта tickedstroke.

Параметры:

offset(float, float), по умолчанию: (0, 0): Смещение (x, y) пути в пунктах.
spacingfloat, по умолчанию: 10.0: Интервал между штрихами в пунктах.
anglefloat, по умолчанию: 45.0: Угол между путем и штрихом в градусах. Угол измеряется, как если бы вы были муравьем, идущим по кривой, при нулевых градусах, идущих прямо вперед, 90 градусов слева, -90 справа и 180 позади вас. Чтобы изменить сторону штрихов, измените знак угла.
lengthfloat, по умолчанию: 1.414: Длина штриха относительно интервала. Рекомендуемая длина = 1,414 (sqrt(2)) при угле 45, длина = 1,0 при угле 90 и длина = 2,0 при угле 60.
**kwargs: Дополнительные ключевые слова хранятся и передаются в AbstractPathEffect._update_gc().

Примеры

См. пример эффекта tickedstroke.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Отображение пути с обновленным gc.

classmatplotlib.patheffects.withSimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]

Bases: SimplePatchShadow

Упрощенный эффект пути для применения SimplePatchShadow, а затем рисования исходного объекта.

С этим классом можно использовать

artist.set_path_effects([patheffects.withSimplePatchShadow()])

в качестве сокращения для

artist.set_path_effects([patheffects.SimplePatchShadow(),
                         patheffects.Normal()])

Параметры:

offset(float, float), по умолчанию: (2, -2): Смещение тени (x, y) в пунктах.
shadow_rgbFaceцвет: Цвет тени.
alphafloat, по умолчанию: 0.3: Прозрачность созданной тени.
rhofloat, по умолчанию: 0.3: Коэффициент масштабирования, применяемый к цвету rgbFace, если shadow_rgbFace не указан.
**kwargs: Дополнительные ключевые слова хранятся и передаются в AbstractPathEffect._update_gc().

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Переопределяет стандартное draw_path, чтобы добавить смещение тени и необходимые изменения цвета для тени.

classmatplotlib.patheffects.withStroke(offset=(0, 0), **kwargs)[source]

Bases: Stroke

Упрощенный эффект пути для применения Stroke, а затем рисования исходного объекта.

С этим классом можно использовать

artist.set_path_effects([patheffects.withStroke()])

в качестве сокращения для

artist.set_path_effects([patheffects.Stroke(),
                         patheffects.Normal()])

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

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Отображение пути с обновленным gc.

classmatplotlib.patheffects.withTickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[source]

Bases: TickedStroke

Является сокращением PathEffect для применения TickedStroke, а затем отрисовки исходного объекта Artist.

С помощью этого класса можно использовать

artist.set_path_effects([patheffects.withTickedStroke()])

в качестве сокращения для

artist.set_path_effects([patheffects.TickedStroke(),
                         patheffects.Normal()])

Параметры:

offset(float, float), по умолчанию: (0, 0): Смещение (x, y) для применения к пути в пунктах.
spacingfloat, по умолчанию: 10.0: Отступ между метками в пунктах.
anglefloat, по умолчанию: 45.0: Угол между путем и меткой в градусах. Угол измеряется так, как будто вы муравей, идущий по кривой, причём ноль градусов указывает прямо перед вами, 90 градусов — слева, -90 справа, а 180 — позади вас. Чтобы изменить сторону меток, измените знак угла.
lengthfloat, по умолчанию: 1.414: Длина метки относительно spacing. Рекомендуемая длина = 1,414 (sqrt(2)), когда angle=45, length=1,0, когда angle=90, и length=2,0, когда angle=60.
**kwargs: Дополнительные ключевые слова сохраняются и передаются в AbstractPathEffect._update_gc().

Примеры

См. Демонстрацию эффекта tickedstroke.

draw_path(renderer, gc, tpath, affine, rgbFace)[source]: Отрисовка пути с обновлённым gc.