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

layrz_sdk/entities/charts/{scatter.py → scatter_chart.py}

@@ -1,290 +1,206 @@
-"""Scatter chart"""
-
-from typing import Any, List
-
-from .alignment import ChartAlignment
-from .configuration import AxisConfig
-from .exceptions import ChartException
-from .render_technology import ChartRenderTechnology
-from .serie_type import ChartDataSerieType
-
-
-class ScatterSerieItem:
-  """
-  Chart Data Serie Item for Scatter Charts
-  """
-
-  def __init__(self, x: float, y: float) -> None:
-    """
-    Constructor
-
-    Args
-    ----
-      x : X value of the item.
-      y : Y value of the item.
-    """
-    self.x = x
-    self.y = y
-
-
-class ScatterSerie:
-  """
-  Chart Data Serie for Timeline charts
-  """
-
-  def __init__(
-    self,
-    data: List[ScatterSerieItem],
-    color: str,
-    label: str,
-    serie_type: ChartDataSerieType = ChartDataSerieType.SCATTER,
-  ) -> None:
-    """
-    Constructor
-    ----
-    Arguments
-      data : List of data points.
-      color : Color of the serie.
-      label : Label of the serie.
-    """
-    for i, datum in enumerate(data):
-      if not isinstance(datum, ScatterSerieItem):
-        raise ChartException(f'Y Axis serie {i} must be an instance of ChartDataSerie')
-    self.data = data
-
-    if not isinstance(color, str):
-      raise ChartException('color must be an instance of str')
-    self.color = color
-
-    if not isinstance(label, str):
-      raise ChartException('label must be an instance of str')
-    self.label = label
-
-    if not isinstance(serie_type, ChartDataSerieType):
-      raise ChartException('serie_type must be an instance of ChartDataSerieType')
-    self.serie_type = serie_type
-
-
-class ScatterChart:
-  """
-  Scatter chart configuration
-  """
-
-  def __init__(
-    self,
-    series: List[ScatterSerie],
-    title: str = 'Chart',
-    align: ChartAlignment = ChartAlignment.CENTER,
-    x_axis_config: AxisConfig = None,
-    y_axis_config: AxisConfig = None,
-  ) -> None:
-    """
-    Constructor
-    ----
-    Arguments
-      series : Defines the series of the chart, uses the ScatterSerie 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, ScatterSerie):
-        raise ChartException(f'Y Axis serie {i} must be an instance of ScatterSerie')
-    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
-
-    if x_axis_config is None:
-      x_axis_config = AxisConfig(label='', measure_unit='')
-
-    if not isinstance(x_axis_config, AxisConfig):
-      raise ChartException('x_axis_config must be an instance of AxisConfig')
-    self.x_axis_config = x_axis_config
-
-    if y_axis_config is None:
-      y_axis_config = AxisConfig(label='', measure_unit='')
-
-    if not isinstance(y_axis_config, AxisConfig):
-      raise ChartException('y_axis_config must be an instance of AxisConfig')
-    self.y_axis_config = y_axis_config
-
-  def render(
-    self,
-    technology: ChartRenderTechnology = ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS,
-  ) -> Any:
-    """
-    Render chart to a graphic Library.
-    We have two graphic libraries: GRAPHIC and APEXCHARTS.
-
-    GRAPHIC is a Flutter chart library. To return this option, use the parameter use_new_definition=True.
-    APEXCHARTS is a Javascript chart library. This is the default option.
-    """
-    if technology == ChartRenderTechnology.GRAPHIC:
-      return {
-        'library': 'GRAPHIC',
-        'chart': 'SCATTER',
-        'configuration': self._render_graphic(),
-      }
-
-    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
-      return {
-        'library': 'SYNCFUSION_FLUTTER_CHARTS',
-        'chart': 'SCATTER',
-        'configuration': self._render_syncfusion_flutter_charts(),
-      }
-
-    if technology == ChartRenderTechnology.APEX_CHARTS:
-      return {
-        'library': 'APEXCHARTS',
-        'chart': 'SCATTER',
-        '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 Flutter library Graphic.
-    """
-    series = []
-    for serie in self.series:
-      data = []
-
-      type_serie = 'SCATTER'
-      if serie.serie_type == ChartDataSerieType.SCATTER:
-        type_serie = 'SCATTER'
-      elif serie.serie_type == ChartDataSerieType.LINE:
-        type_serie = 'LINE'
-      elif serie.serie_type == ChartDataSerieType.AREA:
-        type_serie = 'AREA'
-      else:
-        continue
-
-      for item in serie.data:
-        if not isinstance(item.x, (int, float)):
-          continue
-        if not isinstance(item.y, (int, float)):
-          continue
-
-        data.append(
-          {
-            'xAxis': item.x,
-            'yAxis': item.y,
-          }
-        )
-
-      series.append(
-        {
-          'label': serie.label,
-          'color': serie.color,
-          'values': data,
-          'type': type_serie,
-        }
-      )
-
-    return {
-      'series': series,
-      'xAxis': {
-        'label': self.x_axis_config.label,
-        'measureUnit': self.x_axis_config.measure_unit,
-        'dataType': self.x_axis_config.data_type.value,
-        'minValue': self.x_axis_config.min_value,
-        'maxValue': self.x_axis_config.max_value,
-      },
-      'yAxis': {
-        'label': self.y_axis_config.label,
-        'measureUnit': self.y_axis_config.measure_unit,
-        'dataType': self.y_axis_config.data_type.value,
-        'minValue': self.y_axis_config.min_value,
-        'maxValue': self.y_axis_config.max_value,
-      },
-    }
-
-  def _render_graphic(self) -> Any:
-    """
-    Converts the configuration of the chart to Flutter library Graphic.
-    """
-    series = []
-    for serie in self.series:
-      data = []
-
-      type_serie = 'SCATTER'
-      if serie.serie_type == ChartDataSerieType.SCATTER:
-        type_serie = 'SCATTER'
-      elif serie.serie_type == ChartDataSerieType.LINE:
-        type_serie = 'LINE'
-      elif serie.serie_type == ChartDataSerieType.AREA:
-        type_serie = 'AREA'
-      else:
-        continue
-
-      for item in serie.data:
-        data.append(
-          {
-            'x_axis': item.x,
-            'y_axis': item.y,
-          }
-        )
-
-      series.append(
-        {
-          'group': serie.label,
-          'color': serie.color,
-          'values': data,
-          'type': type_serie,
-        }
-      )
-
-    return series
-
-  def _render_apexcharts(self) -> Any:
-    """
-    Converts the configuration of the chart to Javascript library ApexCharts.
-    """
-
-    series = []
-    colors = []
-
-    for serie in self.series:
-      data = []
-
-      for item in serie.data:
-        data.append([item.x, item.y])
-
-      series.append(
-        {
-          'name': serie.label,
-          'data': data,
-          'type': serie.serie_type.value,
-        }
-      )
-      colors.append(serie.color)
-
-    config = {
-      'series': series,
-      'colors': colors,
-      'title': {
-        'text': self.title,
-        'align': self.align.value,
-        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-      },
-      'chart': {
-        'type': 'scatter',
-        'animations': {'enabled': False},
-        'toolbar': {'show': False},
-        'zoom': {'enabled': False},
-      },
-      'dataLabels': {'enabled': True},
-    }
-
-    return config
+"""Scatter chart"""
+
+import sys
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field
+
+from .axis_config import AxisConfig
+from .chart_alignment import ChartAlignment
+from .chart_data_serie_type import ChartDataSerieType
+from .chart_render_technology import ChartRenderTechnology
+from .scatter_serie import ScatterSerie
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class ScatterChart(BaseModel):
+  """Scatter chart configuration"""
+
+  series: List[ScatterSerie] = 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)
+  x_axis_config: AxisConfig = Field(
+    default_factory=lambda: AxisConfig(),
+    description='Configuration of the X Axis',
+  )
+  y_axis_config: AxisConfig = Field(
+    default_factory=lambda: AxisConfig(),
+    description='Configuration of the Y Axis',
+  )
+
+  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': 'SCATTER',
+        'configuration': self._render_graphic(),
+      }
+
+    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
+      return {
+        'library': 'SYNCFUSION_FLUTTER_CHARTS',
+        'chart': 'SCATTER',
+        'configuration': self._render_syncfusion_flutter_charts(),
+      }
+
+    if technology == ChartRenderTechnology.APEX_CHARTS:
+      return {
+        'library': 'APEXCHARTS',
+        'chart': 'SCATTER',
+        '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 Flutter library Graphic.
+    """
+    series = []
+    for serie in self.series:
+      data = []
+
+      type_serie = 'SCATTER'
+      if serie.serie_type == ChartDataSerieType.SCATTER:
+        type_serie = 'SCATTER'
+      elif serie.serie_type == ChartDataSerieType.LINE:
+        type_serie = 'LINE'
+      elif serie.serie_type == ChartDataSerieType.AREA:
+        type_serie = 'AREA'
+      else:
+        continue
+
+      for item in serie.data:
+        if not isinstance(item.x, (int, float)):
+          continue
+        if not isinstance(item.y, (int, float)):
+          continue
+
+        data.append(
+          {
+            'xAxis': item.x,
+            'yAxis': item.y,
+          }
+        )
+
+      series.append(
+        {
+          'label': serie.label,
+          'color': serie.color,
+          'values': data,
+          'type': type_serie,
+        }
+      )
+
+    return {
+      'series': series,
+      'xAxis': {
+        'label': self.x_axis_config.label,
+        'measureUnit': self.x_axis_config.measure_unit,
+        'dataType': self.x_axis_config.data_type.value,
+        'minValue': self.x_axis_config.min_value,
+        'maxValue': self.x_axis_config.max_value,
+      },
+      'yAxis': {
+        'label': self.y_axis_config.label,
+        'measureUnit': self.y_axis_config.measure_unit,
+        'dataType': self.y_axis_config.data_type.value,
+        'minValue': self.y_axis_config.min_value,
+        'maxValue': self.y_axis_config.max_value,
+      },
+    }
+
+  def _render_graphic(self: Self) -> List[Dict[str, Any]]:
+    """
+    Converts the configuration of the chart to Flutter library Graphic.
+    """
+    series = []
+    for serie in self.series:
+      data = []
+
+      type_serie = 'SCATTER'
+      if serie.serie_type == ChartDataSerieType.SCATTER:
+        type_serie = 'SCATTER'
+      elif serie.serie_type == ChartDataSerieType.LINE:
+        type_serie = 'LINE'
+      elif serie.serie_type == ChartDataSerieType.AREA:
+        type_serie = 'AREA'
+      else:
+        continue
+
+      for item in serie.data:
+        data.append(
+          {
+            'x_axis': item.x,
+            'y_axis': item.y,
+          }
+        )
+
+      series.append(
+        {
+          'group': serie.label,
+          'color': serie.color,
+          'values': data,
+          'type': type_serie,
+        }
+      )
+
+    return series
+
+  def _render_apexcharts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Javascript library ApexCharts.
+    """
+
+    series = []
+    colors = []
+
+    for serie in self.series:
+      data = []
+
+      for item in serie.data:
+        data.append([item.x, item.y])
+
+      series.append(
+        {
+          'name': serie.label,
+          'data': data,
+          'type': serie.serie_type.value,
+        }
+      )
+      colors.append(serie.color)
+
+    config = {
+      'series': series,
+      'colors': colors,
+      'title': {
+        'text': self.title,
+        'align': self.align.value,
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+      },
+      'chart': {
+        'type': 'scatter',
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
+      'dataLabels': {'enabled': True},
+    }
+
+    return config

layrz_sdk/entities/charts/scatter_serie.py

@@ -0,0 +1,15 @@
+from typing import List
+
+from pydantic import BaseModel, Field
+
+from .chart_data_serie_type import ChartDataSerieType
+from .scatter_serie_item import ScatterSerieItem
+
+
+class ScatterSerie(BaseModel):
+  """Chart Data Serie for Timeline charts"""
+
+  data: List[ScatterSerieItem] = Field(description='List of data points', default_factory=list)
+  color: str = Field(description='Color of the serie', default='')
+  label: str = Field(description='Label of the serie', default='')
+  serie_type: ChartDataSerieType = Field(description='Type of the serie', default=ChartDataSerieType.SCATTER)

layrz_sdk/entities/charts/scatter_serie_item.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel, Field
+
+
+class ScatterSerieItem(BaseModel):
+  """Chart Data Serie Item for Scatter Charts"""
+
+  x: float = Field(description='X value of the item')
+  y: float = Field(description='Y value of the item')

layrz_sdk/entities/charts/table_chart.py

@@ -0,0 +1,50 @@
+"""Number chart"""
+
+import sys
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field
+
+from .chart_render_technology import ChartRenderTechnology
+from .table_header import TableHeader
+from .table_row import TableRow
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class TableChart(BaseModel):
+  """Table chart configuration"""
+
+  columns: List[TableHeader] = Field(description='List of columns', default_factory=list)
+  rows: List[TableRow] = Field(description='List of rows', default_factory=list)
+
+  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': 'TABLE',
+        '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 {
+      'columns': [{'key': column.key, 'label': column.label} for column in self.columns],
+      'rows': [{'data': row.data} for row in self.rows],
+    }

layrz_sdk/entities/charts/table_header.py

@@ -0,0 +1,8 @@
+from pydantic import BaseModel, Field
+
+
+class TableHeader(BaseModel):
+  """Table header chart configuration"""
+
+  label: str = Field(description='Label of the header')
+  key: str = Field(description='Key of the header')

layrz_sdk/entities/charts/table_row.py

@@ -0,0 +1,9 @@
+from typing import Any
+
+from pydantic import BaseModel, Field
+
+
+class TableRow(BaseModel):
+  """Table row chart configuration"""
+
+  data: Any = Field(description='Data of the row')

layrz_sdk/entities/charts/timeline_chart.py

@@ -0,0 +1,75 @@
+"""Timeline chart entities"""
+
+import sys
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, Field
+
+from .chart_alignment import ChartAlignment
+from .timeline_serie import TimelineSerie
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class TimelineChart(BaseModel):
+  """Timeline chart configuration"""
+
+  series: List[TimelineSerie] = 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) -> 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 = []
+
+    for serie in self.series:
+      data = []
+
+      for item in serie.data:
+        data.append(
+          {
+            'x': item.name,
+            'y': [item.start_at.timestamp() * 1000, item.end_at.timestamp() * 1000],
+            'fillColor': item.color,
+          }
+        )
+
+      series.append({'name': serie.label, 'data': data})
+
+    config = {
+      'series': series,
+      'title': {
+        'text': self.title,
+        'align': self.align.value,
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+      },
+      'chart': {
+        'type': 'rangeBar',
+        'animations': {'enabled': False},
+        'toolbar': {'show': False},
+        'zoom': {'enabled': False},
+      },
+      'xaxis': {'type': 'datetime'},
+      'plotOptions': {
+        'bar': {
+          'horizontal': True,
+        }
+      },
+      'dataLabels': {'enabled': True},
+    }
+
+    return config