This repository has been archived by the owner on Apr 9, 2024. It is now read-only.
/
_html.py
189 lines (174 loc) · 6.43 KB
/
_html.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
"""An HTML altair saver"""
import json
from typing import Dict, List, Optional
import uuid
import warnings
import altair as alt
from altair_viewer import get_bundled_script
from altair_saver.types import JSONDict, MimebundleContent
from altair_saver.savers import Saver
# This is the basic HTML template for embedding charts on a page.
HTML_TEMPLATE = """
<!DOCTYPE html>
<html>
<head>
<script src="{vega_url}"></script>
<script src="{vegalite_url}"></script>
<script src="{vegaembed_url}"></script>
</head>
<body>
<div class="vega-visualization" id="{output_div}"></div>
<script type="text/javascript">
const spec = {spec};
const embedOpt = {embed_options};
vegaEmbed('#{output_div}', spec, embedOpt).catch(console.error);
</script>
</body>
</html>
"""
# This is like the basic template, but includes vega javascript inline
# so that the resulting file is not dependent on external resources.
INLINE_HTML_TEMPLATE = """
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">
// vega.js v{vega_version}
{vega_script}
// vega-lite.js v{vegalite_version}
{vegalite_script}
// vega-embed.js v{vegaembed_version}
{vegaembed_script}
</script>
</head>
<body>
<div class="vega-visualization" id="{output_div}"></div>
<script type="text/javascript">
const spec = {spec};
const embedOpt = {embed_options};
vegaEmbed('#{output_div}', spec, embedOpt).catch(console.error);
</script>
</body>
</html>
"""
# This is the HTML template that should be used in render(), because it
# will display properly in a variety of notebook environments. It is
# modeled off of Altair's default HTML display.
RENDERER_HTML_TEMPLATE = """
<div class="vega-visualization" id="{output_div}"></div>
<script type="text/javascript">
(function(spec, embedOpt) {{
let outputDiv = document.currentScript.previousElementSibling;
if (outputDiv.id !== "{output_div}") {{
outputDiv = document.getElementById("{output_div}");
}}
const paths = {{
"vega": "{vega_url}?noext",
"vega-lite": "{vegalite_url}?noext",
"vega-embed": "{vegaembed_url}?noext",
}};
function loadScript(lib) {{
return new Promise(function(resolve, reject) {{
var s = document.createElement('script');
s.src = paths[lib];
s.async = true;
s.onload = () => resolve(paths[lib]);
s.onerror = () => reject(`Error loading script: ${{paths[lib]}}`);
document.getElementsByTagName("head")[0].appendChild(s);
}});
}}
function showError(err) {{
outputDiv.innerHTML = `<div class="error" style="color:red;">${{err}}</div>`;
throw err;
}}
function displayChart(vegaEmbed) {{
vegaEmbed(outputDiv, spec, embedOpt)
.catch(err => showError(`Javascript Error: ${{err.message}}<br>This usually means there's a typo in your chart specification. See the javascript console for the full traceback.`));
}}
if (typeof define === "function" && define.amd) {{
requirejs.config({{paths}});
require(["vega-embed"], displayChart, err => showError(`Error loading script: ${{err.message}}`));
}} else if (typeof vegaEmbed === "function") {{
displayChart(vegaEmbed);
}} else {{
loadScript("vega")
.then(() => loadScript("vega-lite"))
.then(() => loadScript("vega-embed"))
.catch(showError)
.then(() => displayChart(vegaEmbed));
}}
}})({spec}, {embed_options});
</script>
"""
CDN_URL = "https://cdn.jsdelivr.net/npm/{package}@{version}"
class HTMLSaver(Saver):
"""Basic chart output."""
valid_formats: Dict[str, List[str]] = {"vega": ["html"], "vega-lite": ["html"]}
_inline: bool
_standalone: Optional[bool]
def __init__(
self,
spec: JSONDict,
mode: Optional[str] = None,
embed_options: Optional[JSONDict] = None,
vega_version: str = alt.VEGA_VERSION,
vegalite_version: str = alt.VEGALITE_VERSION,
vegaembed_version: str = alt.VEGAEMBED_VERSION,
inline: bool = False,
standalone: Optional[bool] = None,
**kwargs,
) -> None:
self._inline = inline
self._standalone = standalone
super().__init__(
spec=spec,
mode=mode,
embed_options=embed_options,
vega_version=vega_version,
vegalite_version=vegalite_version,
vegaembed_version=vegaembed_version,
**kwargs,
)
def _package_url(self, package: str) -> str:
return CDN_URL.format(package=package, version=self._package_versions[package])
def _serialize(self, fmt: str, content_type: str) -> MimebundleContent:
standalone = self._standalone
if standalone is None:
standalone = content_type == "save"
output_div = f"vega-visualization-{uuid.uuid4().hex}"
if not standalone:
if self._inline:
warnings.warn("inline ignored for non-standalone HTML.")
return RENDERER_HTML_TEMPLATE.format(
spec=json.dumps(self._spec),
embed_options=json.dumps(self._embed_options),
vega_url=self._package_url("vega"),
vegalite_url=self._package_url("vega-lite"),
vegaembed_url=self._package_url("vega-embed"),
output_div=output_div,
)
elif self._inline:
return INLINE_HTML_TEMPLATE.format(
spec=json.dumps(self._spec),
embed_options=json.dumps(self._embed_options),
vega_version=self._package_versions["vega"],
vegalite_version=self._package_versions["vega-lite"],
vegaembed_version=self._package_versions["vega-embed"],
vega_script=get_bundled_script("vega", self._package_versions["vega"]),
vegalite_script=get_bundled_script(
"vega-lite", self._package_versions["vega-lite"]
),
vegaembed_script=get_bundled_script(
"vega-embed", self._package_versions["vega-embed"]
),
output_div=output_div,
)
else:
return HTML_TEMPLATE.format(
spec=json.dumps(self._spec),
embed_options=json.dumps(self._embed_options),
vega_url=self._package_url("vega"),
vegalite_url=self._package_url("vega-lite"),
vegaembed_url=self._package_url("vega-embed"),
output_div=output_div,
)