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: matplotlib.patheffects.AbstractPathEffect

"Идентичный" эффект траектории.

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

Параметры

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

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

Bases: matplotlib.backend_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_markers, которая вызывает метод 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]

Рисует набор путей, выбирая свойства рисования из списков facecolors, edgecolors, linewidths, linestyles и antialiaseds. offsets — список смещений, применяемых к каждому из путей. Смещения в offsets сначала преобразуются с помощью offsetTrans, прежде чем быть применёнными.

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

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

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

Bases: matplotlib.patheffects.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: matplotlib.patheffects.AbstractPathEffect

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

Параметры

смещение(float, float), по умолчанию: (2, -2): Смещение (x, y) пути, в пунктах.
shadow_colorцвет, по умолчанию: 'чёрный': Цвет тени. Значение None принимает исходный цвет объекта-артиста с коэффициентом масштабирования rho.
альфаfloat, по умолчанию: 0.3: Альфа-прозрачность созданной области тени.
роfloat, по умолчанию: 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: matplotlib.patheffects.AbstractPathEffect

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

Параметры

смещение(float, float), по умолчанию: (2, -2): Смещение тени (x, y) в пунктах.
shadow_rgbFaceцвет: Цвет тени.
альфаfloat, по умолчанию: 0.3: Альфа-прозрачность созданной области тени. http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html
роfloat, по умолчанию: 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: matplotlib.patheffects.AbstractPathEffect

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

Путь будет нанесён штрихом с обновлением его 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: matplotlib.patheffects.AbstractPathEffect

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

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

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

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

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

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

Параметры

offset(float, float), по умолчанию: (0, 0): Смещение (x, y) пути в пунктах.
spacingfloat, по умолчанию: 10.0: Шаг между отметками в пунктах.
anglefloat, по умолчанию: 45.0: Угол между путем и отметкой в градусах. Угол измеряется так, как если бы вы были муравьем, идущим по кривой. Ноль градусов указывает прямо вперёд, 90 градусов – влево, -90 градусов – вправо, и 180 градусов – назад.
lengthfloat, по умолчанию: 1.414: Длина отметки относительно шага. Рекомендуемая длина = 1,414 (корень из 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: matplotlib.patheffects.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: Прозрачность альфа-канала созданной тени. http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html
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: matplotlib.patheffects.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.

END_OF_DOCUMENT_MARKER

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

Bases: matplotlib.patheffects.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 (корень квадратный из 2) при angle=45, длина = 1,0 при angle=90 и длина = 2,0 при angle=60.
**kwargs: Дополнительные ключевые слова сохраняются и передаются в AbstractPathEffect._update_gc().

Примеры

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

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