Skip to content

Commit fe4e1f7

Browse files
authored
docs: Docs update for 0.13 release (#1031)
Closes #966
1 parent 6899f08 commit fe4e1f7

25 files changed

+2310
-2110
lines changed

CHANGELOG.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,63 @@
11
# Changelog
22

3+
## [0.13.0] - 2025-11-05
4+
5+
### New Features :sparkles:
6+
7+
- feat: Suppress JupyterLab context menu on Map right click by @kylebarron in https://github.com/developmentseed/lonboard/pull/889
8+
- feat: Support two render modes: Standard/deck.gl-first and MapboxOverlay by @kylebarron in https://github.com/developmentseed/lonboard/pull/921
9+
- feat: Create richer `Basemap` class and deprecate `basemap_style` arg by @kylebarron in https://github.com/developmentseed/lonboard/pull/935
10+
- feat: Support globe view by @kylebarron in https://github.com/developmentseed/lonboard/pull/908
11+
- feat: Move `TripsLayer` and `ArcLayer` out of experimental by @kylebarron in https://github.com/developmentseed/lonboard/pull/983
12+
- feat: Support for map controls by @kylebarron in https://github.com/developmentseed/lonboard/pull/924
13+
- feat: Provide default controls for Map by @kylebarron in https://github.com/developmentseed/lonboard/pull/992
14+
- feat: Switch basemap default to overlaid (maplibre-controlled) by @kylebarron in https://github.com/developmentseed/lonboard/pull/993
15+
- feat: H3 layer by @kylebarron in https://github.com/developmentseed/lonboard/pull/917
16+
- feat: Add A5Layer by @kylebarron in https://github.com/developmentseed/lonboard/pull/1001
17+
- feat: Add geohash and s2 layers by @kylebarron in https://github.com/developmentseed/lonboard/pull/1007
18+
- feat: Implement view state validation for non map-view states by @kylebarron in https://github.com/developmentseed/lonboard/pull/1008
19+
- feat: Validate that GlobeView is only used with interleaved basemap mode by @kylebarron in https://github.com/developmentseed/lonboard/pull/1012
20+
- feat: Add view parameter to viz by @kylebarron in https://github.com/developmentseed/lonboard/pull/1013
21+
22+
### Performance improvements :zap:
23+
24+
- perf: use ThreadPoolExecutor for Parquet serialization and bounds computation by @kylebarron in https://github.com/developmentseed/lonboard/pull/902
25+
- perf: Define top-level earcut worker pool by @kylebarron in https://github.com/developmentseed/lonboard/pull/954
26+
- perf: Call np.mean once across axis instead of once per column by @kylebarron in https://github.com/developmentseed/lonboard/pull/995
27+
- perf: Remove typedArrayManager settings override by @kylebarron in https://github.com/developmentseed/lonboard/pull/1003
28+
- perf: Avoid generating str repr of `table` during rendering by @kylebarron in https://github.com/developmentseed/lonboard/pull/1015
29+
30+
### Bug fixes :bug:
31+
32+
- fix: Fix HeatmapLayer by bumping deck.gl to 9.2 by @kylebarron in https://github.com/developmentseed/lonboard/pull/910
33+
- fix: Add `pyarrow` to `geopandas` extra in `pyproject.toml` by @kylebarron in https://github.com/developmentseed/lonboard/pull/970
34+
- fix: Fix "fuzziness" of path layers by removing `useDevicePixels` default by @kylebarron in https://github.com/developmentseed/lonboard/pull/969
35+
- fix: Ensure that the default value of `Map.basemap` is `MaplibreBasemap` if no value of `basemap` was passed. by @kylebarron in https://github.com/developmentseed/lonboard/pull/963
36+
- fix: Restore DataFilterExtension functionality with vectorized accessor input by @kylebarron in https://github.com/developmentseed/lonboard/pull/977
37+
- fix: Fix ArcLayer with numpy coords input by @kylebarron in https://github.com/developmentseed/lonboard/pull/989
38+
- fix: Ensure view state is updated in Python with a maplibre map renderer by @kylebarron in https://github.com/developmentseed/lonboard/pull/1017
39+
- fix: Hack a react re-render on canvas resize by @kylebarron in https://github.com/developmentseed/lonboard/pull/1022
40+
41+
### Documentation :book:
42+
43+
- docs: Fix list rendering in `Map.add_layer` API Docs by @kylebarron in https://github.com/developmentseed/lonboard/pull/952
44+
- docs: Add developer docs about code profiling by @kylebarron in https://github.com/developmentseed/lonboard/pull/1016
45+
46+
### Breaking changes :hammer:
47+
48+
- chore!: Remove deprecated `con` parameter to `viz` by @kylebarron in https://github.com/developmentseed/lonboard/pull/953
49+
50+
### Other changes
51+
52+
- feat: automated UI testing with Playwright by @vgeorge in https://github.com/developmentseed/lonboard/pull/906
53+
- chore: Add eslint import ordering to CI by @kylebarron in https://github.com/developmentseed/lonboard/pull/931
54+
- test: add bbox selection overlay mode e2e test by @vgeorge in https://github.com/developmentseed/lonboard/pull/933
55+
- refactor: Refactor HTML map export by @kylebarron in https://github.com/developmentseed/lonboard/pull/934
56+
- refactor: Refactor model initialization logic by @kylebarron in https://github.com/developmentseed/lonboard/pull/923
57+
- test: add pytest-ipywidgets bbox testing, remove playwright by @vgeorge in https://github.com/developmentseed/lonboard/pull/999
58+
59+
**Full Changelog**: https://github.com/developmentseed/lonboard/compare/v0.12.1...v0.13.0
60+
361
## [0.12.1] - 2025-09-18
462

563
### New Features :sparkles:

DEVELOP.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,24 @@ Note that the `jupyter-mkdocs` plugin is only turned on when the `CI` env variab
8989
CI=true uv run --group docs mkdocs serve
9090
```
9191

92+
## Developing Jupyter Notebook examples
93+
94+
We use `juv` to store dependencies for each notebook as metadata of the notebook itself.
95+
96+
To run an example notebook with a local version of lonboard, first ensure that you have built the JavaScript bundle:
97+
98+
```bash
99+
npm run build:watch
100+
```
101+
102+
then use:
103+
104+
```bash
105+
ANYWIDGET_HMR=1 uvx juv run --with="../" examples/air-traffic-control.ipynb
106+
```
107+
108+
Note that the path in `--with` is relative to the notebook itself.
109+
92110
## Profiling
93111

94112
### Python

docs/api/basemap.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# lonboard.basemap
22

3+
::: lonboard.basemap.MaplibreBasemap
34
::: lonboard.basemap.CartoStyle

docs/api/controls.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
# lonboard.controls
22

3+
::: lonboard.controls.BaseControl
4+
::: lonboard.controls.FullscreenControl
5+
::: lonboard.controls.NavigationControl
6+
::: lonboard.controls.ScaleControl
7+
38
::: lonboard.controls.MultiRangeSlider

docs/api/layers/a5-layer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# A5Layer
2+
3+
::: lonboard.A5Layer
4+
options:
5+
inherited_members: true

docs/api/layers/geohash-layer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# GeohashLayer
2+
3+
::: lonboard.GeohashLayer
4+
options:
5+
inherited_members: true
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# H3HexagonLayer
2+
3+
![](../../assets/kontur-h3.jpg)
4+
5+
> Screenshot from [H3 Population](../../examples/kontur_pop) example
6+
7+
::: lonboard.H3HexagonLayer
8+
options:
9+
inherited_members: true

docs/api/layers/heatmap-layer.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
# HeatmapLayer
22

3-
!!! warning
4-
The `HeatmapLayer` is not currently working.
5-
6-
As of Lonboard v0.10, Lonboard upgraded to version 9.0 of the underlying [deck.gl](https://deck.gl/) library. deck.gl [appears to have a bug](https://github.com/visgl/deck.gl/issues/8960#issuecomment-2284791644) with the HeatmapLayer in 9.0, that has not yet been fixed.
7-
8-
Please temporarily downgrade to Lonboard v0.9 if you would like to use the `HeatmapLayer`.
9-
103
![](../../assets/duckdb-heatmap.jpg)
114

125
> Screenshot from [DuckDB Spatial](../../examples/duckdb) example

docs/api/layers/s2-layer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# S2Layer
2+
3+
::: lonboard.S2Layer
4+
options:
5+
inherited_members: true

docs/api/map.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,9 @@ https://mkdocstrings.github.io/python/usage/configuration/members/#filters
88
group_by_category: false
99
show_bases: false
1010
filters:
11+
12+
::: lonboard.types.map.MapKwargs
13+
options:
14+
group_by_category: false
15+
show_if_no_docstring: true
16+
filters:

0 commit comments

Comments
 (0)