Merge pull request #226 from moj-analytical-services/offline_charts

save offline charts
moj-analytical-services · Nov 3, 2021 · e03bb4a · e03bb4a
2 parents d50e4ac + cf5ae2e
commit e03bb4a
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/splink/charts.py b/splink/charts.py
@@ -1,5 +1,6 @@
 import pkgutil
 import json
+import os
 
 altair_installed = True
 try:
@@ -49,3 +50,23 @@ def _make_json(chart_or_dict):
         return chart_or_dict.to_json(indent=None)
     else:
         return json.dumps(chart_or_dict)
+
+
+def save_offline_chart(altair_chart, filename="my_chart.html", overwrite=False):
+
+    if os.path.isfile(filename) and not overwrite:
+        raise ValueError(
+            f"The path {filename} already exists. Please provide a different path."
+        )
+
+    # get altair chart as json
+    altair_chart_json = _make_json(altair_chart)
+    path = "files/templates/single_chart_template.txt"
+    template = pkgutil.get_data(__name__, path).decode("utf-8")
+
+    fmt_dict = _load_external_libs()
+
+    fmt_dict["mychart"] = _make_json(altair_chart)
+
+    with open(filename, "w") as f:
+        f.write(template.format(**fmt_dict))
diff --git a/splink/files/templates/single_chart_template.txt b/splink/files/templates/single_chart_template.txt
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+<meta charset="utf-8"/>
+  <script>{vega}</script>
+  <script>{vega-lite}</script>
+  <script>{vega-embed}</script>
+  <style>
+    .chart-wrapper  {{
+        height: auto !important
+      }}
+  </style>
+</head>
+
+<body>
+
+
+    <div id="mychart"></div>
+
+
+
+
+  <script type="text/javascript">
+
+    vegaEmbed('#mychart', {mychart}).catch(console.error);
+
+  </script>
+</body>
+
+</html>