Skip to content

Controls

openlayers.controls

DrawControl

Bases: Control

Draw control

Source code in openlayers/models/controls.py 
121
122
123
124
class DrawControl(Control):
    """Draw control"""

    ...

FullScreenControl

Bases: Control

Full screen control

Provides a button that fills the entire screen with the map when clicked.

Source code in openlayers/models/controls.py 
28
29
30
31
32
33
34
class FullScreenControl(Control):
    """Full screen control

    Provides a button that fills the entire screen with the map when clicked.
    """

    ...

InfoBox

Bases: Control

Info box

Source code in openlayers/models/controls.py 
112
113
114
115
116
117
118
class InfoBox(Control):
    """Info box"""

    html: str
    css_text: str = Field(
        "top: 65px; left: .5em; padding: 5px;", serialization_alias="cssText"
    )

MapTilerGeocodingControl

Bases: Control

MapTiler geocoding control

Source code in openlayers/models/controls.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
class MapTilerGeocodingControl(Control):
    """MapTiler geocoding control"""

    api_key: str = Field(
        os.getenv(MAPTILER_API_KEY_ENV_VAR),
        serialization_alias="apiKey",
        validate_default=True,
    )
    collapsed: bool | None = False
    country: str | None = None
    limit: int | None = 5
    marker_on_selected: bool | None = Field(
        True, serialization_alias="markerOnSelected"
    )
    placeholder: str | None = "Search"

MousePositionControl

Bases: Control

Mouse position control

Source code in openlayers/models/controls.py 
55
56
57
58
class MousePositionControl(Control):
    """Mouse position control"""

    projection: str | None = "EPSG:4326"

OverviewMapControl

Bases: Control

Overview map control

Source code in openlayers/models/controls.py 
61
62
63
64
class OverviewMapControl(Control):
    """Overview map control"""

    layers: list[dict | LayerT] = [TileLayer(source=OSM())]

RotateControl

Bases: Control

Rotate control

Source code in openlayers/models/controls.py 
74
75
76
77
class RotateControl(Control):
    """Rotate control"""

    ...

ScaleLineControl

Bases: Control

Scale line control

Displays rough y-axis distances that are calculated for the centre of the viewport.

Source code in openlayers/models/controls.py 
37
38
39
40
41
42
43
44
45
46
class ScaleLineControl(Control):
    """Scale line control

    Displays rough y-axis distances that are calculated for the centre of the viewport.
    """

    bar: bool | None = False
    steps: int | None = None
    units: Literal["metric", "degrees", "imperial", "us", "nautical"] | None = None
    text: bool = False

ZoomControl

Bases: Control

Zoom control

Source code in openlayers/models/controls.py 
67
68
69
70
71
class ZoomControl(Control):
    """Zoom control"""

    zoom_in_label: str = Field("+", serialization_alias="zoomInLabel")
    zoom_out_label: str = Field("-", serialization_alias="zoomOutLabel")

ZoomSliderControl

Bases: Control

Zoom slider control

Source code in openlayers/models/controls.py 
49
50
51
52
class ZoomSliderControl(Control):
    """Zoom slider control"""

    ...

ZoomToExtentControl

Bases: Control

Zoom to extent control

Provides a button that changes the map view to a specific extent when clicked.

Source code in openlayers/models/controls.py 
80
81
82
83
84
85
86
87
88
89
90
class ZoomToExtentControl(Control):
    """Zoom to extent control

    Provides a button that changes the map view to a specific extent when clicked.
    """

    extent: (
        tuple[float | float | float | float]
        | list[float | float | float | float]
        | None
    ) = None