Commit 1548ee5

authored

feat: Add view parameter to viz (#1013)

### Change list - Allow passing `view="globe"` parameter to `viz` - Render in interleaved maplibre basemap by default - When using a known basemap style with labels, render layers underneath labels

1 parent b99243d commit 1548ee5Copy full SHA for 1548ee5

File tree

3 files changed

+38

-5

lines changed

lonboard
- _map.py
- _viz.py
tests
- test_map.py

3 files changed

+38

-5

lines changed

`‎lonboard/_map.py‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -718,7 +718,7 @@ def as_html(self) -> HTML:`
`718`	`718`
`719`	`719`	`@t.default("view_state")`
`720`	`720`	`def _default_initial_view_state(self) -> dict[str, Any]:`
`721`		`- if isinstance(self.view, (MapView, GlobeView)):`
	`721`	`+ if self.viewisNoneorisinstance(self.view, (MapView, GlobeView)):`
`722`	`722`	`return compute_view(self.layers) # type: ignore`
`723`	`723`
`724`	`724`	`return {}`

`‎lonboard/_viz.py‎`

Lines changed: 24 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`import json`
`8`	`8`	`from textwrap import dedent`
`9`		`-from typing import TYPE_CHECKING, Any, Protocol, TypeAlias, cast`
	`9`	`+from typing import TYPE_CHECKING, Any, Literal, Protocol, TypeAlias, cast`
`10`	`10`
`11`	`11`	`import numpy as np`
`12`	`12`	`from arro3.core import Array, ChunkedArray, Schema, Table, struct_field`
`@@ -26,6 +26,7 @@`
`26`	`26`	`)`
`27`	`27`	`from lonboard.basemap import CartoStyle, MaplibreBasemap`
`28`	`28`	`from lonboard.layer import PathLayer, PolygonLayer, ScatterplotLayer`
	`29`	`+from lonboard.view import BaseView, GlobeView`
`29`	`30`
`30`	`31`	`if TYPE_CHECKING:`
`31`	`32`	`import duckdb`
`@@ -81,13 +82,14 @@ def __geo_interface__(self) -> dict: ...`
`81`	`82`	`DEFAULT_POLYGON_LINE_COLOR = [0, 0, 0, 200]`
`82`	`83`
`83`	`84`
`84`		`-def viz(`
	`85`	`+def viz(# noqa: PLR0913`
`85`	`86`	`data: VizDataInput \| list[VizDataInput] \| tuple[VizDataInput, ...],`
`86`	`87`	`*,`
`87`	`88`	`scatterplot_kwargs: ScatterplotLayerKwargs \| None = None,`
`88`	`89`	`path_kwargs: PathLayerKwargs \| None = None,`
`89`	`90`	`polygon_kwargs: PolygonLayerKwargs \| None = None,`
`90`	`91`	`map_kwargs: MapKwargs \| None = None,`
	`92`	`+ view: BaseView \| Literal["globe"] \| None = None,`
`91`	`93`	`) -> Map:`
`92`	`94`	`"""Plot your data easily.`
`93`	`95`
`@@ -165,6 +167,7 @@ def viz(`
`165`	`167`	[`PolygonLayer`][lonboard.PolygonLayer]s.
`166`	`168`	map_kwargs: a `dict` of parameters to pass down to the generated
`167`	`169`	[`Map`][lonboard.Map].
	`170`	`+ view: a [view instance][lonboard.view.BaseView] to use for the map view, or the string "globe".`
`168`	`171`
`169`	`172`	For more control over rendering, construct [`Map`][lonboard.Map] and `Layer` objects
`170`	`173`	`directly.`
`@@ -200,8 +203,26 @@ def viz(`
`200`	`203`
`201`	`204`	`map_kwargs = map_kwargs if map_kwargs else {}`
`202`	`205`
	`206`	`+ if "view" not in map_kwargs and view is not None:`
	`207`	`+ if view == "globe":`
	`208`	`+ map_kwargs["view"] = GlobeView()`
	`209`	`+ else:`
	`210`	`+ map_kwargs["view"] = view`
	`211`	`+`
`203`	`212`	`if "basemap_style" not in map_kwargs and "basemap" not in map_kwargs:`
`204`		`- map_kwargs["basemap"] = MaplibreBasemap(style=CartoStyle.DarkMatter)`
	`213`	`+ map_kwargs["basemap"] = MaplibreBasemap(`
	`214`	`+ mode="interleaved",`
	`215`	`+ style=CartoStyle.DarkMatter,`
	`216`	`+ )`
	`217`	`+`
	`218`	`+ # If we're using a known style that has labels, set layers to be below labels`
	`219`	`+ if map_kwargs["basemap"].style in [`
	`220`	`+ CartoStyle.DarkMatter,`
	`221`	`+ CartoStyle.Positron,`
	`222`	`+ CartoStyle.Voyager,`
	`223`	`+ ]:`
	`224`	`+ for layer in layers:`
	`225`	`+ layer.before_id = "watername_ocean"`
`205`	`226`
`206`	`227`	`return Map(layers=layers, **map_kwargs)`
`207`	`228`

`‎tests/test_map.py‎`

Lines changed: 13 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
	`1`	`+import geopandas as gpd`
`1`	`2`	`import pytest`
	`3`	`+from geodatasets import get_path`
`2`	`4`	`from traitlets import TraitError`
`3`	`5`
`4`		`-from lonboard import Map, ScatterplotLayer, SolidPolygonLayer`
	`6`	`+from lonboard import Map, ScatterplotLayer, SolidPolygonLayer, viz`
`5`	`7`	`from lonboard.basemap import MaplibreBasemap`
`6`	`8`	`from lonboard.view import FirstPersonView, GlobeView, OrthographicView`
`7`	`9`	`from lonboard.view_state import (`
`@@ -182,3 +184,13 @@ def test_map_view_validate_globe_view_basemap():`
`182`	`184`	`match=r"GlobeView requires the basemap mode to be 'interleaved'.",`
`183`	`185`	`):`
`184`	`186`	`m.view = GlobeView()`
	`187`	`+`
	`188`	`+`
	`189`	`+def test_default_view_state_inferred():`
	`190`	`+ gdf = gpd.read_file(get_path("nybb"))`
	`191`	`+ m = viz(gdf)`
	`192`	`+ view_state = m.view_state`
	`193`	`+ assert isinstance(view_state, MapViewState)`
	`194`	`+ assert view_state.longitude - (-73.90) < 1e-2`
	`195`	`+ assert view_state.latitude - 40.67 < 1e-2`
	`196`	`+ assert view_state.zoom == 9`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 1548ee5

File tree

3 files changed

3 files changed

`‎lonboard/_map.py‎`

`‎lonboard/_viz.py‎`

`‎tests/test_map.py‎`

0 commit comments