Merge pull request #2740 from KS-HTK/issues/plotly-markers

Updated docs for plotly

Author: vogt31337

doc/plotting/plotly/plotly.rst

@@ -6,27 +6,17 @@ pandapower provides interactive network plots using `Plotly <https://plot.ly/pyt
 These plots are built with arguments and functionalities to be as much as possible analogous with pandapower's
 matlpotlib plotting library.
 There is a functionality to translate pandapower network elements into plotly collections (traces).
-The different collections for lines, buses or transformers can than be drawn.
+The different collections for lines, buses or transformers can then be drawn.
 
 In order to get idea about interactive plot features and possibilities see the `tutorial <http://nbviewer.jupyter.org/github/e2nIEE/pandapower/blob/develop/tutorials/plotly_built-in.ipynb>`_.
 
-
 If a network has geocoordinates, there is a possibility to represent interactive plots on `MapLibre <https://maplibre.org/>`_ maps.
 
 .. note::
 
-    Plots on MapLibre maps are free.
-    Previously Plotly library used `Mapbox <https://www.mapbox.com/>`_ services which were working 
-    only considering you have a Mapbox account and a `Mapbox Access Token <https://www.mapbox.com/studio>`_.
-    
-    In previous pandapower versions (until v3.1.3) there was a functionality to 
-    set and get a Mapbox token in pandapower.
-    After getting a mapbox token it can be set to pandapower as the following ::
-
-        from pandapower.plotting.plotly.mapbox_plot import set_mapbox_token
-        set_mapbox_token('<token>')
-
-    This functionality is still working but deprecated and useless in future 
+    Previously Plotly library used `Mapbox <https://www.mapbox.com/>`_ services which required
+    a Mapbox account and a `Mapbox Access Token <https://www.mapbox.com/studio>`_.
+    Setting and getting the token is deprecated and will be removed in a future
     pandapower releases.
 
 .. toctree::

pandapower/plotting/plotly/mapbox_plot.py

@@ -3,13 +3,8 @@
 # Copyright (c) 2016-2023 by University of Kassel and Fraunhofer Institute for Energy Economics
 # and Energy System Technology (IEE), Kassel. All rights reserved.
 
-
 import os
-
 from typing_extensions import deprecated
-
-from pandapower.plotting.geo import convert_crs
-
 import logging
 
 logger = logging.getLogger(__name__)

pandapower/plotting/plotly/simple_plotly.py

@@ -317,7 +317,8 @@ def _simple_plotly_generic(net, respect_separators, use_branch_geodata, branch_w
     # get external grid from _create_node_trace
     if 'ext_grid' in net and len(net.ext_grid):
         marker_type = 'circle' if settings['on_map'] else 'square'  # better would be square-x
-        # FIXME: workaround because doesn't appear on mapbox if square
+        # FIXME: if on_map only maki 2.1 Icons are supported as patch_type due to plotly using them.
+        #  Only the circle can be colored and scaled. https://github.com/plotly/plotly.js/issues/6599
         hoverinfo = hoverinfo_func(net, element="ext_grid")
         ext_grid_trace = _create_node_trace(
             net,

pandapower/plotting/plotly/traces.py

@@ -97,9 +97,20 @@ def create_edge_center_trace(line_trace, size=1, patch_type="circle", color="whi
     """
     # color = get_plotly_color(color)
 
-    center_trace = dict(type='scatter', text=[], mode='markers', hoverinfo='text', name=trace_name,
-                        marker=dict(color=color, size=size, symbol=patch_type),
-                        showlegend=showlegend, legendgroup=legendgroup)
+    center_trace = {
+        "type": 'scatter',
+        "text": [],
+        "mode": 'markers',
+        "hoverinfo": 'text',
+        "name": trace_name,
+        "marker": {
+            "color": color,
+            "size": size,
+            "symbol": patch_type
+        },
+        "showlegend": showlegend,
+        "legendgroup": legendgroup
+    }
     if hoverlabel is not None:
         center_trace.update({'hoverlabel': hoverlabel})
 
@@ -141,7 +152,8 @@ def create_bus_trace(net, buses=None, size=5, patch_type="circle", color="blue",
                 - "circle" for a circle
                 - "square" for a rectangle
                 - "diamond" for a diamond
-                - much more patch types at https://plot.ly/python/reference/#scatter-marker
+                - all types for plots at https://plotly.com/python/reference/#scatter-marker-symbol
+                - all types for maps at https://plotly.com/python/reference/#scatter-marker-symbol
 
         **infofunc** (pd.Series, None) - hoverinfo for bus elements. Indices should correspond to
         the pandapower element indices
@@ -248,8 +260,18 @@ def _create_node_trace(net, nodes=None, size=5, patch_type='circle', color='blue
     if not PLOTLY_INSTALLED:
         soft_dependency_error(str(sys._getframe().f_code.co_name) + "()", "plotly")
     color = get_plotly_color(color)
-    node_trace = dict(type='scatter', text=[], mode='markers', hoverinfo='text', name=trace_name,
-                      marker=dict(color=color, size=size, symbol=patch_type))
+    node_trace = {
+        "type": 'scatter',
+        "text": [],
+        "mode": 'markers',
+        "hoverinfo": 'text',
+        "name": trace_name,
+        "marker": {
+            "color": color,
+            "size": size,
+            "symbol": patch_type
+        }
+    }
     nodes = net[node_element].index.tolist() if nodes is None else list(nodes)
     node_plot_index = [b for b in nodes if b in list(set(nodes) & set(net[node_element]["geo"].index))]
     node_trace['x'], node_trace['y'] = zip(*net[node_element].loc[node_plot_index, 'geo'].dropna().apply(geojson.loads).apply(geojson.utils.coords).apply(next).to_list())
@@ -262,7 +284,7 @@ def _create_node_trace(net, nodes=None, size=5, patch_type='circle', color='blue
         node_trace['legendgroup'] = legendgroup
     # if color map is set
     if cmap is not None:
-        # TODO introduce discrete colormaps (see contour plots in plotly)
+        # TODO: introduce discrete colormaps (see contour plots in plotly)
         # if cmap_vals are not given
 
         cmap = 'Jet' if cmap is True else cmap
@@ -598,7 +620,7 @@ def _create_branch_trace(net, branches=None, use_branch_geodata=True, respect_se
     if cmap is not None:
         # workaround: if colormap plot is used, each line need to be separate scatter object because
         # plotly still doesn't support appropriately colormap for line objects
-        # TODO correct this when plotly solves existing github issue about Line colorbar
+        # TODO: correct this when plotly solves existing github issue about Line colorbar
 
         cmap = 'jet' if cmap is True else cmap
 
@@ -1114,8 +1136,8 @@ def draw_traces(traces, on_map=False, map_style='basic', showlegend=True, figsiz
                 trace['lat'] = trace.pop('y')
             trace['type'] = 'scattermap'
             if "line" in trace and isinstance(trace["line"], Line):
-                # scattermapboxplot lines do not support dash for some reason, make it a red line instead
-                # --> maybe Dash is working now ? 
+                # scattermap plot lines do not support dash for some reason, make it a red line instead
+                # TODO: maybe Dash is working now?
                 if "dash" in trace["line"]._props:
                     _prps = dict(trace["line"]._props)
                     _prps.pop("dash")