matplotlib.patheffects

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

См. также

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

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

Bases: object

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

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

copy_with_path_effect(path_effects)[source]

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

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

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

Параметры:

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

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 сейчас не используется, но аргумент сохранен для обратной совместимости.

Базовая (по умолчанию) реализация выполняет несколько вызовов 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

Эффект отображения пути с пунктирной линией.

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

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

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

См. также пример примера контуров.

См. также пример контуров в оптимизации.

Параметры:

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

Примеры

См. Пример эффекта 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([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

Сокращённый эффект пути для применения 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.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: Длина отметки по отношению к расстоянию. Рекомендуемая длина = 1.414 (sqrt(2)), когда угол = 45, длина = 1.0, когда угол = 90, и длина = 2.0, когда угол = 60.
**kwargs: Дополнительные ключевые слова сохраняются и передаются в AbstractPathEffect._update_gc().

Примеры

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

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