Skip to content

Sources

openlayers.sources

GeoTIFFSource

Bases: Source

GeoTIFF source

Examples:

>>> import ol
>>> geotiff = ol.GeoTIFFSource(sources=[{"url": "https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif"}])
Source code in openlayers/models/sources.py 
29
30
31
32
33
34
35
36
37
38
class GeoTIFFSource(Source):
    """GeoTIFF source

    Examples:
        >>> import ol
        >>> geotiff = ol.GeoTIFFSource(sources=[{"url": "https://s2downloads.eox.at/demo/EOxCloudless/2020/rgbnir/s2cloudless2020-16bits_sinlge-file_z0-4.tif"}])
    """

    normalize: bool | None = None
    sources: list[dict]

ImageTileSource

Bases: Source

Image tile source

Source code in openlayers/models/sources.py 
41
42
43
44
45
46
47
class ImageTileSource(Source):
    """Image tile source"""

    url: str
    attributions: str | None = None
    min_zoom: float | int | None = Field(0, serialization_alias="minZoom")
    max_zoom: float | int | None = Field(20, serialization_alias="maxZoom")

OSM

Bases: Source

OSM source

Source code in openlayers/models/sources.py 
23
24
25
26
class OSM(Source):
    """OSM source"""

    ...

PMTilesRasterSource

Bases: PMTilesVectorSource

PMTiles raster source

Source code in openlayers/models/sources.py 
84
85
86
87
class PMTilesRasterSource(PMTilesVectorSource):
    """PMTiles raster source"""

    tile_size: tuple[int, int] = Field(None, serialization_alias="tileSize")

PMTilesVectorSource

Bases: Source

PMTiles vector source

Source code in openlayers/models/sources.py 
77
78
79
80
81
class PMTilesVectorSource(Source):
    """PMTiles vector source"""

    url: str
    attributions: list[str] = None

TileJSONSource

Bases: ImageTileSource

A source for tile data in TileJSON format

Note

See TileJSON for details.

Source code in openlayers/models/sources.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
class TileJSONSource(ImageTileSource):
    """A source for tile data in TileJSON format

    Note:
        See [TileJSON](https://openlayers.org/en/latest/apidoc/module-ol_source_TileJSON-TileJSON.html) for details.
    """

    tile_size: int | None = Field(None, serialization_alias="tileSize")
    cross_origin: str = Field("anonymous", serialization_alias="crossOrigin")

    @property
    def type(self) -> str:
        return "TileJSON"

VectorSource

Bases: Source

Vector source

Source code in openlayers/models/sources.py 
14
15
16
17
18
19
20
class VectorSource(Source):
    """Vector source"""

    url: str | None = None
    # features: list[dict] | None = None
    geojson: dict | None = Field(None, serialization_alias="@@geojson")
    format: FormatT | dict = GeoJSON()

VectorTileSource

Bases: ImageTileSource

A source for vector data divided into a tile grid

Note

See VectorTile for details.

Source code in openlayers/models/sources.py 
50
51
52
53
54
55
56
57
class VectorTileSource(ImageTileSource):
    """A source for vector data divided into a tile grid

    Note:
        See [VectorTile](https://openlayers.org/en/latest/apidoc/module-ol_source_VectorTile-VectorTile.html) for details.
    """

    ...