Source code for lightningchart.series.polar_line_series

from __future__ import annotations
from typing import Optional

from lightningchart.charts import Chart
from lightningchart import Themes
from lightningchart.series import GetPolarData, SeriesWith2DLines, Series, SeriesWithAddEventListener, SeriesWithCursor, SolveNearestMixin
from lightningchart.utils import convert_to_dict, convert_color_to_hex
from lightningchart.utils.utils import ColorInput, LegendOptions, build_series_legend_options




class PolarLineSeries(SeriesWith2DLines, SeriesWithAddEventListener, GetPolarData, SolveNearestMixin, SeriesWithCursor):
    """Series type for visualizing polar line data."""

    def __init__(
        self,
        chart: Chart,
        theme: Themes = Themes.Light,
        name: str = None,
        automatic_color_index: int = None,
        legend: Optional[LegendOptions] = None,
    ):
        Series.__init__(self, chart)

        legend_options = build_series_legend_options(legend)

        payload = {
            'chart': self.chart.id,
            'theme': theme.value,
            'name': name,
            'legend': legend_options if legend_options else None,
        }
        if automatic_color_index is not None:
            payload['automaticColorIndex'] = automatic_color_index
        self.instance.send(
            self.id,
            'addLineSeries',
            payload,
        )



    def set_data(self, data: list[dict]):
        """Set the data for the series.

        Args:
            data (list[dict]): A list of dictionaries, each containing:
                - 'angle' (float): The angle in degrees.
                - 'amplitude' (float): The amplitude at that angle.

        Example:
            >>> series.set_data([
            ...     {'angle': 0, 'amplitude': 5},
            ...     {'angle': 90, 'amplitude': 10},
            ...     {'angle': 180, 'amplitude': 7.5},
            ...     {'angle': 270, 'amplitude': 3},
            ... ])

        Returns:
            The instance of the class for fluent interface.
        """
        data = convert_to_dict(data)

        self.instance.send(self.id, 'setData', {'data': data})
        return self




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

        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