matplotlib.patheffects

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

См. также

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

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

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

Подклассы должны переопределить метод 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

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

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

Примечание

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

Параметры:

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

copy_with_path_effect(path_effects)[source]

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

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

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

Параметры:

gcGraphicsContextBase: Контекст графики.
marker_transTransform: Аффинное преобразование, применяемое к маркеру.
transTransform: Аффинное преобразование, применяемое к пути.

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 можно было внести глобально.

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.

END_OF_DOCUMENT_MARKER

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

Bases: AbstractPathEffect

Эффект пути, основанный на линиях, который рисует путь с пунктирной линией.

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

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

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

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

Параметры:

offset(float, float), по умолчанию: (0, 0): Смещение (x, y) для применения к пути в пунктах.
spacingfloat, по умолчанию: 10.0: Расстояние между метками в пунктах.
anglefloat, по умолчанию: 45.0: Угол между путем и отметкой в градусах. Угол измеряется так, как если бы вы были муравьем, идущим по кривой, при этом 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

Сокращенная функция PathEffect для применения SimplePatchShadow и последующего рисования исходного объекта.

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

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

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

artist.set_path_effects([path_effects.SimplePatchShadow(),
                         path_effects.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

Сокращенная функция PathEffect для применения Stroke и последующего рисования исходного объекта.

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

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

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

artist.set_path_effects([path_effects.Stroke(),
                         path_effects.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=1.4142135623730951, **kwargs)[source]

Bases: TickedStroke

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

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

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

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

artist.set_path_effects([path_effects.TickedStroke(),
                         path_effects.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, длина = 1.0 при angle=90 и длина = 2.0 при angle=60.
**kwargs: Дополнительные ключевые слова хранятся и передаются в AbstractPathEffect._update_gc().

Примеры

См. Пример использования TickedStroke patheffect.

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