matplotlib.patheffects

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

См. также

class matplotlib.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(), за исключением первого аргумента, который является обработчиком.

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

Bases: matplotlib.patheffects.AbstractPathEffect

"Идентичный" эффект пути.

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

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

класс matplotlib.patheffects.PathEffectRenderer(path_effects, renderer)[source]

Базы: 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(). Некоторые бэкэнды могут захотеть переопределить этот метод, чтобы нарисовать маркер только один раз и использовать его многократно.

Параметры:	gc`GraphicsContextBase` Контекст графики. marker_trans`matplotlib.transforms.Transform` Аффинное преобразование, применяемое к маркеру. trans`matplotlib.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 может быть либо "screen", либо "data", в зависимости от пространства, в котором находятся смещения; "data" устарел.

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

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

Базы: 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(), за исключением первого аргумента, который является рендерером.

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

Базы: matplotlib.patheffects.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()`.

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]

Базы: matplotlib.patheffects.AbstractPathEffect

Простая тень в виде заполненной области.

Параметры:

Параметры:	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()`.

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

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

Базы: matplotlib.patheffects.AbstractPathEffect

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

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

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

класс matplotlib.patheffects.TickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=1.4142135623730951, **kwargs)[source]

Базы: matplotlib.patheffects.AbstractPathEffect

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

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

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

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

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

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

Параметры:

Параметры:	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()`.

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 patheffect.

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

END_OF_DOCUMENT_MARKER ```

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

Базы: matplotlib.patheffects.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 Прозрачность альфа-канала создаваемой тени. http://matplotlib.1069221.n5.nabble.com/path-effects-question-td27630.html rhofloat, по умолчанию: 0.3 Коэффициент масштабирования, применяемый к цвету rgbFace, если shadow_rgbFace не указан. **kwargs Дополнительные ключевые слова сохраняются и передаются в `AbstractPathEffect._update_gc()`.

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

класс matplotlib.patheffects.withStroke(offset=(0, 0), **kwargs)

Базы: matplotlib.patheffects.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): Отрисовать путь с обновлённым gc.

класс matplotlib.patheffects.withTickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=1.4142135623730951, **kwargs)

Базы: 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 (sqrt(2)) при angle=45, length=1.0 при angle=90 и length=2.0 при angle=60. **kwargs Дополнительные ключевые слова сохраняются и передаются в `AbstractPathEffect._update_gc()`.

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): Отрисовать путь с обновлённым gc.