Source code for lightningchart.series.rectangle_series

from __future__ import annotations

from typing import Optional
import uuid
from lightningchart.series import (
    FigureSeries,
    RectangleSeriesStyle,
    SeriesWithAddEventListener,
    SeriesWithClear,
    SeriesWithCursor,
    SeriesWithDrawOrder,
    SeriesWithXYAxes,
)
from lightningchart.ui.axis import Axis
from lightningchart.utils import convert_color_to_hex
from lightningchart.utils.utils import ColorInput, LegendOptions, build_series_legend_options




class RectangleSeries(SeriesWithClear, SeriesWithDrawOrder, FigureSeries, SeriesWithAddEventListener, SeriesWithXYAxes, SeriesWithCursor):
    """Series for visualizing rectangles in a 2D space."""

    def __init__(
        self,
        chart,
        automatic_color_index: int = None,
        axis_x: Axis = None,
        axis_y: Axis = None,
        solve_plane: str = None,
        legend: Optional[LegendOptions] = None,
    ):
        super().__init__(chart, axis_x, axis_y)

        legend_options = build_series_legend_options(legend)

        self.instance.send(
            self.id,
            'addRectangleSeries',
            {
                'chart': self.chart.id,
                'automaticColorIndex': automatic_color_index,
                'solvePlane': solve_plane,
                'axisX': axis_x,
                'axisY': axis_y,
                'legend': legend_options if legend_options else None,
            },
        )



    def add(self, x1: int | float, y1: int | float, x2: int | float, y2: int | float):
        """Add new figure to the series.

        Args:
            x1: X coordinate of rectangles bottom-left corner.
            y1: Y coordinate of rectangles bottom-left corner.
            x2: X coordinate of rectangles top-right corner.
            y2: Y coordinate of rectangles top-right corner.

        Returns:
            The instance of the class for fluent interface.
        """
        rectangle_figure = RectangleFigure(self, {'x1': x1, 'y1': y1, 'x2': x2, 'y2': y2})
        return rectangle_figure




    def set_auto_scrolling_enabled(self, enabled: bool):
        """Set whether series is taken into account with automatic scrolling and fitting of attached axes.

        Args:
            enabled: Boolean flag.

        Returns:
            The instance of the class for fluent interface.
        """
        self.instance.send(self.id, 'setAutoScrollingEnabled', {'enabled': enabled})
        return self






class RectangleFigure(RectangleSeriesStyle):
    """Class representing a visual rectangle figure in the RectangleSeries."""

    def __init__(self, series: 'RectangleSeries', dimensions: dict):
        self.series = series
        self.dimensions = dimensions
        self.instance = series.instance
        self.id = str(uuid.uuid4())
        self.instance.send(
            self.id,
            'addRectangleFigure',
            {'series': self.series.id, 'dimensions': dimensions},
        )



    def set_stroke(self, thickness: int | float, color: ColorInput | None = None):
        """Set Stroke style of the rectangle.

        Args:
            thickness (int | float): Thickness of the stroke.
            color (Color): Color of the stroke. Use 'transparent' or None to hide.

        Returns:
            The instance of the class for fluent interface.
        """
        color = convert_color_to_hex(color) if color is not None else None

        self.instance.send(
            self.id,
            'setStrokeStyle',
            {'thickness': thickness, 'color': color},
        )
        return self




    def set_visible(self, visible: bool):
        """Set element visibility.

        Args:
            visible: Boolean flag.

        Returns:
            The instance of the class for fluent interface.
        """
        self.instance.send(self.id, 'setVisible', {'visible': visible})
        return self




    def set_dimensions(self, x1: int | float, y1: int | float, x2: int | float, y2: int | float):
        """Set new dimensions for the rectangle figure.

        Args:
            x1: X coordinate of rectangles bottom-left corner.
            y1: Y coordinate of rectangles bottom-left corner.
            x2: X coordinate of rectangles top-right corner.
            y2: Y coordinate of rectangles top-right corner.

        Returns:
            The instance of the class for fluent interface.
        """
        self.instance.send(self.id, 'setDimensions', {'x1': x1, 'y1': y1, 'x2': x2, 'y2': y2})
        return self




    def set_color(self, color: ColorInput | None):
        """Set a color of the rectangle figure.

        Args:
            color (Color): Color of the rectangle. Use 'transparent' or None to hide.

        Returns:
            The instance of the class for fluent interface.
        """
        color = convert_color_to_hex(color) if color is not None else None

        self.instance.send(self.id, 'setSolidFillStyle', {'color': color})
        return self