matplotlib.patheffects

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

См. также

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

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

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

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

Параметры:

смещение(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 — нарисовать исходный объект без специального эффекта траектории.

Параметры:

смещение(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: Эффекты пути, которые представляет этот рендерер.
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_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]

Отрисовывает коллекцию путей.

Каждый путь сначала преобразуется соответствующей записью в 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(), за исключением первого аргумента — это рендерер.

классmatplotlib.patheffects.SimpleLineShadow(offset=(2, -2), shadow_color='k', alpha=0.3, rho=0.3, **kwargs)[source]

Основы: 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 для добавления смещения тени и необходимых изменений цвета для тени.

классmatplotlib.patheffects.SimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[source]

Основы: 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 для добавления смещения тени и необходимых изменений цвета для тени.

классmatplotlib.patheffects.Stroke(offset=(0, 0), **kwargs)[source]

Основы: 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=1.4142135623730951, **kwargs)[source]

Bases: AbstractPathEffect

Эффект трассировки линии с тиками.

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

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

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

См. также пример примера эффекта трассировки с тиками.

Параметры:

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

Примеры

См. пример эффекта трассировки с тиками.

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([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]: Переопределяет стандартную отрисовку пути, чтобы добавить смещение тени и необходимые изменения цвета для тени.

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

Bases: Stroke

Сокращенная функция PathEffect для применения 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=1.4142135623730951, **kwargs)[source]

Bases: TickedStroke

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

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

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().

Примеры

См. Демонстрация PathEffect TickedStroke.

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