Skip to content

new vega lite version #1525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 9, 2022
Merged

new vega lite version #1525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
42ba154
new vega lite version
Nov 2, 2021
bdef957
adding support for vega-lite v5. modify the tests for checking
williambdean Feb 18, 2022
0183c7b
following the stickler-ci comments
williambdean Feb 18, 2022
414a5c5
returning int. Using None type instead
williambdean Feb 18, 2022
3899eb6
since v1 has its own format
williambdean Feb 18, 2022
1cf09d8
Merge remote-tracking branch 'upstream/main' into pr/1525
Conengmo Nov 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 33 additions & 20 deletions folium/features.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,6 @@ def __init__(self, data, width=None, height=None,

def render(self, **kwargs):
"""Renders the HTML representation of the element."""
vegalite_major_version = self._get_vegalite_major_versions(self.data)

self._parent.html.add_child(Element(Template("""
<div id="{{this.get_name()}}"></div>
""").render(this=self, kwargs=kwargs)), name=self.get_name())
Expand All @@ -251,25 +249,40 @@ def render(self, **kwargs):
</style>
""").render(this=self, **kwargs)), name=self.get_name())

if vegalite_major_version == '1':
self._embed_vegalite_v1(figure)
elif vegalite_major_version == '2':
self._embed_vegalite_v2(figure)
elif vegalite_major_version == '3':
self._embed_vegalite_v3(figure)
else:
# Version 2 is assumed as the default, if no version is given in the schema.
self._embed_vegalite_v2(figure)

def _get_vegalite_major_versions(self, spec):
try:
schema = spec['$schema']
except KeyError:
major_version = None
else:
major_version = schema.split('/')[-1].split('.')[0].lstrip('v')
embed_mapping = {
1: self._embed_vegalite_v1,
2: self._embed_vegalite_v2,
3: self._embed_vegalite_v3,
4: self._embed_vegalite_v4,
5: self._embed_vegalite_v5,
}

# Version 2 is assumed as the default, if no version is given in the schema.
embed_vegalite = embed_mapping.get(self.vegalite_major_version, self._embed_vegalite_v2)
embed_vegalite(figure)

@property
def vegalite_major_version(self) -> int:
if '$schema' not in self.data:
return None

schema = self.data['$schema']

return int(schema.split('/')[-1].split('.')[0].lstrip('v'))

def _embed_vegalite_v5(self, figure):
self._vega_embed()

figure.header.add_child(JavascriptLink('https://cdn.jsdelivr.net/npm//vega@5'), name='vega')
figure.header.add_child(JavascriptLink('https://cdn.jsdelivr.net/npm/vega-lite@5'), name='vega-lite')
figure.header.add_child(JavascriptLink('https://cdn.jsdelivr.net/npm/vega-embed@6'), name='vega-embed')

def _embed_vegalite_v4(self, figure):
self._vega_embed()

return major_version
figure.header.add_child(JavascriptLink('https://cdn.jsdelivr.net/npm//vega@5'), name='vega')
figure.header.add_child(JavascriptLink('https://cdn.jsdelivr.net/npm/vega-lite@4'), name='vega-lite')
figure.header.add_child(JavascriptLink('https://cdn.jsdelivr.net/npm/vega-embed@6'), name='vega-embed')

def _embed_vegalite_v3(self, figure):
self._vega_embed()
Expand Down
127 changes: 39 additions & 88 deletions tests/test_features.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
import os
import warnings

import json

from branca.element import Element

import folium
Expand Down Expand Up @@ -114,94 +116,43 @@ def test_color_line():
m._repr_html_()


def test_get_vegalite_major_version():
spec_v2 = {'$schema': 'https://vega.github.io/schema/vega-lite/v2.6.0.json',
'config': {'view': {'height': 300, 'width': 400}},
'data': {'name': 'data-aac17e868e23f98b5e0830d45504be45'},
'datasets': {'data-aac17e868e23f98b5e0830d45504be45': [{'folium usage': 0,
'happiness': 1.0},
{'folium usage': 1,
'happiness': 2.718281828459045},
{'folium usage': 2,
'happiness': 7.38905609893065},
{'folium usage': 3,
'happiness': 20.085536923187668},
{'folium usage': 4,
'happiness': 54.598150033144236},
{'folium usage': 5,
'happiness': 148.4131591025766},
{'folium usage': 6,
'happiness': 403.4287934927351},
{'folium usage': 7,
'happiness': 1096.6331584284585},
{'folium usage': 8,
'happiness': 2980.9579870417283},
{'folium usage': 9,
'happiness': 8103.083927575384}]},
'encoding': {'x': {'field': 'folium usage', 'type': 'quantitative'},
'y': {'field': 'happiness', 'type': 'quantitative'}},
'mark': 'point'}

vegalite_v2 = folium.features.VegaLite(spec_v2)

assert vegalite_v2._get_vegalite_major_versions(spec_v2) == '2'

spec_v1 = {'$schema': 'https://vega.github.io/schema/vega-lite/v1.3.1.json',
'data': {'values': [{'folium usage': 0, 'happiness': 1.0},
{'folium usage': 1, 'happiness': 2.718281828459045},
{'folium usage': 2, 'happiness': 7.38905609893065},
{'folium usage': 3, 'happiness': 20.085536923187668},
{'folium usage': 4, 'happiness': 54.598150033144236},
{'folium usage': 5, 'happiness': 148.4131591025766},
{'folium usage': 6, 'happiness': 403.4287934927351},
{'folium usage': 7, 'happiness': 1096.6331584284585},
{'folium usage': 8, 'happiness': 2980.9579870417283},
{'folium usage': 9, 'happiness': 8103.083927575384}]},
'encoding': {'x': {'field': 'folium usage', 'type': 'quantitative'},
'y': {'field': 'happiness', 'type': 'quantitative'}},
'height': 300,
'mark': 'point',
'width': 400}

vegalite_v1 = folium.features.VegaLite(spec_v1)

assert vegalite_v1._get_vegalite_major_versions(spec_v1) == '1'

spec_no_version = {
'config': {
'view': {'height': 300, 'width': 400}},
'data': {'name': 'data-aac17e868e23f98b5e0830d45504be45'},
'datasets': {
'data-aac17e868e23f98b5e0830d45504be45': [
{'folium usage': 0,
'happiness': 1.0},
{'folium usage': 1,
'happiness': 2.718281828459045},
{'folium usage': 2,
'happiness': 7.38905609893065},
{'folium usage': 3,
'happiness': 20.085536923187668},
{'folium usage': 4,
'happiness': 54.598150033144236},
{'folium usage': 5,
'happiness': 148.4131591025766},
{'folium usage': 6,
'happiness': 403.4287934927351},
{'folium usage': 7,
'happiness': 1096.6331584284585},
{'folium usage': 8,
'happiness': 2980.9579870417283},
{'folium usage': 9,
'happiness': 8103.083927575384}]},
'encoding': {'x': {'field': 'folium usage', 'type': 'quantitative'},
'y': {'field': 'happiness', 'type': 'quantitative'}},
'mark': 'point'
}

vegalite_no_version = folium.features.VegaLite(spec_no_version)

assert vegalite_no_version._get_vegalite_major_versions(spec_no_version) is None

@pytest.fixture
def vegalite_spec(version):
file_version = 'v1' if version == 1 else 'vlater'
file = os.path.join(rootpath, 'vegalite_data', f'vegalite_{file_version}.json')

if not os.path.exists(file):
raise FileNotFoundError(f'The vegalite data {file} does not exist.')

with open(file, 'r') as f:
spec = json.load(f)

if version is None or '$schema' in spec:
return spec

# Sample versions that might show up
schema_version = {
2: 'v2.6.0',
3: 'v3.6.0',
4: 'v4.6.0',
5: 'v5.1.0'
}[version]
spec['$schema'] = f'https://vega.github.io/schema/vega-lite/{schema_version}.json'

return spec


@pytest.mark.parametrize(
'version',
[1, 2, 3, 4, 5, None]
)
def test_vegalite_major_version(vegalite_spec, version):
vegalite = folium.features.VegaLite(vegalite_spec)

if version is None:
assert vegalite.vegalite_major_version is None
else:
assert vegalite.vegalite_major_version == version

# GeoJsonTooltip GeometryCollection
def test_geojson_tooltip():
Expand Down
60 changes: 60 additions & 0 deletions tests/vegalite_data/vegalite_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
{
"$schema": "https://vega.github.io/schema/vega-lite/v1.3.1.json",
"data": {
"values": [
{
"folium usage": 0,
"happiness": 1
},
{
"folium usage": 1,
"happiness": 2.718281828459045
},
{
"folium usage": 2,
"happiness": 7.38905609893065
},
{
"folium usage": 3,
"happiness": 20.085536923187668
},
{
"folium usage": 4,
"happiness": 54.598150033144236
},
{
"folium usage": 5,
"happiness": 148.4131591025766
},
{
"folium usage": 6,
"happiness": 403.4287934927351
},
{
"folium usage": 7,
"happiness": 1096.6331584284585
},
{
"folium usage": 8,
"happiness": 2980.9579870417283
},
{
"folium usage": 9,
"happiness": 8103.083927575384
}
]
},
"encoding": {
"x": {
"field": "folium usage",
"type": "quantitative"
},
"y": {
"field": "happiness",
"type": "quantitative"
}
},
"height": 300,
"mark": "point",
"width": 400
}
66 changes: 66 additions & 0 deletions tests/vegalite_data/vegalite_vlater.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
{
"config": {
"view": {
"height": 300,
"width": 400
}
},
"data": {
"name": "data-aac17e868e23f98b5e0830d45504be45"
},
"datasets": {
"data-aac17e868e23f98b5e0830d45504be45": [
{
"folium usage": 0,
"happiness": 1
},
{
"folium usage": 1,
"happiness": 2.718281828459045
},
{
"folium usage": 2,
"happiness": 7.38905609893065
},
{
"folium usage": 3,
"happiness": 20.085536923187668
},
{
"folium usage": 4,
"happiness": 54.598150033144236
},
{
"folium usage": 5,
"happiness": 148.4131591025766
},
{
"folium usage": 6,
"happiness": 403.4287934927351
},
{
"folium usage": 7,
"happiness": 1096.6331584284585
},
{
"folium usage": 8,
"happiness": 2980.9579870417283
},
{
"folium usage": 9,
"happiness": 8103.083927575384
}
]
},
"encoding": {
"x": {
"field": "folium usage",
"type": "quantitative"
},
"y": {
"field": "happiness",
"type": "quantitative"
}
},
"mark": "point"
}