matplotlib.patheffects

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

См. также

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

classmatplotlib.patheffects.AbstractPathEffect(offset=(0.0, 0.0))[источник]

Базовые классы: object

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

В подклассах следует переопределить метод draw_path, чтобы добавить функциональность эффекта.

Параметры:

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

draw_path(renderer, gc, tpath, affine, rgbFace=None)[источник]: Производные классы должны переопределить этот метод. Аргументы совпадают с аргументами matplotlib.backend_bases.RendererBase.draw_path(), за исключением того, что первым аргументом является рендерер.

classmatplotlib.patheffects.Normal(offset=(0.0, 0.0))[источник]

Базовые классы: AbstractPathEffect

«Тождественный» эффект пути.

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

Параметры:

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

classmatplotlib.patheffects.PathEffectRenderer(path_effects, renderer)[источник]

Базовые классы: RendererBase

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

Затем этот прокси перехватывает вызовы отрисовки и вызывает соответствующий метод отрисовки AbstractPathEffect.

Примечание

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

Параметры:

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

close_group(s)[источник]

Закрывает группирующий элемент с меткой s.

Используется только рендерером SVG.

copy_with_path_effect(path_effects)[источник]

draw_markers(gc, marker_path, marker_trans, path, *args, **kwargs)[источник]

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

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

Параметры:

gcGraphicsContextBase: Графический контекст.
marker_pathPath: Путь маркера.
marker_transTransform: Аффинное преобразование, применяемое к маркеру.
pathPath: Положения для отрисовки маркеров.
transTransform: Аффинное преобразование, применяемое к пути.
rgbFaceцвет, необязательно

draw_path(gc, tpath, affine, rgbFace=None)[источник]: Отрисовывает экземпляр Path с использованием заданного аффинного преобразования.

draw_path_collection(gc, master_transform, paths, *args, **kwargs)[источник]

Отрисовывает коллекцию paths.

Сначала каждый путь преобразуется соответствующим элементом all_transforms (списком матриц размера (3, 3)), а затем — master_transform. После этого они сдвигаются на соответствующий элемент offsets, предварительно преобразованный с помощью offset_trans.

facecolors, edgecolors, linewidths, linestyles и antialiased — это списки, задающие соответствующие свойства.

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

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

open_group(s, gid=None)[источник]

Открывает группирующий элемент с меткой s и gid (если задан) в качестве идентификатора.

Используется только рендерером SVG.

classmatplotlib.patheffects.PathPatchEffect(offset=(0, 0), **kwargs)[источник]

Базовые классы: 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)[источник]: Производные классы должны переопределить этот метод. Аргументы совпадают с аргументами matplotlib.backend_bases.RendererBase.draw_path(), за исключением того, что первым аргументом является рендерер.

classmatplotlib.patheffects.SimpleLineShadow(offset=(2, -2), shadow_color='k', alpha=0.3, rho=0.3, **kwargs)[источник]

Базовые классы: AbstractPathEffect

Простая тень в виде линии.

Параметры:

offset(float, float), по умолчанию: (2, -2): Смещение (x, y), применяемое к пути, в пунктах.
shadow_colorцвет, по умолчанию: 'black': Цвет тени. Значение None задаёт исходный цвет объекта с коэффициентом масштабирования rho.
alphafloat, по умолчанию: 0.3: Альфа-прозрачность создаваемого патча тени.
rhofloat, по умолчанию: 0.3: Коэффициент масштабирования цвета rgbFace, если shadow_color равен None.
**kwargs: Дополнительные именованные аргументы сохраняются и передаются в AbstractPathEffect._update_gc().

draw_path(renderer, gc, tpath, affine, rgbFace)[источник]: Переопределяет стандартный draw_path, добавляя смещение тени и необходимые изменения цвета для тени.

classmatplotlib.patheffects.SimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[источник]

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

classmatplotlib.patheffects.Stroke(offset=(0, 0), **kwargs)[источник]

Базовые классы: AbstractPathEffect

Эффект пути на основе линии, повторно отрисовывающий обводку.

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

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

classmatplotlib.patheffects.TickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[источник]

Базовые классы: AbstractPathEffect

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

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

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

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

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

Параметры:

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

Примеры

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

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

classmatplotlib.patheffects.withSimplePatchShadow(offset=(2, -2), shadow_rgbFace=None, alpha=None, rho=0.3, **kwargs)[исходный код]

Базовые классы: SimplePatchShadow

Сокращённая версия PathEffect для применения SimplePatchShadow с последующей отрисовкой исходного Artist.

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

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: Прозрачность alpha созданной тени.
rhofloat, по умолчанию: 0.3: Коэффициент масштабирования цвета rgbFace, если shadow_rgbFace не задан.
**kwargs: Дополнительные именованные аргументы сохраняются и передаются в AbstractPathEffect._update_gc().

draw_path(renderer, gc, tpath, affine, rgbFace)[исходный код]: Переопределяет стандартный draw_path, добавляя смещение тени и необходимые изменения её цвета.

classmatplotlib.patheffects.withStroke(offset=(0, 0), **kwargs)[исходный код]

Базовые классы: Stroke

Сокращённая версия PathEffect для применения Stroke с последующей отрисовкой исходного Artist.

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

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

как сокращённую запись для

artist.set_path_effects([patheffects.Stroke(),
                         patheffects.Normal()])

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

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

classmatplotlib.patheffects.withTickedStroke(offset=(0, 0), spacing=10.0, angle=45.0, length=np.float64(1.4142135623730951), **kwargs)[исходный код]

Базовые классы: TickedStroke

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

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

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

Примеры

См. Эффект контура с засечками TickedStroke.

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