<filename>Lib/js/configs/JsConfigPlotly.py
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# author: <NAME>


from ares.Lib.js.configs import JsConfig


DSC = {

}


class JsBase(JsConfig.JsConfig):
  """ Base Class for the Plotly Charts """
  listAttributes = []
  jsCls = 'Chart'
  reference = None # The main link to get the documentation of this chart
  _statics = None # Static configuration will be added to each dara set automatically
  _layout = None # Change the layout properties of the chart
  jsType = None # Attach the chart to a family for the data transformation

  def __init__(self, aresObj, data, seriesProperties):
    super(JsBase, self).__init__(aresObj, data, seriesProperties)
    for key, val in self._attrs.items():
      self.seriesProperties.setdefault('static', {})[key] = val
    self.config()

  def config(self):
    if self._statics is not None:
      self.seriesProperties["static"].update(self._statics)

  def _colors(self, cList, index=None):
    """
    :category: Chart Colors
    :rubric: JS
    :type: Configuration
    :dsc:
      Internal function to allow the change of colors of the different series in a Plotly chart.
      Plotly configuration is using the internal variable seriesProperties in order to add the properties once
      the Javascript function has aggregated the different values.
    """
    if index is not None:
      if not "marker" in self.__chart.seriesProperties["static"]:
        self.seriesProperties["static"]["marker"] = {'color': [cList]}
    else:
      for i in range(len(self.data._schema['out']['params'][0])):
        self.seriesProperties["dynamic"].setdefault(i, {})["marker"] = {'color': cList[i]}


# ---------------------------------------------------------------------------------------------------------
#                                          Plotly Configurations
# ---------------------------------------------------------------------------------------------------------
class JsBar(JsBase):
  """ Configuration for a Bars Chart in Plotly """
  alias = 'bar'
  name = 'Bars'
  _attrs = {'type': 'bar'}
  reference = "https://plot.ly/javascript/bar-charts/"


class JsHBar(JsBase):
  """ Configuration for a Horizontal Bars Chart in Plotly """
  alias = 'hbar'
  name = 'Horizontal Bars'
  _attrs = {'orientation': 'h', 'type': 'bar'}
  reference = "https://plot.ly/javascript/bar-charts/"


class JsPie(JsBase):
  """ Configuration for a Pie Chart in Plotly """
  alias = 'pie'
  name = 'Pie'
  _attrs = {'type': 'pie'}
  reference = 'https://plot.ly/javascript/pie-charts/'

  def _colors(self, cList, index=None):
    """
    :category: Chart Series Colors
    :rubric: JS
    :type: Configuration
    :dsc:

    """
    if index is not None:
      if not "marker" in self.__chart.seriesProperties["static"]:
        self.seriesProperties["static"]["marker"] = {'colors': cList}
    else:
      for i in range(len(self.data._schema['out']['params'][0])):
        self.seriesProperties["dynamic"].setdefault(i, {})["marker"] = {'colors': cList}


class JsDonut(JsPie):
  """ Configuration for a Donut Chart in Plotly """
  alias = 'donut'
  name = 'Donut'
  _attrs = {'hole': '.4', 'type': 'pie'}
  reference = 'https://plot.ly/javascript/pie-charts/'


#---------------------------------------------------------------------------------------------------------
#                           LINE CHARTS
#
class JsMulti(JsBase):
  """ Configuration for a Multi Chart in Plotly """
  alias = 'multi'
  name = 'Multi Series'
  _attrs = {'type': 'scatter'}


class JsLine(JsBase):
  """ Configuration for a Linea Chart in Plotly """
  alias = 'line'
  name = 'Line Series'
  _attrs = {'type': 'scatter'}


class JsScatter(JsBase):
  """ Configuration for a Scatter Chart in Plotly """
  alias = 'scatter'
  name = 'Scatter Series'
  _attrs = {'mode': 'markers+text', 'type': 'scatter'}


class JsArea(JsBase):
  """ Configuration for a Horizontal Bars Chart in Plotly """
  alias = 'area'
  name = 'Area Series'
  _attrs = {'fill': 'tonexty', 'mode': 'none'}


class JsBubble(JsBase):
  """ Configuration for a Bubble Chart in Plotly """
  alias = 'bubble'
  name = 'Bubble Chart'
  _attrs = {'mode': 'scatter'}

  def config(self):
    for i in range(len(self.data._schema['out']['params'][0])):
      self.seriesProperties['dynamic'][i] = {'marker': {'size': [1, 4, 50]}, 'mode': 'markers'}


#---------------------------------------------------------------------------------------------------------
#                           STATISTIC CHARTS
#
class JsBox(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'box'
  name = 'Basic Box Series'
  _attrs = {'type': 'box'}
  reference = "https://plot.ly/javascript/box-plots/"
  _statics = {"boxpoints": 'all'}


class JsHBox(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'hbox'
  name = 'Horizontal Box Series'
  _attrs = {'type': 'box'}
  reference = "https://plot.ly/javascript/box-plots/"


class JsSankey(JsBase):
  """ Configuration for a Sankey Chart in Plotly """
  alias = 'sankey'
  name = 'Sankey Series'
  _attrs = {'type': 'sankey'}
  reference = "https://plot.ly/javascript/sankey-diagram/"


class JsParallelCoordinates(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'parcoords'
  name = 'Parallel Coordinates Series'
  _attrs = {'type': 'parcoords'}
  reference = "https://plot.ly/javascript/parallel-coordinates-plot/"


class JsParallelCategory(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'parcats'
  name = 'Basic Parallel Categories Diagram'
  _attrs = {'type': 'parcats'}
  reference = "https://plot.ly/javascript/parallel-categories-diagram/"


#---------------------------------------------------------------------------------------------------------
#                           MAPS / HEATMAPS CHARTS
#
class JsMaps(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'choropleth'
  name = 'Country GDP Choropleth Map'
  _attrs = {'type': 'choropleth', "locationmode": 'country names', "autocolorscale": False,}
  reference = "https://plot.ly/javascript/choropleth-maps/"


class JsMapsEurope(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'europe'
  jsType = 'choropleth'
  name = 'Country GDP Choropleth Map'
  _attrs = {'type': 'choropleth', "locationmode": 'country names', "autocolorscale": False,}
  reference = "https://plot.ly/javascript/choropleth-maps/"
  _layout = {"geo": {"showland": True, "projection": {"type": "Mercator"}, "scope": "europe", "showcoastlines": True, "showframe": True}}


class JsHeatMap(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'heatmap'
  name = 'Basic Parallel Categories Diagram'
  _attrs = {'type': 'heatmap', 'showscale': False}
  reference = "https://plot.ly/javascript/heatmaps/"


#---------------------------------------------------------------------------------------------------------
#                           3D CHARTS
#
class JsSurface(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'surface'
  name = 'Surface Plot'
  _attrs = {'type': 'surface', 'opacity': 0.9}
  reference = "https://plot.ly/javascript/3d-surface-plots/"


class JsSurfaceBorder(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'surface-contours'
  name = 'Surface Plot'
  _attrs = {'type': 'surface'}
  reference = "https://plot.ly/javascript/3d-surface-plots/"
  _statics = {'contours': {'z': {
      'show': True, 'usecolormap': True, 'highlightcolor': "#42f462", 'project':{ 'z' : True}}}}


class JsScatter3D(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'scatter3d'
  name = '3D Point Clustering'
  _attrs = {'type': 'scatter3d'}
  reference = "https://plot.ly/javascript/3d-point-clustering/"
  _layout = {'showlegend': False}

  def _colors(self, cList, indices=None):
    """
    :category: Chart Series Colors
    :rubric: JS
    :type: Configuration
    :dsc:

    """
    if indices is not None:
      if not isinstance(indices, list):
        indices, cList = [indices], [cList]
      for i, index in enumerate(indices):
       self.seriesProperties["dynamic"][index]["marker"].update({'color': cList[i]})
    else:
      for i in range(len(self.data._schema['out']['params'][0])+1):
        self.seriesProperties["dynamic"].setdefault(i, {})["marker"] = {'color': cList[i]}


class JsLine3D(JsScatter3D):
  """ Configuration for a Box Chart in Plotly """
  alias = 'line3d'
  jsType = 'scatter3d'
  name = '3D Point Clustering'
  _attrs = {'type': 'scatter3d', 'opacity': 1, 'mode': 'lines'}


class JsMesh3D(JsScatter3D):
  """ Configuration for a Box Chart in Plotly """
  alias = 'mesh3d'
  name = '3D Clustering'
  _attrs = {'type': 'mesh3d'}
  reference = "https://plot.ly/javascript/3d-point-clustering/"
  _layout = {'showlegend': False, 'autosize': True}
  _statics = {'opacity': 0.1}



if __name__ == "__main__":
  configObj = JsBar(None, [], {})
  #lineChart.addAttr('pattern', ['yellow'], 'color')
  print(configObj)
<filename>Lib/js/configs/JsConfigPlotly.py
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# author: <NAME>


from ares.Lib.js.configs import JsConfig


DSC = {

}


class JsBase(JsConfig.JsConfig):
  """ Base Class for the Plotly Charts """
  listAttributes = []
  jsCls = 'Chart'
  reference = None # The main link to get the documentation of this chart
  _statics = None # Static configuration will be added to each dara set automatically
  _layout = None # Change the layout properties of the chart
  jsType = None # Attach the chart to a family for the data transformation

  def __init__(self, aresObj, data, seriesProperties):
    super(JsBase, self).__init__(aresObj, data, seriesProperties)
    for key, val in self._attrs.items():
      self.seriesProperties.setdefault('static', {})[key] = val
    self.config()

  def config(self):
    if self._statics is not None:
      self.seriesProperties["static"].update(self._statics)

  def _colors(self, cList, index=None):
    """
    :category: Chart Colors
    :rubric: JS
    :type: Configuration
    :dsc:
      Internal function to allow the change of colors of the different series in a Plotly chart.
      Plotly configuration is using the internal variable seriesProperties in order to add the properties once
      the Javascript function has aggregated the different values.
    """
    if index is not None:
      if not "marker" in self.__chart.seriesProperties["static"]:
        self.seriesProperties["static"]["marker"] = {'color': [cList]}
    else:
      for i in range(len(self.data._schema['out']['params'][0])):
        self.seriesProperties["dynamic"].setdefault(i, {})["marker"] = {'color': cList[i]}


# ---------------------------------------------------------------------------------------------------------
#                                          Plotly Configurations
# ---------------------------------------------------------------------------------------------------------
class JsBar(JsBase):
  """ Configuration for a Bars Chart in Plotly """
  alias = 'bar'
  name = 'Bars'
  _attrs = {'type': 'bar'}
  reference = "https://plot.ly/javascript/bar-charts/"


class JsHBar(JsBase):
  """ Configuration for a Horizontal Bars Chart in Plotly """
  alias = 'hbar'
  name = 'Horizontal Bars'
  _attrs = {'orientation': 'h', 'type': 'bar'}
  reference = "https://plot.ly/javascript/bar-charts/"


class JsPie(JsBase):
  """ Configuration for a Pie Chart in Plotly """
  alias = 'pie'
  name = 'Pie'
  _attrs = {'type': 'pie'}
  reference = 'https://plot.ly/javascript/pie-charts/'

  def _colors(self, cList, index=None):
    """
    :category: Chart Series Colors
    :rubric: JS
    :type: Configuration
    :dsc:

    """
    if index is not None:
      if not "marker" in self.__chart.seriesProperties["static"]:
        self.seriesProperties["static"]["marker"] = {'colors': cList}
    else:
      for i in range(len(self.data._schema['out']['params'][0])):
        self.seriesProperties["dynamic"].setdefault(i, {})["marker"] = {'colors': cList}


class JsDonut(JsPie):
  """ Configuration for a Donut Chart in Plotly """
  alias = 'donut'
  name = 'Donut'
  _attrs = {'hole': '.4', 'type': 'pie'}
  reference = 'https://plot.ly/javascript/pie-charts/'


#---------------------------------------------------------------------------------------------------------
#                           LINE CHARTS
#
class JsMulti(JsBase):
  """ Configuration for a Multi Chart in Plotly """
  alias = 'multi'
  name = 'Multi Series'
  _attrs = {'type': 'scatter'}


class JsLine(JsBase):
  """ Configuration for a Linea Chart in Plotly """
  alias = 'line'
  name = 'Line Series'
  _attrs = {'type': 'scatter'}


class JsScatter(JsBase):
  """ Configuration for a Scatter Chart in Plotly """
  alias = 'scatter'
  name = 'Scatter Series'
  _attrs = {'mode': 'markers+text', 'type': 'scatter'}


class JsArea(JsBase):
  """ Configuration for a Horizontal Bars Chart in Plotly """
  alias = 'area'
  name = 'Area Series'
  _attrs = {'fill': 'tonexty', 'mode': 'none'}


class JsBubble(JsBase):
  """ Configuration for a Bubble Chart in Plotly """
  alias = 'bubble'
  name = 'Bubble Chart'
  _attrs = {'mode': 'scatter'}

  def config(self):
    for i in range(len(self.data._schema['out']['params'][0])):
      self.seriesProperties['dynamic'][i] = {'marker': {'size': [1, 4, 50]}, 'mode': 'markers'}


#---------------------------------------------------------------------------------------------------------
#                           STATISTIC CHARTS
#
class JsBox(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'box'
  name = 'Basic Box Series'
  _attrs = {'type': 'box'}
  reference = "https://plot.ly/javascript/box-plots/"
  _statics = {"boxpoints": 'all'}


class JsHBox(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'hbox'
  name = 'Horizontal Box Series'
  _attrs = {'type': 'box'}
  reference = "https://plot.ly/javascript/box-plots/"


class JsSankey(JsBase):
  """ Configuration for a Sankey Chart in Plotly """
  alias = 'sankey'
  name = 'Sankey Series'
  _attrs = {'type': 'sankey'}
  reference = "https://plot.ly/javascript/sankey-diagram/"


class JsParallelCoordinates(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'parcoords'
  name = 'Parallel Coordinates Series'
  _attrs = {'type': 'parcoords'}
  reference = "https://plot.ly/javascript/parallel-coordinates-plot/"


class JsParallelCategory(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'parcats'
  name = 'Basic Parallel Categories Diagram'
  _attrs = {'type': 'parcats'}
  reference = "https://plot.ly/javascript/parallel-categories-diagram/"


#---------------------------------------------------------------------------------------------------------
#                           MAPS / HEATMAPS CHARTS
#
class JsMaps(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'choropleth'
  name = 'Country GDP Choropleth Map'
  _attrs = {'type': 'choropleth', "locationmode": 'country names', "autocolorscale": False,}
  reference = "https://plot.ly/javascript/choropleth-maps/"


class JsMapsEurope(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'europe'
  jsType = 'choropleth'
  name = 'Country GDP Choropleth Map'
  _attrs = {'type': 'choropleth', "locationmode": 'country names', "autocolorscale": False,}
  reference = "https://plot.ly/javascript/choropleth-maps/"
  _layout = {"geo": {"showland": True, "projection": {"type": "Mercator"}, "scope": "europe", "showcoastlines": True, "showframe": True}}


class JsHeatMap(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'heatmap'
  name = 'Basic Parallel Categories Diagram'
  _attrs = {'type': 'heatmap', 'showscale': False}
  reference = "https://plot.ly/javascript/heatmaps/"


#---------------------------------------------------------------------------------------------------------
#                           3D CHARTS
#
class JsSurface(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'surface'
  name = 'Surface Plot'
  _attrs = {'type': 'surface', 'opacity': 0.9}
  reference = "https://plot.ly/javascript/3d-surface-plots/"


class JsSurfaceBorder(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'surface-contours'
  name = 'Surface Plot'
  _attrs = {'type': 'surface'}
  reference = "https://plot.ly/javascript/3d-surface-plots/"
  _statics = {'contours': {'z': {
      'show': True, 'usecolormap': True, 'highlightcolor': "#42f462", 'project':{ 'z' : True}}}}


class JsScatter3D(JsBase):
  """ Configuration for a Box Chart in Plotly """
  alias = 'scatter3d'
  name = '3D Point Clustering'
  _attrs = {'type': 'scatter3d'}
  reference = "https://plot.ly/javascript/3d-point-clustering/"
  _layout = {'showlegend': False}

  def _colors(self, cList, indices=None):
    """
    :category: Chart Series Colors
    :rubric: JS
    :type: Configuration
    :dsc:

    """
    if indices is not None:
      if not isinstance(indices, list):
        indices, cList = [indices], [cList]
      for i, index in enumerate(indices):
       self.seriesProperties["dynamic"][index]["marker"].update({'color': cList[i]})
    else:
      for i in range(len(self.data._schema['out']['params'][0])+1):
        self.seriesProperties["dynamic"].setdefault(i, {})["marker"] = {'color': cList[i]}


class JsLine3D(JsScatter3D):
  """ Configuration for a Box Chart in Plotly """
  alias = 'line3d'
  jsType = 'scatter3d'
  name = '3D Point Clustering'
  _attrs = {'type': 'scatter3d', 'opacity': 1, 'mode': 'lines'}


class JsMesh3D(JsScatter3D):
  """ Configuration for a Box Chart in Plotly """
  alias = 'mesh3d'
  name = '3D Clustering'
  _attrs = {'type': 'mesh3d'}
  reference = "https://plot.ly/javascript/3d-point-clustering/"
  _layout = {'showlegend': False, 'autosize': True}
  _statics = {'opacity': 0.1}



if __name__ == "__main__":
  configObj = JsBar(None, [], {})
  #lineChart.addAttr('pattern', ['yellow'], 'color')
  print(configObj)
#!/usr/bin/env python # -*- coding: utf-8 -*- # author: <NAME> Base Class for the Plotly Charts # The main link to get the documentation of this chart # Static configuration will be added to each dara set automatically # Change the layout properties of the chart # Attach the chart to a family for the data transformation :category: Chart Colors
     :rubric: JS
     :type: Configuration
     :dsc:
       Internal function to allow the change of colors of the different series in a Plotly chart.
       Plotly configuration is using the internal variable seriesProperties in order to add the properties once
       the Javascript function has aggregated the different values. # --------------------------------------------------------------------------------------------------------- #                                          Plotly Configurations # --------------------------------------------------------------------------------------------------------- Configuration for a Bars Chart in Plotly Configuration for a Horizontal Bars Chart in Plotly Configuration for a Pie Chart in Plotly :category: Chart Series Colors
     :rubric: JS
     :type: Configuration
     :dsc: Configuration for a Donut Chart in Plotly #--------------------------------------------------------------------------------------------------------- #                           LINE CHARTS # Configuration for a Multi Chart in Plotly Configuration for a Linea Chart in Plotly Configuration for a Scatter Chart in Plotly Configuration for a Horizontal Bars Chart in Plotly Configuration for a Bubble Chart in Plotly #--------------------------------------------------------------------------------------------------------- #                           STATISTIC CHARTS # Configuration for a Box Chart in Plotly Configuration for a Box Chart in Plotly Configuration for a Sankey Chart in Plotly Configuration for a Box Chart in Plotly Configuration for a Box Chart in Plotly #--------------------------------------------------------------------------------------------------------- #                           MAPS / HEATMAPS CHARTS # Configuration for a Box Chart in Plotly Configuration for a Box Chart in Plotly Configuration for a Box Chart in Plotly #--------------------------------------------------------------------------------------------------------- #                           3D CHARTS # Configuration for a Box Chart in Plotly Configuration for a Box Chart in Plotly Configuration for a Box Chart in Plotly :category: Chart Series Colors
     :rubric: JS
     :type: Configuration
     :dsc: Configuration for a Box Chart in Plotly Configuration for a Box Chart in Plotly #lineChart.addAttr('pattern', ['yellow'], 'color')