Skip to content

Layers

openlayers.layers.Layer

Bases: OLBaseModel

A base class for creating OL layers

Source code in openlayers/models/layers.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class Layer(OLBaseModel):
    """A base class for creating OL layers"""

    id: str | None = None
    source: dict | SourceT
    background: str | None = None
    opacity: float | None = 1.0
    visible: bool | None = True
    z_index: int | None = Field(None, serialization_alias="zIndex")

    @field_validator("id")
    def validate_id(cls, v) -> str:
        if v is None:
            return uuid4().hex[0:10]

        return v

openlayers.layers.VectorLayer

Bases: VectorTileLayer

A layer for rendering vector sources

Source code in openlayers/models/layers.py 
47
48
49
50
51
class VectorLayer(VectorTileLayer):
    """A layer for rendering vector sources"""

    # style: dict | FlatStyle | None = default_style()
    fit_bounds: bool = Field(False, serialization_alias="fitBounds")

openlayers.layers.VectorTileLayer

Bases: Layer

Source code in openlayers/models/layers.py 
36
37
38
39
40
41
42
43
44
class VectorTileLayer(Layer):
    style: dict | FlatStyle | list | None = default_style()

    @field_validator("style")
    def validate_style(cls, v):
        if isinstance(v, FlatStyle):
            return v.model_dump()

        return v

openlayers.layers.TileLayer

Bases: Layer

Source code in openlayers/models/layers.py 
33
class TileLayer(Layer): ...

openlayers.layers.WebGLVectorLayer

Bases: VectorLayer

A layer for rendering vector sources using WebGL

Source code in openlayers/models/layers.py 
67
68
69
70
class WebGLVectorLayer(VectorLayer):
    """A layer for rendering vector sources using WebGL"""

    ...

openlayers.layers.WebGLVectorTileLayer

Bases: VectorTileLayer

Source code in openlayers/models/layers.py 
73
class WebGLVectorTileLayer(VectorTileLayer): ...

openlayers.layers.WebGLTileLayer

Bases: Layer

WebGLTile layer

Note

See WebGLTile for details.

Source code in openlayers/models/layers.py 
76
77
78
79
80
81
82
83
class WebGLTileLayer(Layer):
    """WebGLTile layer

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

    style: dict | None = None