eea.plotly 1.2__tar.gz → 1.4__tar.gz

{eea_plotly-1.2/eea.plotly.egg-info → eea_plotly-1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eea.plotly
-Version: 1.2
+Version: 1.4
 Summary: volto-plotlycharts backend support
 Home-page: https://github.com/eea/eea.plotly
 Author: European Environment Agency: IDM2 A-Team
@@ -145,6 +145,16 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+1.4 - (2025-05-30)
+---------------------------
+* Change: update soer_miniature preview adapter
+  [razvanMiu]
+
+1.3 - (2025-05-29)
+---------------------------
+* Change: Add preview adapter
+  [razvanMiu]
+
 1.2 - (2025-03-13)
 ---------------------------
 * Change: Add theme property

{eea_plotly-1.2 → eea_plotly-1.4}/docs/HISTORY.txt

@@ -1,6 +1,16 @@
 Changelog
 =========
 
+1.4 - (2025-05-30)
+---------------------------
+* Change: update soer_miniature preview adapter
+  [razvanMiu]
+
+1.3 - (2025-05-29)
+---------------------------
+* Change: Add preview adapter
+  [razvanMiu]
+
 1.2 - (2025-03-13)
 ---------------------------
 * Change: Add theme property

{eea_plotly-1.2 → eea_plotly-1.4}/eea/plotly/browser/preview.py

@@ -10,6 +10,8 @@ from Products.Five.browser import BrowserView
 from eea.plotly.controlpanel import IPlotlySettings
 from eea.plotly.utils import sanitizeVisualization
 
+from .preview_adapter.adapter import get_preview_adapter
+
 
 def deepUpdate(original, update):
     """ Recursively update a dictionary with another dictionary."""
@@ -27,16 +29,19 @@ def deepUpdate(original, update):
 class PlotlyPreview(BrowserView):
     """Plotly Preview"""
 
+    visualization = None
     name = None
+    width = 1200
+    height = 900
 
     def render(self):
         """Render"""
 
-        visualization = copy.deepcopy(
+        self.visualization = copy.deepcopy(
             sanitizeVisualization(self.context.visualization)
         )
 
-        if not visualization:
+        if not self.visualization:
             self.request.response.setStatus(404)
             return {
                 "message": "Visualization is not defined",
@@ -54,24 +59,28 @@ class PlotlyPreview(BrowserView):
                 if t.get("id") == self.name:
                     theme = copy.deepcopy(t)
                     break
-            if theme and "layout" in visualization:
+            if theme and "layout" in self.visualization:
                 data = theme.get("data", {})
                 layout = theme.get("layout", {})
-                for trIndex, tr in enumerate(visualization.get("data", [])):
+                for trIndex, tr in enumerate(
+                        self.visualization.get("data", [])):
                     trType = tr.get("type", "")
                     if trType in data:
                         newTrIndex = min(trIndex, len(data[trType])-1)
                         newTr = data[trType][newTrIndex]
                         deepUpdate(tr, newTr)
-                deepUpdate(visualization["layout"], layout)
-                visualization["layout"]["template"] = theme
+                deepUpdate(self.visualization["layout"], layout)
+                self.visualization["layout"]["template"] = theme
+
+        get_preview_adapter(self, self.name)
 
-        fig = pio.from_json(json.dumps(visualization), skip_invalid=True)
+        fig = pio.from_json(json.dumps(self.visualization), skip_invalid=True)
 
-        if "template" not in visualization["layout"]:
+        if "template" not in self.visualization["layout"]:
             fig.update_layout(template=None)
 
-        image = fig.to_image(format="svg", width=1200, height=900)
+        image = fig.to_image(
+            format="svg", width=self.width, height=self.height)
 
         sh = self.request.response.setHeader
 
@@ -86,6 +95,8 @@ class PlotlyPreview(BrowserView):
     def publishTraverse(self, request, name):
         """used for traversal via publisher, i.e. when using as a url"""
         self.name = name
+        self.width = int(request.form.get("width", self.width))
+        self.height = int(request.form.get("height", self.height))
         return self
 
     def __call__(self):

eea_plotly-1.4/eea/plotly/browser/preview_adapter/adapter.py

@@ -0,0 +1,23 @@
+""" Preview adapter for Plotly browser. """
+
+adapters = {
+    "soer_miniature": (
+        "eea.plotly.browser.preview_adapter.soer_miniature.serialize"
+    ),
+}
+
+
+def get_preview_adapter(context, name):
+    """ Get the preview adapter for a given name.
+
+    Args:
+        name (str): The name of the preview adapter.
+
+    Returns:
+        class: The preview adapter class if found, otherwise None.
+    """
+    if name in adapters:
+        module_name, func = adapters[name].rsplit(".", 1)
+        module = __import__(module_name, fromlist=[func])
+        return getattr(module, func)(context)
+    return None

eea_plotly-1.4/eea/plotly/browser/preview_adapter/soer_miniature.py

@@ -0,0 +1,79 @@
+""" SOER miniature theme for Plotly visualizations. """
+import math
+
+
+def nice_step(vmin, vmax, target_ticks=5):
+    """ Calculate a 'nice' step size for the axis ticks. """
+    span = abs(vmax - vmin)
+    if span == 0:
+        return 1  # arbitrary fallback
+
+    # Initial guess for raw step size
+    raw_step = span / target_ticks
+
+    # Determine the power of 10
+    magnitude = 10 ** math.floor(math.log10(raw_step))
+    residual = raw_step / magnitude
+
+    # Choose a nice multiplier
+    if residual < 1.5:
+        nice_multiplier = 1
+    elif residual < 3:
+        nice_multiplier = 2
+    elif residual < 7:
+        nice_multiplier = 5
+    else:
+        nice_multiplier = 10
+
+    return nice_multiplier * magnitude
+
+
+def getMin(arr):
+    """ Get minimum value from array """
+    return min(float(v) for v in arr if v is not None)
+
+
+def getMax(arr):
+    """ Get maximum value from array """
+    return max(float(v) for v in arr if v is not None)
+
+
+def serialize(context):
+    """ Serialize the context for SOER miniature theme"""
+
+    # Solve x axis range
+    if context.visualization is None or len(context.visualization["data"]) < 2:
+        return False
+
+    years = context.visualization["data"][0].get("x", [])
+    tickvals = context.visualization["layout"]["xaxis"].get("tickvals", [])
+
+    if tickvals and years:
+        min_year = getMin(tickvals)
+        max_year = getMax(years)
+
+        context.visualization["layout"]["xaxis"]["range"] = [
+            min_year - 2, max_year + 2]
+        context.visualization["layout"]["xaxis"]["autorange"] = False
+
+    # Solve y axis range
+
+    y_values = context.visualization["data"][0].get(
+        "y", []) + context.visualization["data"][1].get("y", [])
+
+    if y_values:
+        min_y = getMin(y_values)
+        max_y = getMax(y_values)
+
+        step = nice_step(min_y, max_y, 10)
+
+        context.visualization["layout"]["yaxis"]["range"] = [
+            min_y - step, max_y + step]
+        context.visualization["layout"]["yaxis"]["autorange"] = False
+
+    if "text" in context.visualization["data"][0]:
+        context.visualization["data"][0]["text"] = [
+            (t if t is None else " " + str(t))
+            for t in context.visualization["data"][0]["text"]]
+
+    return True