layrz-sdk 3.0.14__py3-none-any.whl → 3.1.0__py3-none-any.whl

layrz_sdk/entities/charts/map_point.py

@@ -0,0 +1,22 @@
+from pydantic import BaseModel, Field, field_validator
+
+
+class MapPoint(BaseModel):
+  """Map point configuration"""
+
+  latitude: float = Field(description='Latitude of the point')
+  longitude: float = Field(description='Longitude of the point')
+  label: str = Field(description='Label of the point')
+  color: str = Field(description='Color of the point')
+
+  @field_validator('latitude', mode='before')
+  def _validate_latitude(cls, value: float) -> float:
+    if value < -90 or value > 90:
+      raise ValueError('Latitude must be between -90 and 90 degrees')
+    return value
+
+  @field_validator('longitude', mode='before')
+  def _validate_longitude(cls, value: float) -> float:
+    if value < -180 or value > 180:
+      raise ValueError('Longitude must be between -180 and 180 degrees')
+    return value

layrz_sdk/entities/charts/number_chart.py

@@ -0,0 +1,50 @@
+"""Number chart"""
+
+import sys
+from typing import Any, Dict
+
+from pydantic import BaseModel, Field
+
+from .chart_render_technology import ChartRenderTechnology
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class NumberChart(BaseModel):
+  """Number chart configuration"""
+
+  value: float = Field(description='Value of the number')
+  color: str = Field(description='Color of the number')
+  label: str = Field(description='Label of the number')
+
+  def render(self: Self, technology: ChartRenderTechnology = ChartRenderTechnology.FLUTTER) -> Dict[str, Any]:
+    """
+    Render chart to a graphic Library.
+    :param technology: The technology to use to render the chart.
+    :return: The configuration of the chart.
+    """
+    if technology == ChartRenderTechnology.FLUTTER:
+      return {
+        'library': 'FLUTTER',
+        'chart': 'NUMBER',
+        'configuration': self._render_flutter(),
+      }
+
+    return {
+      'library': 'FLUTTER',
+      'chart': 'TEXT',
+      'configuration': [f'Unsupported {technology}'],
+    }
+
+  def _render_flutter(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to a Flutter native components.
+    """
+    return {
+      'value': self.value,
+      'color': self.color,
+      'label': self.label,
+    }

layrz_sdk/entities/charts/{pie.py → pie_chart.py}

@@ -1,148 +1,127 @@
-"""Pie chart"""
-
-from typing import Any, List
-
-from .alignment import ChartAlignment
-from .exceptions import ChartException
-from .render_technology import ChartRenderTechnology
-from .serie import ChartDataSerie
-
-
-class PieChart:
-  """
-  Pie chart configuration
-  """
-
-  def __init__(
-    self,
-    series: List[ChartDataSerie],
-    title: str = 'Chart',
-    align: ChartAlignment = ChartAlignment.CENTER,
-  ) -> None:
-    """
-    Constructor
-    ----
-    Arguments
-      series : Defines the series of the chart, uses the ChartDataSerie class.
-               Please read the documentation to more information.
-      title : Title of the chart.
-      align : Alignment of the chart.
-    """
-    for i, serie in enumerate(series):
-      if not isinstance(serie, ChartDataSerie):
-        raise ChartException(f'Y Axis serie {i} must be an instance of ChartDataSerie')
-    self.series = series
-
-    if not isinstance(title, str):
-      raise ChartException('title must be an instance of str')
-    self.title = title
-
-    if not isinstance(align, ChartAlignment):
-      raise ChartException('align must be an instance of ChartAlignment')
-    self.align = align
-
-  def render(
-    self,
-    technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
-  ) -> Any:
-    """
-    Render chart to a graphic Library.
-    We have two graphic libraries: GRAPHIC and CANVASJS.
-
-    GRAPHIC is a Flutter chart library. To return this option, use the parameter use_new_definition=True.
-    CANVASJS is a Javascript chart library. This is the default option.
-    """
-    if technology == ChartRenderTechnology.GRAPHIC:
-      return {
-        'library': 'GRAPHIC',
-        'chart': 'PIE',
-        'configuration': self._render_graphic(),
-      }
-
-    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
-      return {
-        'library': 'SYNCFUSION_FLUTTER_CHARTS',
-        'chart': 'PIE',
-        'configuration': self._render_syncfusion_flutter_charts(),
-      }
-
-    if technology == ChartRenderTechnology.APEX_CHARTS:
-      return {
-        'library': 'APEXCHARTS',
-        'chart': 'PIE',
-        'configuration': self._render_apexcharts(),
-      }
-
-    return {
-      'library': 'FLUTTER',
-      'chart': 'TEXT',
-      'configuration': [f'Unsupported {technology}'],
-    }
-
-  def _render_syncfusion_flutter_charts(self) -> Any:
-    """
-    Converts the configuration of the chart to Syncfusion Flutter Charts.
-    """
-    series = []
-
-    for serie in self.series:
-      series.append(
-        {
-          'label': serie.label,
-          'color': serie.color,
-          'value': serie.data[0],
-        }
-      )
-
-    return {'series': series}
-
-  def _render_graphic(self) -> Any:
-    """
-    Converts the configuration of the chart to a Flutter library Graphic.
-    """
-    series = []
-
-    for serie in self.series:
-      series.append(
-        {
-          'group': serie.label,
-          'color': serie.color,
-          'value': serie.data[0],
-        }
-      )
-
-    return series
-
-  def _render_apexcharts(self) -> Any:
-    """
-    Converts the configuration of the chart to Javascript library ApexCharts.
-    """
-
-    series = []
-    colors = []
-    labels = []
-
-    for serie in self.series:
-      series.append(serie.data[0])
-      colors.append(serie.color)
-      labels.append(serie.label)
-
-    config = {
-      'series': series,
-      'colors': colors,
-      'labels': labels,
-      'title': {
-        'text': self.title,
-        'align': self.align.value,
-        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-      },
-      'chart': {
-        'type': 'pie',
-        'animations': {'enabled': False},
-        'toolbar': {'show': False},
-        'zoom': {'enabled': False},
-      },
-      'dataLabels': {'enabled': True},
-    }
-
-    return config
+"""Pie chart"""
+
+import sys
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field
+
+from .chart_alignment import ChartAlignment
+from .chart_data_serie import ChartDataSerie
+from .chart_render_technology import ChartRenderTechnology
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class PieChart(BaseModel):
+  """Pie chart configuration"""
+
+  series: List[ChartDataSerie] = Field(description='List of series to be displayed in the chart', default_factory=list)
+  title: str = Field(description='Title of the chart', default='Chart')
+  align: ChartAlignment = Field(description='Alignment of the chart', default=ChartAlignment.CENTER)
+
+  def render(
+    self: Self,
+    technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
+  ) -> Dict[str, Any]:
+    """
+    Render chart to a graphic Library.
+    :param technology: The technology to use to render the chart.
+    :return: The configuration of the chart.
+    """
+    if technology == ChartRenderTechnology.GRAPHIC:
+      return {
+        'library': 'GRAPHIC',
+        'chart': 'PIE',
+        'configuration': self._render_graphic(),
+      }
+
+    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
+      return {
+        'library': 'SYNCFUSION_FLUTTER_CHARTS',
+        'chart': 'PIE',
+        'configuration': self._render_syncfusion_flutter_charts(),
+      }
+
+    if technology == ChartRenderTechnology.APEX_CHARTS:
+      return {
+        'library': 'APEXCHARTS',
+        'chart': 'PIE',
+        'configuration': self._render_apexcharts(),
+      }
+
+    return {
+      'library': 'FLUTTER',
+      'chart': 'TEXT',
+      'configuration': [f'Unsupported {technology}'],
+    }
+
+  def _render_syncfusion_flutter_charts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Syncfusion Flutter Charts.
+    """
+    series = []
+
+    for serie in self.series:
+      series.append(
+        {
+          'label': serie.label,
+          'color': serie.color,
+          'value': serie.data[0],
+        }
+      )
+
+    return {'series': series}
+
+  def _render_graphic(self: Self) -> List[Dict[str, Any]]:
+    """
+    Converts the configuration of the chart to a Flutter library Graphic.
+    """
+    series = []
+
+    for serie in self.series:
+      series.append(
+        {
+          'group': serie.label,
+          'color': serie.color,
+          'value': serie.data[0],
+        }
+      )
+
+    return series
+
+  def _render_apexcharts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Javascript library ApexCharts.
+    """
+
+    series = []
+    colors = []
+    labels = []
+
+    for serie in self.series:
+      series.append(serie.data[0])
+      colors.append(serie.color)
+      labels.append(serie.label)
+
+    config = {
+      'series': series,
+      'colors': colors,
+      'labels': labels,
+      'title': {
+        'text': self.title,
+        'align': self.align.value,
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+      },
+      'chart': {
+        'type': 'pie',
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
+      'dataLabels': {'enabled': True},
+    }
+
+    return config

layrz_sdk/entities/charts/radar_chart.py

@@ -0,0 +1,77 @@
+"""Radar chart"""
+
+import sys
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field
+
+from .chart_alignment import ChartAlignment
+from .chart_data_serie import ChartDataSerie
+from .chart_data_serie_type import ChartDataSerieType
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class RadarChart(BaseModel):
+  """Radar chart configuration"""
+
+  x_axis: ChartDataSerie = Field(description='X Axis of the chart')
+  y_axis: List[ChartDataSerie] = Field(description='Y Axis of the chart', default_factory=list)
+  title: str = Field(description='Title of the chart', default='Chart')
+  align: ChartAlignment = Field(description='Alignment of the chart', default=ChartAlignment.CENTER)
+
+  def render(self: Self) -> Dict[str, Any]:
+    """
+    Render chart to a graphic Library.
+    :param technology: The technology to use to render the chart.
+    :return: The configuration of the chart.
+    """
+    return {'library': 'APEXCHARTS', 'configuration': self._render_apexcharts()}
+
+  def _render_apexcharts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Javascript library ApexCharts.
+    """
+
+    series = []
+    colors = []
+
+    for serie in self.y_axis:
+      modified_serie = {'name': serie.label, 'data': serie.data}
+
+      if serie.serie_type is not ChartDataSerieType.NONE:
+        modified_serie['type'] = serie.serie_type.value
+
+      series.append(modified_serie)
+      colors.append(serie.color)
+
+    config = {
+      'series': series,
+      'colors': colors,
+      'xaxis': {
+        'categories': self.x_axis.data,
+        'type': self.x_axis.data_type.value,
+        'title': {
+          'text': self.x_axis.label,
+          'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+        },
+      },
+      'title': {
+        'text': self.title,
+        'align': self.align.value,
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+      },
+      'chart': {
+        'type': 'radar',
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
+      'dataLabels': {'enabled': True},
+      'plotOptions': {'bar': {'horizontal': True, 'borderRadius': 4}},
+    }
+
+    return config