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

layrz_sdk/entities/charts/{column.py → column_chart.py}

@@ -1,236 +1,197 @@
-"""Column chart"""
-
-from typing import Any, List
-
-from layrz_sdk.helpers import convert_to_rgba
-
-from .alignment import ChartAlignment
-from .configuration import AxisConfig
-from .exceptions import ChartException
-from .render_technology import ChartRenderTechnology
-from .serie import ChartDataSerie
-from .serie_type import ChartDataSerieType
-
-
-class ColumnChart:
-  """
-  Column chart configuration
-
-  """
-
-  def __init__(
-    self,
-    x_axis: ChartDataSerie,
-    y_axis: List[ChartDataSerie],
-    title: str = 'Chart',
-    align: ChartAlignment = ChartAlignment.CENTER,
-    x_axis_config: AxisConfig = None,
-    y_axis_config: AxisConfig = None,
-  ) -> None:
-    """
-    Constructor
-    ----
-    Arguments
-      - x_axis : Defines the X Axis of the chart, uses the ChartDataSerie class.
-                 Please read the documentation to more information.
-      - y_axis : Defines the Y Axis of the chart, uses the ChartDataSerie class.
-                 Please read the documentation to more information.
-      - title : Title of the chart
-      - align : Alignment of the title
-      - x_axis_config : Configuration of the X Axis
-      - y_axis_config : Configuration of the Y Axis
-    """
-    for i, serie in enumerate(y_axis):
-      if not isinstance(serie, ChartDataSerie):
-        raise ChartException(f'Y Axis serie {i} must be an instance of ChartDataSerie')
-    self.y_axis = y_axis
-
-    if not isinstance(x_axis, ChartDataSerie):
-      raise ChartException('X Axis must be an instance of ChartDataSerie')
-    self.x_axis = x_axis
-
-    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()
-
-    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()
-
-    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': 'COLUMN',
-        'configuration': self._render_graphic(),
-      }
-
-    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
-      return {
-        'library': 'SYNCFUSION_FLUTTER_CHARTS',
-        'chart': 'COLUMN',
-        'configuration': self._render_syncfusion_flutter_charts(),
-      }
-
-    if technology == ChartRenderTechnology.APEX_CHARTS:
-      return {
-        'library': 'APEXCHARTS',
-        'chart': 'COLUMN',
-        '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.y_axis:
-      values = []
-      for i, value in enumerate(serie.data):
-        x_axis = self.x_axis.data[i]
-        values.append({'xAxis': x_axis, 'yAxis': value})
-
-      series.append(
-        {
-          'label': serie.label,
-          'color': serie.color,
-          'values': values,
-        }
-      )
-
-    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.y_axis:
-      for i, value in enumerate(serie.data):
-        x_axis = self.x_axis.data[i]
-        series.append(
-          {
-            'label': serie.label,
-            'color': serie.color,
-            'category': x_axis,
-            'value': value,
-          }
-        )
-
-    return series
-
-  def _render_apexcharts(self) -> Any:
-    """
-    Converts the configuration of the chart to Javascript library ApexCharts.
-    """
-
-    series = []
-    colors = []
-    stroke = {'width': [], 'dashArray': []}
-    markers = []
-
-    for serie in self.y_axis:
-      modified_serie = {
-        'name': serie.label,
-      }
-      if serie.serie_type == ChartDataSerieType.SCATTER:
-        modified_serie['data'] = [{'x': item.x, 'y': item.y} for item in serie.data]
-        modified_serie['type'] = 'scatter'
-        stroke['width'].append(0)
-        markers.append(10)
-      else:
-        modified_serie['data'] = [{'x': self.x_axis.data[i], 'y': item} for i, item in enumerate(serie.data)]
-
-        if serie.serie_type is not ChartDataSerieType.NONE:
-          modified_serie['type'] = serie.serie_type.value
-        else:
-          modified_serie['type'] = 'column'
-
-        if serie.dashed and serie.serie_type == ChartDataSerieType.LINE:
-          stroke['dashArray'].append(5)
-        else:
-          stroke['dashArray'].append(0)
-
-        stroke['width'].append(3)
-        markers.append(0)
-
-      series.append(modified_serie)
-
-      if serie.serie_type == ChartDataSerieType.AREA:
-        color = convert_to_rgba(serie.color)
-        colors.append(f'rgba({color[0]}, {color[1]}, {color[2]}, 0.5)')
-      else:
-        colors.append(serie.color)
-
-    config = {
-      'series': series,
-      'colors': colors,
-      'xaxis': {
-        'type': self.x_axis.data_type.value,
-        'title': {
-          'text': self.x_axis.label,
-          'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-        },
-      },
-      'dataLabels': {'enabled': False},
-      'title': {
-        'text': self.title,
-        'align': self.align.value,
-        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
-      },
-      'markers': {'size': markers},
-      'fill': {'type': 'solid'},
-      'stroke': stroke,
-      'chart': {'animations': {'enabled': False}, 'toolbar': {'show': False}, 'zoom': {'enabled': False}},
-    }
-
-    return config
+"""Column chart"""
+
+import sys
+from typing import Any, Dict, List
+
+from layrz_sdk.helpers import convert_to_rgba
+
+from .axis_config import AxisConfig
+from .chart_alignment import ChartAlignment
+from .chart_data_serie import ChartDataSerie
+from .chart_data_serie_type import ChartDataSerieType
+from .chart_render_technology import ChartRenderTechnology
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+from pydantic import BaseModel, Field
+
+
+class ColumnChart(BaseModel):
+  """Column chart configuration"""
+
+  x_axis: ChartDataSerie = Field(description='Defines the X Axis of the chart')
+  y_axis: List[ChartDataSerie] = Field(description='Defines the Y Axis of the chart', default_factory=list)
+  title: str = Field(default='Chart', description='Title of the chart')
+  align: ChartAlignment = Field(default=ChartAlignment.CENTER, description='Alignment of the title')
+  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,
+  ) -> 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': 'COLUMN',
+        'configuration': self._render_graphic(),
+      }
+
+    if technology == ChartRenderTechnology.SYNCFUSION_FLUTTER_CHARTS:
+      return {
+        'library': 'SYNCFUSION_FLUTTER_CHARTS',
+        'chart': 'COLUMN',
+        'configuration': self._render_syncfusion_flutter_charts(),
+      }
+
+    if technology == ChartRenderTechnology.APEX_CHARTS:
+      return {
+        'library': 'APEXCHARTS',
+        'chart': 'COLUMN',
+        '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.y_axis:
+      values = []
+      for i, value in enumerate(serie.data):
+        x_axis = self.x_axis.data[i]
+        values.append({'xAxis': x_axis, 'yAxis': value})
+
+      series.append(
+        {
+          'label': serie.label,
+          'color': serie.color,
+          'values': values,
+        }
+      )
+
+    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.y_axis:
+      for i, value in enumerate(serie.data):
+        x_axis = self.x_axis.data[i]
+        series.append(
+          {
+            'label': serie.label,
+            'color': serie.color,
+            'category': x_axis,
+            'value': value,
+          }
+        )
+
+    return series
+
+  def _render_apexcharts(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to Javascript library ApexCharts.
+    """
+
+    series = []
+    colors = []
+    stroke: Dict[str, Any] = {'width': [], 'dashArray': []}
+    markers = []
+
+    for serie in self.y_axis:
+      modified_serie: Dict[str, Any] = {
+        'name': serie.label,
+      }
+      if serie.serie_type == ChartDataSerieType.SCATTER:
+        modified_serie['data'] = [{'x': item.x, 'y': item.y} for item in serie.data]
+        modified_serie['type'] = 'scatter'
+        stroke['width'].append(0)
+        markers.append(10)
+      else:
+        modified_serie['data'] = [{'x': self.x_axis.data[i], 'y': item} for i, item in enumerate(serie.data)]
+
+        if serie.serie_type is not ChartDataSerieType.NONE:
+          modified_serie['type'] = serie.serie_type.value
+        else:
+          modified_serie['type'] = 'column'
+
+        if serie.dashed and serie.serie_type == ChartDataSerieType.LINE:
+          stroke['dashArray'].append(5)
+        else:
+          stroke['dashArray'].append(0)
+
+        stroke['width'].append(3)
+        markers.append(0)
+
+      series.append(modified_serie)
+
+      if serie.serie_type == ChartDataSerieType.AREA:
+        color = convert_to_rgba(serie.color)
+        colors.append(f'rgba({color[0]}, {color[1]}, {color[2]}, 0.5)')
+      else:
+        colors.append(serie.color)
+
+    config = {
+      'series': series,
+      'colors': colors,
+      'xaxis': {
+        'type': self.x_axis.data_type.value,
+        'title': {
+          'text': self.x_axis.label,
+          'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+        },
+      },
+      'dataLabels': {'enabled': False},
+      'title': {
+        'text': self.title,
+        'align': self.align.value,
+        'style': {'fontFamily': 'Fira Sans Condensed', 'fontSize': '20px', 'fontWeight': 'normal'},
+      },
+      'markers': {'size': markers},
+      'fill': {'type': 'solid'},
+      'stroke': stroke,
+      'chart': {'animations': {'enabled': False}, 'toolbar': {'show': False}, 'zoom': {'enabled': False}},
+    }
+
+    return config

layrz_sdk/entities/charts/html_chart.py

@@ -0,0 +1,34 @@
+"""HTML chart"""
+
+import sys
+from typing import Any, Dict
+
+from pydantic import BaseModel, Field
+
+if sys.version_info >= (3, 11):
+  from typing import Self
+else:
+  from typing_extensions import Self
+
+
+class HTMLChart(BaseModel):
+  """HTML chart configuration"""
+
+  content: str = Field(description='HTML content of the chart', default='<p>N/A</p>')
+  title: str = Field(description='Title of the chart', default='Chart')
+
+  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': 'HTML', 'configuration': self._render_html()}
+
+  def _render_html(self: Self) -> Dict[str, Any]:
+    """
+    Converts the configuration of the chart to HTML render engine.
+    """
+    config = {'content': self.content, 'title': self.title}
+
+    return config