Minor revisions for glotzerlab#163

Co-authored-by: Bradley Dice <bdice@bradleydice.com>

Author: javierbg

changelog.txt

@@ -15,7 +15,7 @@ Added
 
 - Improve security on multi-user systems. Dashboard now generates a login token when started. Users
   must login with the token to view project and job data in the dashboard.
-- PlotViewer module for showing interactive plots in the dashboard.
+- PlotViewer module for showing interactive plots in the dashboard (#162, #163).
 
 Changed
 +++++++

signac_dashboard/modules/plot_viewer.py

@@ -13,15 +13,14 @@
 
 
 def plot_viewer_asset(filename):
-    path = f"plot_viewer/{filename}"
     try:
-        return render_template(path)
+        return render_template(f"plot_viewer/{filename}")
     except TemplateNotFound:
         abort(404, "The file requested does not exist.")
 
 
 class PlotViewer(Module):
-    """Displays a plot associated with the job
+    """Displays a plot associated with the job.
 
     The PlotViewer module can display an interactive plot by using the
     Plotly JavaScript library. For information on the different accepted
@@ -42,7 +41,7 @@ def plotly_args_function(project):
                     "x": [1, 2, 3, 4, 5],  # x coordinates of the trace
                     "y": [1, 2, 4, 8, 16]  # y coordinates of the trace
                  }],
-                 {"margin": { "t": 0 } }  # layout specification for the whole plot
+                 {"margin": {"t": 0}}  # layout specification for the whole plot
                 )
             ]
 
@@ -67,7 +66,7 @@ def __init__(
         name="Plot Viewer",
         plotly_args: Callable[
             [Union[Job, Project]], Iterable[Tuple[str, List[Dict], Dict]]
-        ] = lambda _: list(),
+        ] = list,
         context="JobContext",
         template="cards/plot_viewer.html",
         **kwargs,
@@ -88,8 +87,8 @@ def get_cards(self, job_or_project):
                 "content": render_template(
                     self.template,
                     jobid=job_or_project.id,
-                    plotlydata=data,
-                    plotlylayout=layout,
+                    plotly_data=data,
+                    plotly_layout=layout,
                 ),
             }
             for title, data, layout in self.plotly_args(job_or_project)

signac_dashboard/templates/cards/plot_viewer.html

@@ -1,4 +1,4 @@
 <div class="plot_viewer"
-  data-plotlydata='{{ plotlydata | tojson }}'
-  data-plotlylayout='{{ plotlylayout | tojson }}'>
+  data-plotly-data='{{ plotly_data | tojson }}'
+  data-plotly-layout='{{ plotly_layout | tojson }}'>
 </div>

signac_dashboard/templates/plot_viewer/js/plot_viewer.js

@@ -1,6 +1,6 @@
 function draw_plot(element) {
-    data = JSON.parse(element.getAttribute("data-plotlydata"));
-    layout = JSON.parse(element.getAttribute("data-plotlylayout"));
+    data = JSON.parse(element.getAttribute("data-plotly-data"));
+    layout = JSON.parse(element.getAttribute("data-plotly-layout"));
 
     Plotly.newPlot(element, data, layout);
 }