Add TileJSON source

Stefan Kuethe · Stefan Kuethe · commit fbe0378ff047 · 2025-05-21T07:56:58.000+02:00
diff --git a/docs/concepts/controls.md b/docs/concepts/controls.md
@@ -1,3 +1,5 @@
+# Controls
+
 Controls are user interface elements that you can add to your map:
 
 ```python
diff --git a/docs/concepts/interactions.md b/docs/concepts/interactions.md
diff --git a/docs/concepts/layers.md b/docs/concepts/layers.md
@@ -24,7 +24,7 @@ Sources state which data the map should display.
 
 ## Styles
 
-Vector layers can be styled with a style object containing properties for _stroke_, _fill_, etc.:
+Vector layers are styled with an object containing properties for the different styles, such as _stroke_, _fill_, _circle_ or _icon_:
 
 ```python
 style = ol.FlatStyle(
diff --git a/docs/examples/concepts/sources.py b/docs/examples/concepts/sources.py
@@ -1,18 +1,14 @@
 import openlayers as ol
 
-geojson = "https://openlayers.org/en/latest/examples/data/geojson/roads-seoul.geojson"
-geotiff = "https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif"
-pmtiles = "https://r2-public.protomaps.com/protomaps-sample-datasets/nz-buildings-v3.pmtiles"
-
 geojson_source = ol.VectorSource(
-    url=geojson
+    url="https://openlayers.org/en/latest/examples/data/geojson/roads-seoul.geojson"
 )
 
 geotiff_source = ol.GeoTIFFSource(
-    sources=[{"url": geotiff}]
+    sources=[{"url": "https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif"}]
 )
 
 pmtiles_source = ol.PMTilesVectorSource(
-    url=pmtiles,
+    url="https://r2-public.protomaps.com/protomaps-sample-datasets/nz-buildings-v3.pmtiles",
     attributions=["© Land Information New Zealand"]
 )
diff --git a/examples/standalone/layers/tilejson_layer.py b/examples/standalone/layers/tilejson_layer.py
@@ -0,0 +1,12 @@
+# See https://openlayers.org/en/latest/examples/tilejson.html
+
+import openlayers as ol
+
+layer = ol.TileLayer(
+    source=ol.TileJSON(
+        url="https://maps.gnosis.earth/ogcapi/collections/NaturalEarth:raster:HYP_HR_SR_OB_DR/map/tiles/WebMercatorQuad?f=tilejson"
+    )
+)
+
+m = ol.Map(layers=[layer])
+m.save()
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -37,6 +37,7 @@ nav:
       - Map: concepts/map.md
       - Controls: concepts/controls.md
       - Layers and sources: concepts/layers.md
+      # - Interactions: concepts/interactions.md
       - GeoPandas: concepts/geopandas.md
   - API documentation:
       - Map: api/map.md
diff --git a/src/openlayers/anywidget.py b/src/openlayers/anywidget.py
@@ -31,7 +31,7 @@ class MapWidget(Map, AnyWidget):
 
     # TODO: Move to features as well
     # features_selected = traitlets.List().tag(sync=True)
-    
+
     features = traitlets.Dict().tag(sync=True)
 
     def __init__(
diff --git a/src/openlayers/controls.py b/src/openlayers/controls.py
@@ -12,7 +12,7 @@
     ZoomControl,
     RotateControl,
     ZoomToExtentControl,
-    DrawControl
+    DrawControl,
 )
 
 __all__ = [
@@ -22,5 +22,5 @@
     "ScaleLineControl",
     "ZoomSliderControl",
     "MousePositionControl",
-    "DrawControl"
+    "DrawControl",
 ]
diff --git a/src/openlayers/export.py b/src/openlayers/export.py
@@ -24,7 +24,7 @@ def write_file(content: str, path: Path | str = None) -> str:
     if path:
         with open(path, "w") as f:
             f.write(content)
-        
+
         return path
 
     fd, path = tempfile.mkstemp(prefix="ol_")
diff --git a/src/openlayers/js/openlayers.anywidget.js b/src/openlayers/js/openlayers.anywidget.js
diff --git a/src/openlayers/js/openlayers.standalone.js b/src/openlayers/js/openlayers.standalone.js
diff --git a/src/openlayers/layers.py b/src/openlayers/layers.py
@@ -21,5 +21,5 @@
     "BasemapLayer",
     "VectorTileLayer",
     "WebGLVectorTileLayer",
-    "VectorImageLayer"
+    "VectorImageLayer",
 ]
diff --git a/src/openlayers/models/layers.py b/src/openlayers/models/layers.py
@@ -13,6 +13,7 @@
 # --- Base layer
 class Layer(OLBaseModel):
     """A base class for creating OL layers"""
+
     id: str | None = None
     source: dict | SourceT
     background: str | None = None
@@ -42,10 +43,12 @@ def validate_style(cls, v):
 
         return v
 
+
 # TODO: Inherit from `VectorTileLayer`
 class VectorLayer(VectorTileLayer):
     """A layer for rendering vector sources"""
-    #style: dict | FlatStyle | None = default_style()
+
+    # style: dict | FlatStyle | None = default_style()
     fit_bounds: bool = Field(False, serialization_alias="fitBounds")
 
     """
@@ -57,20 +60,23 @@ def validate_style(cls, v):
         return v
     """
 
+
 class VectorImageLayer(VectorLayer):
     """A layer for rendering vector sources
-    
+
     This layer type provides great performance during panning and zooming,
     but point symbols and texts are always rotated with the view and pixels are scaled during zoom animations.
-    
+
     Note:
         See also [VectorImageLayer](https://openlayers.org/en/latest/apidoc/module-ol_layer_VectorImage-VectorImageLayer.html)
     """
+
     image_ratio: int | None = Field(None, serialization_alias="imageRatio")
 
 
 class WebGLVectorLayer(VectorLayer):
     """A layer for rendering vector sources using WebGL"""
+
     ...
 
 
@@ -91,5 +97,5 @@ class WebGLTileLayer(Layer):
     WebGLTileLayer,
     VectorTileLayer,
     WebGLVectorTileLayer,
-    VectorImageLayer
+    VectorImageLayer,
 ]
diff --git a/src/openlayers/models/sources.py b/src/openlayers/models/sources.py
@@ -34,14 +34,10 @@ class ImageTileSource(Source):
 
 
 class VectorTileSource(ImageTileSource): ...
-"""
-const vectorLayer = new VectorTile({
-  declutter: true,
-  source: new PMTilesVectorSource({
-    url: "https://r2-public.protomaps.com/protomaps-sample-datasets/nz-buildings-v3.pmtiles",
-    attributions: ["© Land Information New Zealand"],
-  }),
-"""
+
+
+class TileJSON(ImageTileSource):
+    cross_origin: str = Field("anonymous", serialization_alias="crossOrigin")
 
 
 # PMTiles extension
@@ -62,6 +58,7 @@ class PMTilesRasterSource(PMTilesVectorSource):
     GeoTIFFSource,
     ImageTileSource,
     ImageTileSource,
+    TileJSON,
     PMTilesVectorSource,
     PMTilesRasterSource,
 ]
diff --git a/src/openlayers/sources.py b/src/openlayers/sources.py
@@ -8,7 +8,16 @@
     SourceT,
     VectorSource,
     VectorTileSource,
-    PMTilesVectorSource
+    TileJSON,
+    PMTilesVectorSource,
 )
 
-__all__ = ["OSM", "GeoTIFFSource", "VectorSource", "ImageTileSource", "PMTilesVectorSource"]
+__all__ = [
+    "OSM",
+    "GeoTIFFSource",
+    "VectorSource",
+    "ImageTileSource",
+    "VectorTileSource",
+    "TileJSON",
+    "PMTilesVectorSource",
+]
diff --git a/srcjs/ipywidget-ts/sources.ts b/srcjs/ipywidget-ts/sources.ts
@@ -3,6 +3,7 @@ import VectorSource from "ol/source/Vector";
 import VectorTileSource from 'ol/source/VectorTile.js';
 import GeoTIFFSource from 'ol/source/GeoTIFF.js';
 import ImageTileSource from "ol/source/ImageTile";
+import TileJSON from 'ol/source/TileJSON.js';
 import { PMTilesVectorSource, PMTilesRasterSource } from "ol-pmtiles";
 
 const sourceCatalog: SourceCatalog = {
@@ -12,6 +13,7 @@ const sourceCatalog: SourceCatalog = {
     GeoTIFFSource: GeoTIFFSource,
     GeoJSONSource: VectorSource,
     ImageTileSource: ImageTileSource,
+    TileJSON: TileJSON,
     PMTilesVectorSource: PMTilesVectorSource,
     PMTilesRasterSource: PMTilesRasterSource
 };

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Controls`
	`2`	`+`
`1`	`3`	`Controls are user interface elements that you can add to your map:`
`2`	`4`
`3`	`5`	```python
Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,14 @@`
`1`	`1`	`import openlayers as ol`
`2`	`2`
`3`		`-geojson = "https://openlayers.org/en/latest/examples/data/geojson/roads-seoul.geojson"`
`4`		`-geotiff = "https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif"`
`5`		`-pmtiles = "https://r2-public.protomaps.com/protomaps-sample-datasets/nz-buildings-v3.pmtiles"`
`6`		`-`
`7`	`3`	`geojson_source = ol.VectorSource(`
`8`		`- url=geojson`
	`4`	`+ url="https://openlayers.org/en/latest/examples/data/geojson/roads-seoul.geojson"`
`9`	`5`	`)`
`10`	`6`
`11`	`7`	`geotiff_source = ol.GeoTIFFSource(`
`12`		`- sources=[{"url": geotiff}]`
	`8`	`+ sources=[{"url": "https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif"}]`
`13`	`9`	`)`
`14`	`10`
`15`	`11`	`pmtiles_source = ol.PMTilesVectorSource(`
`16`		`- url=pmtiles,`
	`12`	`+ url="https://r2-public.protomaps.com/protomaps-sample-datasets/nz-buildings-v3.pmtiles",`
`17`	`13`	`attributions=["© Land Information New Zealand"]`
`18`	`14`	`)`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`ZoomControl,`
`13`	`13`	`RotateControl,`
`14`	`14`	`ZoomToExtentControl,`
`15`		`- DrawControl`
	`15`	`+ DrawControl,`
`16`	`16`	`)`
`17`	`17`
`18`	`18`	`__all__ = [`
`@@ -22,5 +22,5 @@`
`22`	`22`	`"ScaleLineControl",`
`23`	`23`	`"ZoomSliderControl",`
`24`	`24`	`"MousePositionControl",`
`25`		`- "DrawControl"`
	`25`	`+ "DrawControl",`
`26`	`26`	`]`