vert_line

Vertical line visualizers component.

This module provides a component for visualizing vertical lines at specified x-coordinates with configurable styling.

class pysatl_cpd.analysis.visualization.components.vert_line.VerticalLineVisualComponent(backend)[source]

Bases: IVisualComponent

Component for visualizing vertical lines at specified coordinates.

This component draws vertical lines at given x-coordinates. It supports both Matplotlib and Plotly backends with configurable line styles, colors, and transparency.

Parameters:: backend (DrawBackend) – The plotting backend to use for rendering.

__init__(backend)[source]

Parameters:: backend (DrawBackend)
Return type:: None

set_lines(indices)[source]

Set vertical line positions.

Parameters:: indices (Sequence[float]) – X-axis coordinates where vertical lines should be drawn.
Returns:: Returns self to allow method chaining.
Return type:: Self

set_style(**style)[source]

Set style for vertical lines.

Parameters:

**style (Unpack[LineSpec]) –

colorstr: Line color. Accepts any matplotlib color name, hex code, or RGB tuple.
linestylestr: For Matplotlib: line style (’–’, ‘-.’, ‘-’, ‘:’). For Plotly: line style (‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’).
linewidthfloat: Line width in points.
alphafloat: Line opacity between 0 (transparent) and 1 (opaque).

Returns:

Returns self to allow method chaining.

Return type:

Self

clear()[source]

Clear all vertical lines.

Returns:: Returns self to allow method chaining.
Return type:: Self