Skip to content

Markers and controls

maplibre.controls.Popup

Bases: BaseModel

Popup

Attributes:

Name Type Description
text str

The Text of the popup.
options PopupOptions | dict

Popup options.
Source code in maplibre/controls.py 
25
26
27
28
29
30
31
32
33
34
class Popup(BaseModel):
    """Popup

    Attributes:
        text: The Text of the popup.
        options (PopupOptions | dict): Popup options.
    """

    text: str
    options: Union[PopupOptions, dict] = {}

maplibre.controls.PopupOptions

Bases: BaseModel

Popup options

Source code in maplibre/controls.py 
14
15
16
17
18
19
20
21
22
class PopupOptions(BaseModel):
    """Popup options"""

    anchor: str = None
    close_button: bool = Field(False, serialization_alias="closeButton")
    close_on_click: bool = Field(None, serialization_alias="closeOnClick")
    close_on_move: bool = Field(None, serialization_alias="closeOnMove")
    max_width: int = Field(None, serialization_alias="maxWidth")
    offset: Union[int, list, dict] = None

maplibre.controls.Marker

Bases: BaseModel

Marker

Attributes:

Name Type Description
lng_lat tuple | list

Required. The longitude and latitude of the marker.
popup Popup | dict

The Popup that is displayed when a user clicks on the marker.
options MarkerOptions | dict

Marker options.
Source code in maplibre/controls.py 
50
51
52
53
54
55
56
57
58
59
60
61
class Marker(BaseModel):
    """Marker

    Attributes:
        lng_lat (tuple |list): **Required.** The longitude and latitude of the marker.
        popup (Popup | dict): The Popup that is displayed when a user clicks on the marker.
        options (MarkerOptions | dict): Marker options.
    """

    lng_lat: Union[tuple, list] = Field(None, serialization_alias="lngLat")
    popup: Union[Popup, dict] = None
    options: Union[MarkerOptions, dict] = {}

maplibre.controls.MarkerOptions

Bases: BaseModel

Marker options

Source code in maplibre/controls.py 
37
38
39
40
41
42
43
44
45
46
47
class MarkerOptions(BaseModel):
    """Marker options"""

    anchor: str = None
    color: str = None
    draggable: bool = None
    offset: Union[tuple, list] = None
    pitch_alignment: str = Field(None, serialization_alias="pitchAlignment")
    rotation: int = None
    rotation_alignment: str = Field(None, serialization_alias="rotationAlignment")
    scale: int = None

maplibre.controls.ControlPosition

Bases: Enum

Control position

Attributes:

  • TOP_LEFT –

    top-left

  • TOP_RIGHT –

    top-right

  • BOTTOM_LEFT –

    bottom-left

  • BOTTOM_RIGHT –

    bottom-right

Source code in maplibre/controls.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class ControlPosition(Enum):
    """Control position

    Attributes:
        TOP_LEFT: top-left
        TOP_RIGHT: top-right
        BOTTOM_LEFT: bottom-left
        BOTTOM_RIGHT: bottom-right
    """

    TOP_LEFT = "top-left"
    TOP_RIGHT = "top-right"
    BOTTOM_LEFT = "bottom-left"
    BOTTOM_RIGHT = "bottom-right"

maplibre.controls.FullscreenControl

Bases: Control

Fullscreen control

Examples:

>>> from maplibre import Map
>>> from maplibre.controls import FullscreenControl, ControlPosition

>>> map = Map()
>>> map.add_control(FullscreenControl(), ControlPosition.BOTTOM_LEFT)
Source code in maplibre/controls.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
class FullscreenControl(Control):
    """Fullscreen control

    Examples:
        >>> from maplibre import Map
        >>> from maplibre.controls import FullscreenControl, ControlPosition

        >>> map = Map()
        >>> map.add_control(FullscreenControl(), ControlPosition.BOTTOM_LEFT)
    """

    # _name: str = ControlType.FULLSCREEN.value
    pass

maplibre.controls.ScaleControl

Bases: Control

Scale control

Source code in maplibre/controls.py 
145
146
147
148
149
150
class ScaleControl(Control):
    """Scale control"""

    # _name: str = ControlType.SCALE.value
    max_width: int = Field(None, serialization_alias="maxWidth")
    unit: Literal["imperial", "metric", "nautical"] = "metric"

maplibre.controls.NavigationControl

Bases: Control

Navigation control

Source code in maplibre/controls.py 
130
131
132
133
134
135
136
class NavigationControl(Control):
    """Navigation control"""

    # _name: str = ControlType.NAVIGATION.value
    show_compass: bool = Field(True, serialization_alias="showCompass")
    show_zoom: bool = Field(True, serialization_alias="showZoom")
    visualize_pitch: bool = Field(False, serialization_alias="visualizePitch")

maplibre.controls.GeolocateControl

Bases: Control

Geolocate control

Source code in maplibre/controls.py 
119
120
121
122
123
124
125
126
127
class GeolocateControl(Control):
    """Geolocate control"""

    # _name: str = ControlType.GEOLOCATE.value
    position_options: dict = Field(None, serialization_alias="positionOptions")
    show_accuracy_circle: bool = Field(True, serialization_alias="showAccuracyCircle")
    show_user_heading: bool = Field(False, serialization_alias="showUserHeading")
    show_user_location: bool = Field(True, serialization_alias="showUserLocation")
    track_user_location: bool = Field(False, serialization_alias="trackUserLocation")