typedefs

Visualization type definitions.

This module defines common types, enumerations, and aliases used throughout the visualizers module for consistent type hints and backend abstraction.

type pysatl_cpd.analysis.visualization.typedefs.PltFigure = Figure

Type alias for Matplotlib figure objects.

type pysatl_cpd.analysis.visualization.typedefs.GoFigure = Figure

Type alias for Plotly graph objects figure.

type pysatl_cpd.analysis.visualization.typedefs.PltAxes = Axes

Type alias for Matplotlib axes object.

type pysatl_cpd.analysis.visualization.typedefs.GoAxes = tuple[int, int]

Type alias for Plotly subplot position.

Each value is a tuple (row, column) specifying the location of the subplot within the figure’s grid layout.

type pysatl_cpd.analysis.visualization.typedefs.PltAxMapping = dict[str, PltAxes]

Mapping from subplot names to Matplotlib axes objects.

type pysatl_cpd.analysis.visualization.typedefs.GoAxMapping = dict[str, GoAxes]

Mapping from subplot names to Plotly subplot positions.

type pysatl_cpd.analysis.visualization.typedefs.AxMapping = PltAxMapping | GoAxMapping

Union type for axes mappings from either Matplotlib or Plotly backends.

type pysatl_cpd.analysis.visualization.typedefs.Axes = PltAxes | GoAxes

Union type for axes from either Matplotlib or Plotly backends.

type pysatl_cpd.analysis.visualization.typedefs.Figure = GoFigure | PltFigure

Union type for figures from either Matplotlib or Plotly backends.

class pysatl_cpd.analysis.visualization.typedefs.DrawBackend(*values)

Bases: StrEnum

Supported plotting backends.

This enumeration defines the available backends for rendering visualizations. Each backend provides distinct capabilities: Matplotlib for static publication- ready figures, and Plotly for interactive web-based visualizations.

Variables:

• MATPLOTLIB (auto) – Matplotlib backend for static figure generation. Suitable for papers, reports, and offline rendering.

• PLOTLY (auto) – Plotly backend for interactive figure generation. Supports zooming, panning, and hover tooltips in web environments.

MATPLOTLIB = 'matplotlib'

PLOTLY = 'plotly'

type pysatl_cpd.analysis.visualization.typedefs.DrawOption = Any

Type alias for backend-specific drawing options.

This dictionary can contain arbitrary keyword arguments to be passed to backend drawing functions, such as color schemes, line styles, or rendering parameters.