Skip to content
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

Improve the MapLibre to_html method #797

Merged
merged 2 commits into from
Jun 30, 2024
Merged

Improve the MapLibre to_html method #797

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92c73c8
Improve the MapLibre to_html method
giswqs Jun 30, 2024
4b706fb
Fix to_html api key bug
giswqs Jun 30, 2024
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
44 changes: 39 additions & 5 deletions leafmap/maplibregl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1149,18 +1149,28 @@ def add_raster(

def to_html(
self,
title: str = "Map",
width: str = "100%",
height: str = "880px",
output: str = None,
title: str = "Leafmap",
width: str = "100%",
height: str = "100%",
replace_key: bool = True,
preview: bool = False,
**kwargs,
):
"""Render the map to an HTML page.

Args:
title (str, optional): The title of the HTML page. Defaults to 'Map'.
output (str, optional): The output HTML file. If None, the HTML content
is returned as a string. Defaults
title (str, optional): The title of the HTML page. Defaults to 'Leafmap'.
width (str, optional): The width of the map. Defaults to '100%'.
height (str, optional): The height of the map. Defaults to '880px'.
height (str, optional): The height of the map. Defaults to '100%'.
replace_key (bool, optional): Whether to replace the API key in the HTML.
If True, the API key is replaced with the public API key.
The API key is read from the environment variable `MAPTILER_KEY`.
The public API key is read from the environment variable `MAPTILER_KEY_PUBLIC`.
Defaults to True.
preview (bool, optional): Whether to preview the HTML file in a web browser.
**kwargs: Additional keyword arguments that are passed to the
`maplibre.ipywidget.MapWidget.to_html()` method.

Expand All @@ -1173,9 +1183,33 @@ def to_html(
else:
kwargs["style"] += f"width: {width}; height: {height};"
html = super().to_html(title=title, **kwargs)

if isinstance(height, str) and "%" in height:
style_before = """</style>\n<body>"""
style_after = (
"""html, body {height: 100%; margin: 0; padding: 0;} #pymaplibregl {width: 100%; height: """
+ height
+ """;}\n</style>\n<body>"""
)
html = html.replace(style_before, style_after)

div_before = f"""<div id="pymaplibregl" style="width: 100%; height: {height};"></div>"""
div_after = f"""<div id="pymaplibregl"></div>"""
html = html.replace(div_before, div_after)

if replace_key:
key_before = get_api_key("MAPTILER_KEY")
key_after = get_api_key("MAPTILER_KEY_PUBLIC")
if key_after is not None:
html = html.replace(key_before, key_after)

if output:
with open(output, "w") as f:
f.write(html)
if preview:
import webbrowser

webbrowser.open(output)
else:
return html

Expand Down
Loading