anymap module¶
Main module for anymap interactive mapping widgets.
CesiumMap (MapWidget)
¶
Cesium ion implementation of the map widget for 3D globe visualization.
Source code in anymap/anymap.py
class CesiumMap(MapWidget):
"""Cesium ion implementation of the map widget for 3D globe visualization."""
# Cesium-specific traits
access_token = traitlets.Unicode("").tag(sync=True)
camera_height = traitlets.Float(10000000.0).tag(sync=True) # 10M meters default
heading = traitlets.Float(0.0).tag(sync=True)
pitch = traitlets.Float(-90.0).tag(sync=True) # Looking down
roll = traitlets.Float(0.0).tag(sync=True)
# Cesium viewer options
base_layer_picker = traitlets.Bool(True).tag(sync=True)
fullscreen_button = traitlets.Bool(True).tag(sync=True)
vr_button = traitlets.Bool(False).tag(sync=True)
geocoder = traitlets.Bool(True).tag(sync=True)
home_button = traitlets.Bool(True).tag(sync=True)
info_box = traitlets.Bool(True).tag(sync=True)
scene_mode_picker = traitlets.Bool(True).tag(sync=True)
selection_indicator = traitlets.Bool(True).tag(sync=True)
timeline = traitlets.Bool(False).tag(sync=True)
navigation_help_button = traitlets.Bool(False).tag(
sync=True
) # Disabled by default to prevent arrows
animation = traitlets.Bool(False).tag(sync=True)
should_animate = traitlets.Bool(False).tag(sync=True)
# Define the JavaScript module path
_esm = _esm_cesium
_css = _css_cesium
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
width: str = "100%",
height: str = "600px",
camera_height: float = 10000000.0,
heading: float = 0.0,
pitch: float = -90.0,
roll: float = 0.0,
access_token: str = "",
base_layer_picker: bool = True,
fullscreen_button: bool = True,
vr_button: bool = False,
geocoder: bool = True,
home_button: bool = True,
info_box: bool = True,
scene_mode_picker: bool = True,
selection_indicator: bool = True,
timeline: bool = False,
navigation_help_button: bool = False,
animation: bool = False,
should_animate: bool = False,
**kwargs,
):
"""Initialize Cesium map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level (used for camera height calculation)
width: Widget width
height: Widget height
camera_height: Camera height above ground in meters
heading: Camera heading in degrees (0 = north, 90 = east)
pitch: Camera pitch in degrees (-90 = looking down, 0 = horizon)
roll: Camera roll in degrees
access_token: Cesium ion access token (required for Cesium services).
Get a free token at https://cesium.com/ion/signup
Can also be set via CESIUM_TOKEN environment variable.
base_layer_picker: Show base layer picker widget
fullscreen_button: Show fullscreen button
vr_button: Show VR button
geocoder: Show geocoder search widget
home_button: Show home button
info_box: Show info box when clicking entities
scene_mode_picker: Show 3D/2D/Columbus view picker
selection_indicator: Show selection indicator
timeline: Show timeline widget
navigation_help_button: Show navigation help button
animation: Show animation widget
should_animate: Enable automatic animation
"""
# Set default access token if not provided
if not access_token:
access_token = self._get_default_access_token()
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
camera_height=camera_height,
heading=heading,
pitch=pitch,
roll=roll,
access_token=access_token,
base_layer_picker=base_layer_picker,
fullscreen_button=fullscreen_button,
vr_button=vr_button,
geocoder=geocoder,
home_button=home_button,
info_box=info_box,
scene_mode_picker=scene_mode_picker,
selection_indicator=selection_indicator,
timeline=timeline,
navigation_help_button=navigation_help_button,
animation=animation,
should_animate=should_animate,
**kwargs,
)
@staticmethod
def _get_default_access_token() -> str:
"""Get default Cesium access token from environment."""
import os
# Try to get from environment variable
token = os.environ.get("CESIUM_TOKEN") or os.environ.get("CESIUM_ACCESS_TOKEN")
# If no token found, return empty string - user must provide their own token
if not token:
import warnings
warnings.warn(
"No Cesium access token found. Please set CESIUM_TOKEN environment variable "
"or pass access_token parameter. Get a free token at https://cesium.com/ion/signup",
UserWarning,
)
token = ""
return token
def set_access_token(self, token: str) -> None:
"""Set the Cesium ion access token."""
self.access_token = token
def fly_to(
self,
latitude: float,
longitude: float,
height: Optional[float] = None,
heading: Optional[float] = None,
pitch: Optional[float] = None,
roll: Optional[float] = None,
duration: float = 3.0,
) -> None:
"""Fly the camera to a specific location."""
options = {"latitude": latitude, "longitude": longitude, "duration": duration}
if height is not None:
options["height"] = height
if heading is not None:
options["heading"] = heading
if pitch is not None:
options["pitch"] = pitch
if roll is not None:
options["roll"] = roll
self.call_js_method("flyTo", options)
def set_camera_position(
self,
latitude: float,
longitude: float,
height: float,
heading: float = 0.0,
pitch: float = -90.0,
roll: float = 0.0,
) -> None:
"""Set camera position immediately."""
self.center = [latitude, longitude]
self.camera_height = height
self.heading = heading
self.pitch = pitch
self.roll = roll
def add_entity(self, entity_config: Dict[str, Any]) -> None:
"""Add an entity to the globe."""
self.call_js_method("addEntity", entity_config)
def remove_entity(self, entity_id: str) -> None:
"""Remove an entity from the globe."""
self.call_js_method("removeEntity", entity_id)
def add_point(
self,
latitude: float,
longitude: float,
height: float = 0.0,
name: Optional[str] = None,
description: Optional[str] = None,
color: str = "#ffff00",
pixel_size: int = 10,
entity_id: Optional[str] = None,
) -> str:
"""Add a point to the globe."""
if entity_id is None:
entity_id = f"point_{len(self._layers)}"
entity_config = {
"id": entity_id,
"position": {
"longitude": longitude,
"latitude": latitude,
"height": height,
},
"point": {
"pixelSize": pixel_size,
"color": color,
"outlineColor": "#000000",
"outlineWidth": 2,
"heightReference": "CLAMP_TO_GROUND" if height == 0 else "NONE",
},
}
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
def add_billboard(
self,
latitude: float,
longitude: float,
image_url: str,
height: float = 0.0,
scale: float = 1.0,
name: Optional[str] = None,
description: Optional[str] = None,
entity_id: Optional[str] = None,
) -> str:
"""Add a billboard (image marker) to the globe."""
if entity_id is None:
entity_id = f"billboard_{len(self._layers)}"
entity_config = {
"id": entity_id,
"position": {
"longitude": longitude,
"latitude": latitude,
"height": height,
},
"billboard": {
"image": image_url,
"scale": scale,
"heightReference": "CLAMP_TO_GROUND" if height == 0 else "NONE",
},
}
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
def add_polyline(
self,
coordinates: List[List[float]],
color: str = "#ff0000",
width: int = 2,
clamp_to_ground: bool = True,
name: Optional[str] = None,
description: Optional[str] = None,
entity_id: Optional[str] = None,
) -> str:
"""Add a polyline to the globe."""
if entity_id is None:
entity_id = f"polyline_{len(self._layers)}"
# Convert coordinates to Cesium format
positions = []
for coord in coordinates:
if len(coord) >= 2:
positions.extend(
[coord[1], coord[0], coord[2] if len(coord) > 2 else 0]
)
entity_config = {
"id": entity_id,
"polyline": {
"positions": positions,
"width": width,
"material": color,
"clampToGround": clamp_to_ground,
},
}
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
def add_polygon(
self,
coordinates: List[List[float]],
color: str = "#0000ff",
outline_color: str = "#000000",
height: float = 0.0,
extrude_height: Optional[float] = None,
name: Optional[str] = None,
description: Optional[str] = None,
entity_id: Optional[str] = None,
) -> str:
"""Add a polygon to the globe."""
if entity_id is None:
entity_id = f"polygon_{len(self._layers)}"
# Convert coordinates to Cesium format
positions = []
for coord in coordinates:
if len(coord) >= 2:
positions.extend([coord[1], coord[0]])
entity_config = {
"id": entity_id,
"polygon": {
"hierarchy": positions,
"material": color,
"outline": True,
"outlineColor": outline_color,
"height": height,
},
}
if extrude_height is not None:
entity_config["polygon"]["extrudedHeight"] = extrude_height
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
def add_data_source(
self,
source_type: str,
data: Union[str, Dict[str, Any]],
options: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a data source (GeoJSON, KML, CZML) to the globe."""
config = {"data": data, "options": options or {}}
self.call_js_method("addDataSource", source_type, config)
def add_geojson(
self, geojson_data: Dict[str, Any], options: Optional[Dict[str, Any]] = None
) -> None:
"""Add GeoJSON data to the globe."""
self.add_data_source("geojson", geojson_data, options)
def add_kml(self, kml_url: str, options: Optional[Dict[str, Any]] = None) -> None:
"""Add KML data to the globe."""
self.add_data_source("kml", kml_url, options)
def add_czml(
self, czml_data: List[Dict[str, Any]], options: Optional[Dict[str, Any]] = None
) -> None:
"""Add CZML data to the globe."""
self.add_data_source("czml", czml_data, options)
def set_terrain(self, terrain_config: Optional[Dict[str, Any]] = None) -> None:
"""Set terrain provider for the globe."""
self.call_js_method("setTerrain", terrain_config)
def set_cesium_world_terrain(
self, request_water_mask: bool = False, request_vertex_normals: bool = False
) -> None:
"""Set Cesium World Terrain as the terrain provider."""
terrain_config = {
"type": "cesium-world-terrain",
"requestWaterMask": request_water_mask,
"requestVertexNormals": request_vertex_normals,
}
self.set_terrain(terrain_config)
def set_imagery(self, imagery_config: Dict[str, Any]) -> None:
"""Set imagery provider for the globe."""
self.call_js_method("setImagery", imagery_config)
def set_scene_mode_3d(self) -> None:
"""Set scene to 3D mode."""
self.call_js_method("setScene3D")
def set_scene_mode_2d(self) -> None:
"""Set scene to 2D mode."""
self.call_js_method("setScene2D")
def set_scene_mode_columbus(self) -> None:
"""Set scene to Columbus view (2.5D)."""
self.call_js_method("setSceneColumbusView")
def enable_lighting(self, enabled: bool = True) -> None:
"""Enable or disable globe lighting effects."""
self.call_js_method("enableLighting", enabled)
def enable_fog(self, enabled: bool = True) -> None:
"""Enable or disable atmospheric fog."""
self.call_js_method("enableFog", enabled)
def zoom_to_entity(self, entity_id: str) -> None:
"""Zoom the camera to focus on a specific entity."""
self.call_js_method("zoomToEntity", entity_id)
def home(self) -> None:
"""Reset camera to home position."""
self.call_js_method("home")
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
def get_sources(self) -> Dict[str, Dict[str, Any]]:
"""Get all sources currently on the map."""
return dict(self._sources)
def clear_entities(self) -> None:
"""Clear all entities from the globe."""
# This would require tracking entities, for now use clear_layers
self.clear_layers()
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
def clear_sources(self) -> None:
"""Remove all sources from the map."""
for source_id in list(self._sources.keys()):
self.remove_source(source_id)
def clear_all(self) -> None:
"""Clear all layers and sources from the map."""
self.clear_layers()
self.clear_sources()
__init__(self, center=[0.0, 0.0], zoom=2.0, width='100%', height='600px', camera_height=10000000.0, heading=0.0, pitch=-90.0, roll=0.0, access_token='', base_layer_picker=True, fullscreen_button=True, vr_button=False, geocoder=True, home_button=True, info_box=True, scene_mode_picker=True, selection_indicator=True, timeline=False, navigation_help_button=False, animation=False, should_animate=False, **kwargs)
special
¶
Initialize Cesium map widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
center |
List[float] |
Map center as [latitude, longitude] |
[0.0, 0.0] |
zoom |
float |
Initial zoom level (used for camera height calculation) |
2.0 |
width |
str |
Widget width |
'100%' |
height |
str |
Widget height |
'600px' |
camera_height |
float |
Camera height above ground in meters |
10000000.0 |
heading |
float |
Camera heading in degrees (0 = north, 90 = east) |
0.0 |
pitch |
float |
Camera pitch in degrees (-90 = looking down, 0 = horizon) |
-90.0 |
roll |
float |
Camera roll in degrees |
0.0 |
access_token |
str |
Cesium ion access token (required for Cesium services). Get a free token at https://cesium.com/ion/signup Can also be set via CESIUM_TOKEN environment variable. |
'' |
base_layer_picker |
bool |
Show base layer picker widget |
True |
fullscreen_button |
bool |
Show fullscreen button |
True |
vr_button |
bool |
Show VR button |
False |
geocoder |
bool |
Show geocoder search widget |
True |
home_button |
bool |
Show home button |
True |
info_box |
bool |
Show info box when clicking entities |
True |
scene_mode_picker |
bool |
Show 3D/2D/Columbus view picker |
True |
selection_indicator |
bool |
Show selection indicator |
True |
timeline |
bool |
Show timeline widget |
False |
navigation_help_button |
bool |
Show navigation help button |
False |
animation |
bool |
Show animation widget |
False |
should_animate |
bool |
Enable automatic animation |
False |
Source code in anymap/anymap.py
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
width: str = "100%",
height: str = "600px",
camera_height: float = 10000000.0,
heading: float = 0.0,
pitch: float = -90.0,
roll: float = 0.0,
access_token: str = "",
base_layer_picker: bool = True,
fullscreen_button: bool = True,
vr_button: bool = False,
geocoder: bool = True,
home_button: bool = True,
info_box: bool = True,
scene_mode_picker: bool = True,
selection_indicator: bool = True,
timeline: bool = False,
navigation_help_button: bool = False,
animation: bool = False,
should_animate: bool = False,
**kwargs,
):
"""Initialize Cesium map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level (used for camera height calculation)
width: Widget width
height: Widget height
camera_height: Camera height above ground in meters
heading: Camera heading in degrees (0 = north, 90 = east)
pitch: Camera pitch in degrees (-90 = looking down, 0 = horizon)
roll: Camera roll in degrees
access_token: Cesium ion access token (required for Cesium services).
Get a free token at https://cesium.com/ion/signup
Can also be set via CESIUM_TOKEN environment variable.
base_layer_picker: Show base layer picker widget
fullscreen_button: Show fullscreen button
vr_button: Show VR button
geocoder: Show geocoder search widget
home_button: Show home button
info_box: Show info box when clicking entities
scene_mode_picker: Show 3D/2D/Columbus view picker
selection_indicator: Show selection indicator
timeline: Show timeline widget
navigation_help_button: Show navigation help button
animation: Show animation widget
should_animate: Enable automatic animation
"""
# Set default access token if not provided
if not access_token:
access_token = self._get_default_access_token()
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
camera_height=camera_height,
heading=heading,
pitch=pitch,
roll=roll,
access_token=access_token,
base_layer_picker=base_layer_picker,
fullscreen_button=fullscreen_button,
vr_button=vr_button,
geocoder=geocoder,
home_button=home_button,
info_box=info_box,
scene_mode_picker=scene_mode_picker,
selection_indicator=selection_indicator,
timeline=timeline,
navigation_help_button=navigation_help_button,
animation=animation,
should_animate=should_animate,
**kwargs,
)
add_billboard(self, latitude, longitude, image_url, height=0.0, scale=1.0, name=None, description=None, entity_id=None)
¶
Add a billboard (image marker) to the globe.
Source code in anymap/anymap.py
def add_billboard(
self,
latitude: float,
longitude: float,
image_url: str,
height: float = 0.0,
scale: float = 1.0,
name: Optional[str] = None,
description: Optional[str] = None,
entity_id: Optional[str] = None,
) -> str:
"""Add a billboard (image marker) to the globe."""
if entity_id is None:
entity_id = f"billboard_{len(self._layers)}"
entity_config = {
"id": entity_id,
"position": {
"longitude": longitude,
"latitude": latitude,
"height": height,
},
"billboard": {
"image": image_url,
"scale": scale,
"heightReference": "CLAMP_TO_GROUND" if height == 0 else "NONE",
},
}
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
add_czml(self, czml_data, options=None)
¶
Add CZML data to the globe.
Source code in anymap/anymap.py
def add_czml(
self, czml_data: List[Dict[str, Any]], options: Optional[Dict[str, Any]] = None
) -> None:
"""Add CZML data to the globe."""
self.add_data_source("czml", czml_data, options)
add_data_source(self, source_type, data, options=None)
¶
Add a data source (GeoJSON, KML, CZML) to the globe.
Source code in anymap/anymap.py
def add_data_source(
self,
source_type: str,
data: Union[str, Dict[str, Any]],
options: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a data source (GeoJSON, KML, CZML) to the globe."""
config = {"data": data, "options": options or {}}
self.call_js_method("addDataSource", source_type, config)
add_entity(self, entity_config)
¶
Add an entity to the globe.
Source code in anymap/anymap.py
def add_entity(self, entity_config: Dict[str, Any]) -> None:
"""Add an entity to the globe."""
self.call_js_method("addEntity", entity_config)
add_geojson(self, geojson_data, options=None)
¶
Add GeoJSON data to the globe.
Source code in anymap/anymap.py
def add_geojson(
self, geojson_data: Dict[str, Any], options: Optional[Dict[str, Any]] = None
) -> None:
"""Add GeoJSON data to the globe."""
self.add_data_source("geojson", geojson_data, options)
add_kml(self, kml_url, options=None)
¶
Add KML data to the globe.
Source code in anymap/anymap.py
def add_kml(self, kml_url: str, options: Optional[Dict[str, Any]] = None) -> None:
"""Add KML data to the globe."""
self.add_data_source("kml", kml_url, options)
add_point(self, latitude, longitude, height=0.0, name=None, description=None, color='#ffff00', pixel_size=10, entity_id=None)
¶
Add a point to the globe.
Source code in anymap/anymap.py
def add_point(
self,
latitude: float,
longitude: float,
height: float = 0.0,
name: Optional[str] = None,
description: Optional[str] = None,
color: str = "#ffff00",
pixel_size: int = 10,
entity_id: Optional[str] = None,
) -> str:
"""Add a point to the globe."""
if entity_id is None:
entity_id = f"point_{len(self._layers)}"
entity_config = {
"id": entity_id,
"position": {
"longitude": longitude,
"latitude": latitude,
"height": height,
},
"point": {
"pixelSize": pixel_size,
"color": color,
"outlineColor": "#000000",
"outlineWidth": 2,
"heightReference": "CLAMP_TO_GROUND" if height == 0 else "NONE",
},
}
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
add_polygon(self, coordinates, color='#0000ff', outline_color='#000000', height=0.0, extrude_height=None, name=None, description=None, entity_id=None)
¶
Add a polygon to the globe.
Source code in anymap/anymap.py
def add_polygon(
self,
coordinates: List[List[float]],
color: str = "#0000ff",
outline_color: str = "#000000",
height: float = 0.0,
extrude_height: Optional[float] = None,
name: Optional[str] = None,
description: Optional[str] = None,
entity_id: Optional[str] = None,
) -> str:
"""Add a polygon to the globe."""
if entity_id is None:
entity_id = f"polygon_{len(self._layers)}"
# Convert coordinates to Cesium format
positions = []
for coord in coordinates:
if len(coord) >= 2:
positions.extend([coord[1], coord[0]])
entity_config = {
"id": entity_id,
"polygon": {
"hierarchy": positions,
"material": color,
"outline": True,
"outlineColor": outline_color,
"height": height,
},
}
if extrude_height is not None:
entity_config["polygon"]["extrudedHeight"] = extrude_height
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
add_polyline(self, coordinates, color='#ff0000', width=2, clamp_to_ground=True, name=None, description=None, entity_id=None)
¶
Add a polyline to the globe.
Source code in anymap/anymap.py
def add_polyline(
self,
coordinates: List[List[float]],
color: str = "#ff0000",
width: int = 2,
clamp_to_ground: bool = True,
name: Optional[str] = None,
description: Optional[str] = None,
entity_id: Optional[str] = None,
) -> str:
"""Add a polyline to the globe."""
if entity_id is None:
entity_id = f"polyline_{len(self._layers)}"
# Convert coordinates to Cesium format
positions = []
for coord in coordinates:
if len(coord) >= 2:
positions.extend(
[coord[1], coord[0], coord[2] if len(coord) > 2 else 0]
)
entity_config = {
"id": entity_id,
"polyline": {
"positions": positions,
"width": width,
"material": color,
"clampToGround": clamp_to_ground,
},
}
if name:
entity_config["name"] = name
if description:
entity_config["description"] = description
self.add_entity(entity_config)
return entity_id
clear_all(self)
¶
Clear all layers and sources from the map.
Source code in anymap/anymap.py
def clear_all(self) -> None:
"""Clear all layers and sources from the map."""
self.clear_layers()
self.clear_sources()
clear_entities(self)
¶
Clear all entities from the globe.
Source code in anymap/anymap.py
def clear_entities(self) -> None:
"""Clear all entities from the globe."""
# This would require tracking entities, for now use clear_layers
self.clear_layers()
clear_layers(self)
¶
Remove all layers from the map.
Source code in anymap/anymap.py
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
clear_sources(self)
¶
Remove all sources from the map.
Source code in anymap/anymap.py
def clear_sources(self) -> None:
"""Remove all sources from the map."""
for source_id in list(self._sources.keys()):
self.remove_source(source_id)
enable_fog(self, enabled=True)
¶
Enable or disable atmospheric fog.
Source code in anymap/anymap.py
def enable_fog(self, enabled: bool = True) -> None:
"""Enable or disable atmospheric fog."""
self.call_js_method("enableFog", enabled)
enable_lighting(self, enabled=True)
¶
Enable or disable globe lighting effects.
Source code in anymap/anymap.py
def enable_lighting(self, enabled: bool = True) -> None:
"""Enable or disable globe lighting effects."""
self.call_js_method("enableLighting", enabled)
fly_to(self, latitude, longitude, height=None, heading=None, pitch=None, roll=None, duration=3.0)
¶
Fly the camera to a specific location.
Source code in anymap/anymap.py
def fly_to(
self,
latitude: float,
longitude: float,
height: Optional[float] = None,
heading: Optional[float] = None,
pitch: Optional[float] = None,
roll: Optional[float] = None,
duration: float = 3.0,
) -> None:
"""Fly the camera to a specific location."""
options = {"latitude": latitude, "longitude": longitude, "duration": duration}
if height is not None:
options["height"] = height
if heading is not None:
options["heading"] = heading
if pitch is not None:
options["pitch"] = pitch
if roll is not None:
options["roll"] = roll
self.call_js_method("flyTo", options)
get_layers(self)
¶
Get all layers currently on the map.
Source code in anymap/anymap.py
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
get_sources(self)
¶
Get all sources currently on the map.
Source code in anymap/anymap.py
def get_sources(self) -> Dict[str, Dict[str, Any]]:
"""Get all sources currently on the map."""
return dict(self._sources)
home(self)
¶
Reset camera to home position.
Source code in anymap/anymap.py
def home(self) -> None:
"""Reset camera to home position."""
self.call_js_method("home")
remove_entity(self, entity_id)
¶
Remove an entity from the globe.
Source code in anymap/anymap.py
def remove_entity(self, entity_id: str) -> None:
"""Remove an entity from the globe."""
self.call_js_method("removeEntity", entity_id)
set_access_token(self, token)
¶
Set the Cesium ion access token.
Source code in anymap/anymap.py
def set_access_token(self, token: str) -> None:
"""Set the Cesium ion access token."""
self.access_token = token
set_camera_position(self, latitude, longitude, height, heading=0.0, pitch=-90.0, roll=0.0)
¶
Set camera position immediately.
Source code in anymap/anymap.py
def set_camera_position(
self,
latitude: float,
longitude: float,
height: float,
heading: float = 0.0,
pitch: float = -90.0,
roll: float = 0.0,
) -> None:
"""Set camera position immediately."""
self.center = [latitude, longitude]
self.camera_height = height
self.heading = heading
self.pitch = pitch
self.roll = roll
set_cesium_world_terrain(self, request_water_mask=False, request_vertex_normals=False)
¶
Set Cesium World Terrain as the terrain provider.
Source code in anymap/anymap.py
def set_cesium_world_terrain(
self, request_water_mask: bool = False, request_vertex_normals: bool = False
) -> None:
"""Set Cesium World Terrain as the terrain provider."""
terrain_config = {
"type": "cesium-world-terrain",
"requestWaterMask": request_water_mask,
"requestVertexNormals": request_vertex_normals,
}
self.set_terrain(terrain_config)
set_imagery(self, imagery_config)
¶
Set imagery provider for the globe.
Source code in anymap/anymap.py
def set_imagery(self, imagery_config: Dict[str, Any]) -> None:
"""Set imagery provider for the globe."""
self.call_js_method("setImagery", imagery_config)
set_scene_mode_2d(self)
¶
Set scene to 2D mode.
Source code in anymap/anymap.py
def set_scene_mode_2d(self) -> None:
"""Set scene to 2D mode."""
self.call_js_method("setScene2D")
set_scene_mode_3d(self)
¶
Set scene to 3D mode.
Source code in anymap/anymap.py
def set_scene_mode_3d(self) -> None:
"""Set scene to 3D mode."""
self.call_js_method("setScene3D")
set_scene_mode_columbus(self)
¶
Set scene to Columbus view (2.5D).
Source code in anymap/anymap.py
def set_scene_mode_columbus(self) -> None:
"""Set scene to Columbus view (2.5D)."""
self.call_js_method("setSceneColumbusView")
set_terrain(self, terrain_config=None)
¶
Set terrain provider for the globe.
Source code in anymap/anymap.py
def set_terrain(self, terrain_config: Optional[Dict[str, Any]] = None) -> None:
"""Set terrain provider for the globe."""
self.call_js_method("setTerrain", terrain_config)
zoom_to_entity(self, entity_id)
¶
Zoom the camera to focus on a specific entity.
Source code in anymap/anymap.py
def zoom_to_entity(self, entity_id: str) -> None:
"""Zoom the camera to focus on a specific entity."""
self.call_js_method("zoomToEntity", entity_id)
DeckGLMap (MapWidget)
¶
DeckGL implementation of the map widget for high-performance data visualization.
Source code in anymap/anymap.py
class DeckGLMap(MapWidget):
"""DeckGL implementation of the map widget for high-performance data visualization."""
# DeckGL-specific traits
controller = traitlets.Bool(True).tag(sync=True)
bearing = traitlets.Float(0.0).tag(sync=True)
pitch = traitlets.Float(0.0).tag(sync=True)
max_zoom = traitlets.Float(20.0).tag(sync=True)
min_zoom = traitlets.Float(0.0).tag(sync=True)
# Define the JavaScript module path
_esm = _esm_deck
_css = _css_deck
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
width: str = "100%",
height: str = "600px",
bearing: float = 0.0,
pitch: float = 0.0,
controller: bool = True,
max_zoom: float = 20.0,
min_zoom: float = 0.0,
**kwargs,
):
"""Initialize DeckGL map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level
width: Widget width
height: Widget height
bearing: Map bearing (rotation) in degrees
pitch: Map pitch (tilt) in degrees
controller: Enable map controls (pan, zoom, rotate)
max_zoom: Maximum zoom level
min_zoom: Minimum zoom level
"""
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
bearing=bearing,
pitch=pitch,
controller=controller,
max_zoom=max_zoom,
min_zoom=min_zoom,
**kwargs,
)
def set_bearing(self, bearing: float) -> None:
"""Set the map bearing (rotation)."""
self.bearing = bearing
def set_pitch(self, pitch: float) -> None:
"""Set the map pitch (tilt)."""
self.pitch = pitch
def set_view_state(
self,
longitude: Optional[float] = None,
latitude: Optional[float] = None,
zoom: Optional[float] = None,
bearing: Optional[float] = None,
pitch: Optional[float] = None,
) -> None:
"""Set the view state of the map."""
view_state = {}
if longitude is not None:
view_state["longitude"] = longitude
if latitude is not None:
view_state["latitude"] = latitude
if zoom is not None:
view_state["zoom"] = zoom
if bearing is not None:
view_state["bearing"] = bearing
if pitch is not None:
view_state["pitch"] = pitch
self.call_js_method("setViewState", view_state)
def add_scatterplot_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_radius: Union[str, int, float] = 100,
get_color: Union[str, List[int]] = [255, 0, 0, 255],
radius_scale: float = 1.0,
radius_min_pixels: int = 1,
radius_max_pixels: int = 100,
**kwargs,
) -> None:
"""Add a scatterplot layer to the map."""
layer_config = {
"type": "ScatterplotLayer",
"data": data,
"getPosition": get_position,
"getRadius": get_radius,
"getFillColor": get_color,
"radiusScale": radius_scale,
"radiusMinPixels": radius_min_pixels,
"radiusMaxPixels": radius_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_line_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_source_position: str = "sourcePosition",
get_target_position: str = "targetPosition",
get_color: Union[str, List[int]] = [0, 255, 0, 255],
get_width: Union[str, int, float] = 1,
width_scale: float = 1.0,
width_min_pixels: int = 1,
width_max_pixels: int = 10,
**kwargs,
) -> None:
"""Add a line layer to the map."""
layer_config = {
"type": "LineLayer",
"data": data,
"getSourcePosition": get_source_position,
"getTargetPosition": get_target_position,
"getColor": get_color,
"getWidth": get_width,
"widthScale": width_scale,
"widthMinPixels": width_min_pixels,
"widthMaxPixels": width_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_arc_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_source_position: str = "sourcePosition",
get_target_position: str = "targetPosition",
get_source_color: Union[str, List[int]] = [255, 0, 0, 255],
get_target_color: Union[str, List[int]] = [0, 255, 0, 255],
get_width: Union[str, int, float] = 1,
width_scale: float = 1.0,
width_min_pixels: int = 1,
width_max_pixels: int = 10,
**kwargs,
) -> None:
"""Add an arc layer to the map."""
layer_config = {
"type": "ArcLayer",
"data": data,
"getSourcePosition": get_source_position,
"getTargetPosition": get_target_position,
"getSourceColor": get_source_color,
"getTargetColor": get_target_color,
"getWidth": get_width,
"widthScale": width_scale,
"widthMinPixels": width_min_pixels,
"widthMaxPixels": width_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_path_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_path: str = "path",
get_color: Union[str, List[int]] = [255, 0, 0, 255],
get_width: Union[str, int, float] = 1,
width_scale: float = 1.0,
width_min_pixels: int = 1,
width_max_pixels: int = 10,
**kwargs,
) -> None:
"""Add a path layer to the map."""
layer_config = {
"type": "PathLayer",
"data": data,
"getPath": get_path,
"getColor": get_color,
"getWidth": get_width,
"widthScale": width_scale,
"widthMinPixels": width_min_pixels,
"widthMaxPixels": width_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_polygon_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_polygon: str = "polygon",
get_fill_color: Union[str, List[int]] = [255, 0, 0, 128],
get_line_color: Union[str, List[int]] = [0, 0, 0, 255],
get_line_width: Union[str, int, float] = 1,
filled: bool = True,
stroked: bool = True,
**kwargs,
) -> None:
"""Add a polygon layer to the map."""
layer_config = {
"type": "PolygonLayer",
"data": data,
"getPolygon": get_polygon,
"getFillColor": get_fill_color,
"getLineColor": get_line_color,
"getLineWidth": get_line_width,
"filled": filled,
"stroked": stroked,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_geojson_layer(
self,
layer_id: str,
data: Dict[str, Any],
get_fill_color: Union[str, List[int]] = [255, 0, 0, 128],
get_line_color: Union[str, List[int]] = [0, 0, 0, 255],
get_line_width: Union[str, int, float] = 1,
get_radius: Union[str, int, float] = 100,
filled: bool = True,
stroked: bool = True,
**kwargs,
) -> None:
"""Add a GeoJSON layer to the map."""
layer_config = {
"type": "GeoJsonLayer",
"data": data,
"getFillColor": get_fill_color,
"getLineColor": get_line_color,
"getLineWidth": get_line_width,
"getRadius": get_radius,
"filled": filled,
"stroked": stroked,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_hexagon_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_weight: Union[str, int, float] = 1,
radius: int = 1000,
elevation_scale: float = 4,
elevation_range: List[int] = [0, 1000],
coverage: float = 1.0,
color_range: Optional[List[List[int]]] = None,
**kwargs,
) -> None:
"""Add a hexagon layer to the map."""
if color_range is None:
color_range = [
[1, 152, 189],
[73, 227, 206],
[216, 254, 181],
[254, 237, 177],
[254, 173, 84],
[209, 55, 78],
]
layer_config = {
"type": "HexagonLayer",
"data": data,
"getPosition": get_position,
"getWeight": get_weight,
"radius": radius,
"elevationScale": elevation_scale,
"elevationRange": elevation_range,
"coverage": coverage,
"colorRange": color_range,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_grid_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_weight: Union[str, int, float] = 1,
cell_size: int = 200,
elevation_scale: float = 4,
elevation_range: List[int] = [0, 1000],
coverage: float = 1.0,
color_range: Optional[List[List[int]]] = None,
**kwargs,
) -> None:
"""Add a grid layer to the map."""
if color_range is None:
color_range = [
[1, 152, 189],
[73, 227, 206],
[216, 254, 181],
[254, 237, 177],
[254, 173, 84],
[209, 55, 78],
]
layer_config = {
"type": "GridLayer",
"data": data,
"getPosition": get_position,
"getWeight": get_weight,
"cellSize": cell_size,
"elevationScale": elevation_scale,
"elevationRange": elevation_range,
"coverage": coverage,
"colorRange": color_range,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_heatmap_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_weight: Union[str, int, float] = 1,
radius_pixels: int = 60,
intensity: float = 1.0,
threshold: float = 0.05,
color_range: Optional[List[List[int]]] = None,
**kwargs,
) -> None:
"""Add a heatmap layer to the map."""
if color_range is None:
color_range = [
[255, 255, 178],
[254, 204, 92],
[253, 141, 60],
[240, 59, 32],
[189, 0, 38],
]
layer_config = {
"type": "HeatmapLayer",
"data": data,
"getPosition": get_position,
"getWeight": get_weight,
"radiusPixels": radius_pixels,
"intensity": intensity,
"threshold": threshold,
"colorRange": color_range,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_column_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_elevation: Union[str, int, float] = 0,
get_fill_color: Union[str, List[int]] = [255, 0, 0, 255],
get_line_color: Union[str, List[int]] = [0, 0, 0, 255],
radius: int = 1000,
elevation_scale: float = 1.0,
filled: bool = True,
stroked: bool = False,
**kwargs,
) -> None:
"""Add a column layer to the map."""
layer_config = {
"type": "ColumnLayer",
"data": data,
"getPosition": get_position,
"getElevation": get_elevation,
"getFillColor": get_fill_color,
"getLineColor": get_line_color,
"radius": radius,
"elevationScale": elevation_scale,
"filled": filled,
"stroked": stroked,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_text_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_text: str = "text",
get_color: Union[str, List[int]] = [0, 0, 0, 255],
get_size: Union[str, int, float] = 32,
get_angle: Union[str, int, float] = 0,
font_family: str = "Monaco, monospace",
**kwargs,
) -> None:
"""Add a text layer to the map."""
layer_config = {
"type": "TextLayer",
"data": data,
"getPosition": get_position,
"getText": get_text,
"getColor": get_color,
"getSize": get_size,
"getAngle": get_angle,
"fontFamily": font_family,
**kwargs,
}
self.add_layer(layer_id, layer_config)
def add_icon_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_icon: str = "icon",
get_color: Union[str, List[int]] = [255, 255, 255, 255],
get_size: Union[str, int, float] = 1,
size_scale: float = 1.0,
icon_atlas: Optional[str] = None,
icon_mapping: Optional[Dict[str, Any]] = None,
**kwargs,
) -> None:
"""Add an icon layer to the map."""
layer_config = {
"type": "IconLayer",
"data": data,
"getPosition": get_position,
"getIcon": get_icon,
"getColor": get_color,
"getSize": get_size,
"sizeScale": size_scale,
**kwargs,
}
if icon_atlas:
layer_config["iconAtlas"] = icon_atlas
if icon_mapping:
layer_config["iconMapping"] = icon_mapping
self.add_layer(layer_id, layer_config)
def update_layer(self, layer_id: str, **props) -> None:
"""Update properties of an existing layer."""
self.call_js_method("updateLayer", layer_id, props)
def fit_bounds(
self,
bounds: List[List[float]],
padding: Union[int, Dict[str, int]] = 20,
max_zoom: Optional[float] = None,
) -> None:
"""Fit the map to given bounds.
Args:
bounds: Bounds in format [[minLng, minLat], [maxLng, maxLat]]
padding: Padding around bounds in pixels
max_zoom: Maximum zoom level when fitting
"""
options = {"padding": padding}
if max_zoom is not None:
options["maxZoom"] = max_zoom
self.call_js_method("fitBounds", bounds, options)
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
def clear_all(self) -> None:
"""Clear all layers from the map."""
self.clear_layers()
def enable_controller(self, enabled: bool = True) -> None:
"""Enable or disable map controls."""
self.controller = enabled
def set_zoom_range(self, min_zoom: float, max_zoom: float) -> None:
"""Set the zoom range for the map."""
self.min_zoom = min_zoom
self.max_zoom = max_zoom
__init__(self, center=[0.0, 0.0], zoom=2.0, width='100%', height='600px', bearing=0.0, pitch=0.0, controller=True, max_zoom=20.0, min_zoom=0.0, **kwargs)
special
¶
Initialize DeckGL map widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
center |
List[float] |
Map center as [latitude, longitude] |
[0.0, 0.0] |
zoom |
float |
Initial zoom level |
2.0 |
width |
str |
Widget width |
'100%' |
height |
str |
Widget height |
'600px' |
bearing |
float |
Map bearing (rotation) in degrees |
0.0 |
pitch |
float |
Map pitch (tilt) in degrees |
0.0 |
controller |
bool |
Enable map controls (pan, zoom, rotate) |
True |
max_zoom |
float |
Maximum zoom level |
20.0 |
min_zoom |
float |
Minimum zoom level |
0.0 |
Source code in anymap/anymap.py
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
width: str = "100%",
height: str = "600px",
bearing: float = 0.0,
pitch: float = 0.0,
controller: bool = True,
max_zoom: float = 20.0,
min_zoom: float = 0.0,
**kwargs,
):
"""Initialize DeckGL map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level
width: Widget width
height: Widget height
bearing: Map bearing (rotation) in degrees
pitch: Map pitch (tilt) in degrees
controller: Enable map controls (pan, zoom, rotate)
max_zoom: Maximum zoom level
min_zoom: Minimum zoom level
"""
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
bearing=bearing,
pitch=pitch,
controller=controller,
max_zoom=max_zoom,
min_zoom=min_zoom,
**kwargs,
)
add_arc_layer(self, layer_id, data, get_source_position='sourcePosition', get_target_position='targetPosition', get_source_color=[255, 0, 0, 255], get_target_color=[0, 255, 0, 255], get_width=1, width_scale=1.0, width_min_pixels=1, width_max_pixels=10, **kwargs)
¶
Add an arc layer to the map.
Source code in anymap/anymap.py
def add_arc_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_source_position: str = "sourcePosition",
get_target_position: str = "targetPosition",
get_source_color: Union[str, List[int]] = [255, 0, 0, 255],
get_target_color: Union[str, List[int]] = [0, 255, 0, 255],
get_width: Union[str, int, float] = 1,
width_scale: float = 1.0,
width_min_pixels: int = 1,
width_max_pixels: int = 10,
**kwargs,
) -> None:
"""Add an arc layer to the map."""
layer_config = {
"type": "ArcLayer",
"data": data,
"getSourcePosition": get_source_position,
"getTargetPosition": get_target_position,
"getSourceColor": get_source_color,
"getTargetColor": get_target_color,
"getWidth": get_width,
"widthScale": width_scale,
"widthMinPixels": width_min_pixels,
"widthMaxPixels": width_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_column_layer(self, layer_id, data, get_position='position', get_elevation=0, get_fill_color=[255, 0, 0, 255], get_line_color=[0, 0, 0, 255], radius=1000, elevation_scale=1.0, filled=True, stroked=False, **kwargs)
¶
Add a column layer to the map.
Source code in anymap/anymap.py
def add_column_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_elevation: Union[str, int, float] = 0,
get_fill_color: Union[str, List[int]] = [255, 0, 0, 255],
get_line_color: Union[str, List[int]] = [0, 0, 0, 255],
radius: int = 1000,
elevation_scale: float = 1.0,
filled: bool = True,
stroked: bool = False,
**kwargs,
) -> None:
"""Add a column layer to the map."""
layer_config = {
"type": "ColumnLayer",
"data": data,
"getPosition": get_position,
"getElevation": get_elevation,
"getFillColor": get_fill_color,
"getLineColor": get_line_color,
"radius": radius,
"elevationScale": elevation_scale,
"filled": filled,
"stroked": stroked,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_geojson_layer(self, layer_id, data, get_fill_color=[255, 0, 0, 128], get_line_color=[0, 0, 0, 255], get_line_width=1, get_radius=100, filled=True, stroked=True, **kwargs)
¶
Add a GeoJSON layer to the map.
Source code in anymap/anymap.py
def add_geojson_layer(
self,
layer_id: str,
data: Dict[str, Any],
get_fill_color: Union[str, List[int]] = [255, 0, 0, 128],
get_line_color: Union[str, List[int]] = [0, 0, 0, 255],
get_line_width: Union[str, int, float] = 1,
get_radius: Union[str, int, float] = 100,
filled: bool = True,
stroked: bool = True,
**kwargs,
) -> None:
"""Add a GeoJSON layer to the map."""
layer_config = {
"type": "GeoJsonLayer",
"data": data,
"getFillColor": get_fill_color,
"getLineColor": get_line_color,
"getLineWidth": get_line_width,
"getRadius": get_radius,
"filled": filled,
"stroked": stroked,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_grid_layer(self, layer_id, data, get_position='position', get_weight=1, cell_size=200, elevation_scale=4, elevation_range=[0, 1000], coverage=1.0, color_range=None, **kwargs)
¶
Add a grid layer to the map.
Source code in anymap/anymap.py
def add_grid_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_weight: Union[str, int, float] = 1,
cell_size: int = 200,
elevation_scale: float = 4,
elevation_range: List[int] = [0, 1000],
coverage: float = 1.0,
color_range: Optional[List[List[int]]] = None,
**kwargs,
) -> None:
"""Add a grid layer to the map."""
if color_range is None:
color_range = [
[1, 152, 189],
[73, 227, 206],
[216, 254, 181],
[254, 237, 177],
[254, 173, 84],
[209, 55, 78],
]
layer_config = {
"type": "GridLayer",
"data": data,
"getPosition": get_position,
"getWeight": get_weight,
"cellSize": cell_size,
"elevationScale": elevation_scale,
"elevationRange": elevation_range,
"coverage": coverage,
"colorRange": color_range,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_heatmap_layer(self, layer_id, data, get_position='position', get_weight=1, radius_pixels=60, intensity=1.0, threshold=0.05, color_range=None, **kwargs)
¶
Add a heatmap layer to the map.
Source code in anymap/anymap.py
def add_heatmap_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_weight: Union[str, int, float] = 1,
radius_pixels: int = 60,
intensity: float = 1.0,
threshold: float = 0.05,
color_range: Optional[List[List[int]]] = None,
**kwargs,
) -> None:
"""Add a heatmap layer to the map."""
if color_range is None:
color_range = [
[255, 255, 178],
[254, 204, 92],
[253, 141, 60],
[240, 59, 32],
[189, 0, 38],
]
layer_config = {
"type": "HeatmapLayer",
"data": data,
"getPosition": get_position,
"getWeight": get_weight,
"radiusPixels": radius_pixels,
"intensity": intensity,
"threshold": threshold,
"colorRange": color_range,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_hexagon_layer(self, layer_id, data, get_position='position', get_weight=1, radius=1000, elevation_scale=4, elevation_range=[0, 1000], coverage=1.0, color_range=None, **kwargs)
¶
Add a hexagon layer to the map.
Source code in anymap/anymap.py
def add_hexagon_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_weight: Union[str, int, float] = 1,
radius: int = 1000,
elevation_scale: float = 4,
elevation_range: List[int] = [0, 1000],
coverage: float = 1.0,
color_range: Optional[List[List[int]]] = None,
**kwargs,
) -> None:
"""Add a hexagon layer to the map."""
if color_range is None:
color_range = [
[1, 152, 189],
[73, 227, 206],
[216, 254, 181],
[254, 237, 177],
[254, 173, 84],
[209, 55, 78],
]
layer_config = {
"type": "HexagonLayer",
"data": data,
"getPosition": get_position,
"getWeight": get_weight,
"radius": radius,
"elevationScale": elevation_scale,
"elevationRange": elevation_range,
"coverage": coverage,
"colorRange": color_range,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_icon_layer(self, layer_id, data, get_position='position', get_icon='icon', get_color=[255, 255, 255, 255], get_size=1, size_scale=1.0, icon_atlas=None, icon_mapping=None, **kwargs)
¶
Add an icon layer to the map.
Source code in anymap/anymap.py
def add_icon_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_icon: str = "icon",
get_color: Union[str, List[int]] = [255, 255, 255, 255],
get_size: Union[str, int, float] = 1,
size_scale: float = 1.0,
icon_atlas: Optional[str] = None,
icon_mapping: Optional[Dict[str, Any]] = None,
**kwargs,
) -> None:
"""Add an icon layer to the map."""
layer_config = {
"type": "IconLayer",
"data": data,
"getPosition": get_position,
"getIcon": get_icon,
"getColor": get_color,
"getSize": get_size,
"sizeScale": size_scale,
**kwargs,
}
if icon_atlas:
layer_config["iconAtlas"] = icon_atlas
if icon_mapping:
layer_config["iconMapping"] = icon_mapping
self.add_layer(layer_id, layer_config)
add_line_layer(self, layer_id, data, get_source_position='sourcePosition', get_target_position='targetPosition', get_color=[0, 255, 0, 255], get_width=1, width_scale=1.0, width_min_pixels=1, width_max_pixels=10, **kwargs)
¶
Add a line layer to the map.
Source code in anymap/anymap.py
def add_line_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_source_position: str = "sourcePosition",
get_target_position: str = "targetPosition",
get_color: Union[str, List[int]] = [0, 255, 0, 255],
get_width: Union[str, int, float] = 1,
width_scale: float = 1.0,
width_min_pixels: int = 1,
width_max_pixels: int = 10,
**kwargs,
) -> None:
"""Add a line layer to the map."""
layer_config = {
"type": "LineLayer",
"data": data,
"getSourcePosition": get_source_position,
"getTargetPosition": get_target_position,
"getColor": get_color,
"getWidth": get_width,
"widthScale": width_scale,
"widthMinPixels": width_min_pixels,
"widthMaxPixels": width_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_path_layer(self, layer_id, data, get_path='path', get_color=[255, 0, 0, 255], get_width=1, width_scale=1.0, width_min_pixels=1, width_max_pixels=10, **kwargs)
¶
Add a path layer to the map.
Source code in anymap/anymap.py
def add_path_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_path: str = "path",
get_color: Union[str, List[int]] = [255, 0, 0, 255],
get_width: Union[str, int, float] = 1,
width_scale: float = 1.0,
width_min_pixels: int = 1,
width_max_pixels: int = 10,
**kwargs,
) -> None:
"""Add a path layer to the map."""
layer_config = {
"type": "PathLayer",
"data": data,
"getPath": get_path,
"getColor": get_color,
"getWidth": get_width,
"widthScale": width_scale,
"widthMinPixels": width_min_pixels,
"widthMaxPixels": width_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_polygon_layer(self, layer_id, data, get_polygon='polygon', get_fill_color=[255, 0, 0, 128], get_line_color=[0, 0, 0, 255], get_line_width=1, filled=True, stroked=True, **kwargs)
¶
Add a polygon layer to the map.
Source code in anymap/anymap.py
def add_polygon_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_polygon: str = "polygon",
get_fill_color: Union[str, List[int]] = [255, 0, 0, 128],
get_line_color: Union[str, List[int]] = [0, 0, 0, 255],
get_line_width: Union[str, int, float] = 1,
filled: bool = True,
stroked: bool = True,
**kwargs,
) -> None:
"""Add a polygon layer to the map."""
layer_config = {
"type": "PolygonLayer",
"data": data,
"getPolygon": get_polygon,
"getFillColor": get_fill_color,
"getLineColor": get_line_color,
"getLineWidth": get_line_width,
"filled": filled,
"stroked": stroked,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_scatterplot_layer(self, layer_id, data, get_position='position', get_radius=100, get_color=[255, 0, 0, 255], radius_scale=1.0, radius_min_pixels=1, radius_max_pixels=100, **kwargs)
¶
Add a scatterplot layer to the map.
Source code in anymap/anymap.py
def add_scatterplot_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_radius: Union[str, int, float] = 100,
get_color: Union[str, List[int]] = [255, 0, 0, 255],
radius_scale: float = 1.0,
radius_min_pixels: int = 1,
radius_max_pixels: int = 100,
**kwargs,
) -> None:
"""Add a scatterplot layer to the map."""
layer_config = {
"type": "ScatterplotLayer",
"data": data,
"getPosition": get_position,
"getRadius": get_radius,
"getFillColor": get_color,
"radiusScale": radius_scale,
"radiusMinPixels": radius_min_pixels,
"radiusMaxPixels": radius_max_pixels,
**kwargs,
}
self.add_layer(layer_id, layer_config)
add_text_layer(self, layer_id, data, get_position='position', get_text='text', get_color=[0, 0, 0, 255], get_size=32, get_angle=0, font_family='Monaco, monospace', **kwargs)
¶
Add a text layer to the map.
Source code in anymap/anymap.py
def add_text_layer(
self,
layer_id: str,
data: List[Dict[str, Any]],
get_position: str = "position",
get_text: str = "text",
get_color: Union[str, List[int]] = [0, 0, 0, 255],
get_size: Union[str, int, float] = 32,
get_angle: Union[str, int, float] = 0,
font_family: str = "Monaco, monospace",
**kwargs,
) -> None:
"""Add a text layer to the map."""
layer_config = {
"type": "TextLayer",
"data": data,
"getPosition": get_position,
"getText": get_text,
"getColor": get_color,
"getSize": get_size,
"getAngle": get_angle,
"fontFamily": font_family,
**kwargs,
}
self.add_layer(layer_id, layer_config)
clear_all(self)
¶
Clear all layers from the map.
Source code in anymap/anymap.py
def clear_all(self) -> None:
"""Clear all layers from the map."""
self.clear_layers()
clear_layers(self)
¶
Remove all layers from the map.
Source code in anymap/anymap.py
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
enable_controller(self, enabled=True)
¶
Enable or disable map controls.
Source code in anymap/anymap.py
def enable_controller(self, enabled: bool = True) -> None:
"""Enable or disable map controls."""
self.controller = enabled
fit_bounds(self, bounds, padding=20, max_zoom=None)
¶
Fit the map to given bounds.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bounds |
List[List[float]] |
Bounds in format [[minLng, minLat], [maxLng, maxLat]] |
required |
padding |
Union[int, Dict[str, int]] |
Padding around bounds in pixels |
20 |
max_zoom |
Optional[float] |
Maximum zoom level when fitting |
None |
Source code in anymap/anymap.py
def fit_bounds(
self,
bounds: List[List[float]],
padding: Union[int, Dict[str, int]] = 20,
max_zoom: Optional[float] = None,
) -> None:
"""Fit the map to given bounds.
Args:
bounds: Bounds in format [[minLng, minLat], [maxLng, maxLat]]
padding: Padding around bounds in pixels
max_zoom: Maximum zoom level when fitting
"""
options = {"padding": padding}
if max_zoom is not None:
options["maxZoom"] = max_zoom
self.call_js_method("fitBounds", bounds, options)
get_layers(self)
¶
Get all layers currently on the map.
Source code in anymap/anymap.py
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
set_bearing(self, bearing)
¶
Set the map bearing (rotation).
Source code in anymap/anymap.py
def set_bearing(self, bearing: float) -> None:
"""Set the map bearing (rotation)."""
self.bearing = bearing
set_pitch(self, pitch)
¶
Set the map pitch (tilt).
Source code in anymap/anymap.py
def set_pitch(self, pitch: float) -> None:
"""Set the map pitch (tilt)."""
self.pitch = pitch
set_view_state(self, longitude=None, latitude=None, zoom=None, bearing=None, pitch=None)
¶
Set the view state of the map.
Source code in anymap/anymap.py
def set_view_state(
self,
longitude: Optional[float] = None,
latitude: Optional[float] = None,
zoom: Optional[float] = None,
bearing: Optional[float] = None,
pitch: Optional[float] = None,
) -> None:
"""Set the view state of the map."""
view_state = {}
if longitude is not None:
view_state["longitude"] = longitude
if latitude is not None:
view_state["latitude"] = latitude
if zoom is not None:
view_state["zoom"] = zoom
if bearing is not None:
view_state["bearing"] = bearing
if pitch is not None:
view_state["pitch"] = pitch
self.call_js_method("setViewState", view_state)
set_zoom_range(self, min_zoom, max_zoom)
¶
Set the zoom range for the map.
Source code in anymap/anymap.py
def set_zoom_range(self, min_zoom: float, max_zoom: float) -> None:
"""Set the zoom range for the map."""
self.min_zoom = min_zoom
self.max_zoom = max_zoom
update_layer(self, layer_id, **props)
¶
Update properties of an existing layer.
Source code in anymap/anymap.py
def update_layer(self, layer_id: str, **props) -> None:
"""Update properties of an existing layer."""
self.call_js_method("updateLayer", layer_id, props)
MapLibreMap (MapWidget)
¶
MapLibre GL JS implementation of the map widget.
Source code in anymap/anymap.py
class MapLibreMap(MapWidget):
"""MapLibre GL JS implementation of the map widget."""
# MapLibre-specific traits
map_style = traitlets.Unicode("https://demotiles.maplibre.org/style.json").tag(
sync=True
)
bearing = traitlets.Float(0.0).tag(sync=True)
pitch = traitlets.Float(0.0).tag(sync=True)
antialias = traitlets.Bool(True).tag(sync=True)
# Define the JavaScript module path
_esm = _esm_maplibre
_css = _css_maplibre
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
map_style: str = "https://demotiles.maplibre.org/style.json",
width: str = "100%",
height: str = "600px",
bearing: float = 0.0,
pitch: float = 0.0,
**kwargs,
):
"""Initialize MapLibre map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level
map_style: MapLibre style URL or style object
width: Widget width
height: Widget height
bearing: Map bearing (rotation) in degrees
pitch: Map pitch (tilt) in degrees
"""
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
map_style=map_style,
bearing=bearing,
pitch=pitch,
**kwargs,
)
def set_style(self, style: Union[str, Dict[str, Any]]) -> None:
"""Set the map style."""
if isinstance(style, str):
self.map_style = style
else:
self.call_js_method("setStyle", style)
def set_bearing(self, bearing: float) -> None:
"""Set the map bearing (rotation)."""
self.bearing = bearing
def set_pitch(self, pitch: float) -> None:
"""Set the map pitch (tilt)."""
self.pitch = pitch
def add_geojson_layer(
self,
layer_id: str,
geojson_data: Dict[str, Any],
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a GeoJSON layer to the map."""
source_id = f"{layer_id}_source"
# Add source
self.add_source(source_id, {"type": "geojson", "data": geojson_data})
# Add layer
layer_config = {"id": layer_id, "type": layer_type, "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
def add_marker(self, lat: float, lng: float, popup: Optional[str] = None) -> None:
"""Add a marker to the map."""
marker_data = {"coordinates": [lng, lat], "popup": popup}
self.call_js_method("addMarker", marker_data)
def fit_bounds(self, bounds: List[List[float]], padding: int = 50) -> None:
"""Fit the map to given bounds."""
self.call_js_method("fitBounds", bounds, {"padding": padding})
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
def get_sources(self) -> Dict[str, Dict[str, Any]]:
"""Get all sources currently on the map."""
return dict(self._sources)
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
def clear_sources(self) -> None:
"""Remove all sources from the map."""
for source_id in list(self._sources.keys()):
self.remove_source(source_id)
def clear_all(self) -> None:
"""Clear all layers and sources from the map."""
self.clear_layers()
self.clear_sources()
def add_raster_layer(
self,
layer_id: str,
source_url: str,
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a raster layer to the map."""
source_id = f"{layer_id}_source"
# Add raster source
self.add_source(
source_id, {"type": "raster", "tiles": [source_url], "tileSize": 256}
)
# Add raster layer
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
def add_vector_layer(
self,
layer_id: str,
source_url: str,
source_layer: str,
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a vector tile layer to the map."""
source_id = f"{layer_id}_source"
# Add vector source
self.add_source(source_id, {"type": "vector", "url": source_url})
# Add vector layer
layer_config = {
"id": layer_id,
"type": layer_type,
"source": source_id,
"source-layer": source_layer,
}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
def add_image_layer(
self,
layer_id: str,
image_url: str,
coordinates: List[List[float]],
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add an image layer to the map."""
source_id = f"{layer_id}_source"
# Add image source
self.add_source(
source_id, {"type": "image", "url": image_url, "coordinates": coordinates}
)
# Add raster layer for the image
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
def _generate_html_template(
self, map_state: Dict[str, Any], title: str, **kwargs
) -> str:
"""Generate HTML template for MapLibre GL JS."""
# Serialize map state for JavaScript
map_state_json = json.dumps(map_state, indent=2)
html_template = f"""<!DOCTYPE html>
<html>
<head>
<title>{title}</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script src="https://unpkg.com/maplibre-gl@4.7.1/dist/maplibre-gl.js"></script>
<link href="https://unpkg.com/maplibre-gl@4.7.1/dist/maplibre-gl.css" rel="stylesheet">
<style>
body {{
margin: 0;
padding: 20px;
font-family: Arial, sans-serif;
}}
#map {{
width: {map_state['width']};
height: {map_state['height']};
border: 1px solid #ccc;
}}
h1 {{
margin-top: 0;
color: #333;
}}
</style>
</head>
<body>
<h1>{title}</h1>
<div id="map"></div>
<script>
// Map state from Python
const mapState = {map_state_json};
// Initialize MapLibre map
const map = new maplibregl.Map({{
container: 'map',
style: mapState.map_style || 'https://demotiles.maplibre.org/style.json',
center: [mapState.center[1], mapState.center[0]], // Convert [lat, lng] to [lng, lat]
zoom: mapState.zoom || 2,
bearing: mapState.bearing || 0,
pitch: mapState.pitch || 0,
antialias: mapState.antialias !== undefined ? mapState.antialias : true
}});
// Restore layers and sources after map loads
map.on('load', function() {{
// Add sources first
const sources = mapState._sources || {{}};
Object.entries(sources).forEach(([sourceId, sourceConfig]) => {{
try {{
map.addSource(sourceId, sourceConfig);
}} catch (error) {{
console.warn(`Failed to add source ${{sourceId}}:`, error);
}}
}});
// Then add layers
const layers = mapState._layers || {{}};
Object.entries(layers).forEach(([layerId, layerConfig]) => {{
try {{
map.addLayer(layerConfig);
}} catch (error) {{
console.warn(`Failed to add layer ${{layerId}}:`, error);
}}
}});
}});
// Add navigation controls
map.addControl(new maplibregl.NavigationControl());
// Add scale control
map.addControl(new maplibregl.ScaleControl());
// Log map events for debugging
map.on('click', function(e) {{
console.log('Map clicked at:', e.lngLat);
}});
map.on('load', function() {{
console.log('Map loaded successfully');
}});
map.on('error', function(e) {{
console.error('Map error:', e);
}});
</script>
</body>
</html>"""
return html_template
__init__(self, center=[0.0, 0.0], zoom=2.0, map_style='https://demotiles.maplibre.org/style.json', width='100%', height='600px', bearing=0.0, pitch=0.0, **kwargs)
special
¶
Initialize MapLibre map widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
center |
List[float] |
Map center as [latitude, longitude] |
[0.0, 0.0] |
zoom |
float |
Initial zoom level |
2.0 |
map_style |
str |
MapLibre style URL or style object |
'https://demotiles.maplibre.org/style.json' |
width |
str |
Widget width |
'100%' |
height |
str |
Widget height |
'600px' |
bearing |
float |
Map bearing (rotation) in degrees |
0.0 |
pitch |
float |
Map pitch (tilt) in degrees |
0.0 |
Source code in anymap/anymap.py
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
map_style: str = "https://demotiles.maplibre.org/style.json",
width: str = "100%",
height: str = "600px",
bearing: float = 0.0,
pitch: float = 0.0,
**kwargs,
):
"""Initialize MapLibre map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level
map_style: MapLibre style URL or style object
width: Widget width
height: Widget height
bearing: Map bearing (rotation) in degrees
pitch: Map pitch (tilt) in degrees
"""
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
map_style=map_style,
bearing=bearing,
pitch=pitch,
**kwargs,
)
add_geojson_layer(self, layer_id, geojson_data, layer_type='fill', paint=None)
¶
Add a GeoJSON layer to the map.
Source code in anymap/anymap.py
def add_geojson_layer(
self,
layer_id: str,
geojson_data: Dict[str, Any],
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a GeoJSON layer to the map."""
source_id = f"{layer_id}_source"
# Add source
self.add_source(source_id, {"type": "geojson", "data": geojson_data})
# Add layer
layer_config = {"id": layer_id, "type": layer_type, "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
add_image_layer(self, layer_id, image_url, coordinates, paint=None)
¶
Add an image layer to the map.
Source code in anymap/anymap.py
def add_image_layer(
self,
layer_id: str,
image_url: str,
coordinates: List[List[float]],
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add an image layer to the map."""
source_id = f"{layer_id}_source"
# Add image source
self.add_source(
source_id, {"type": "image", "url": image_url, "coordinates": coordinates}
)
# Add raster layer for the image
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
add_marker(self, lat, lng, popup=None)
¶
Add a marker to the map.
Source code in anymap/anymap.py
def add_marker(self, lat: float, lng: float, popup: Optional[str] = None) -> None:
"""Add a marker to the map."""
marker_data = {"coordinates": [lng, lat], "popup": popup}
self.call_js_method("addMarker", marker_data)
add_raster_layer(self, layer_id, source_url, paint=None, layout=None)
¶
Add a raster layer to the map.
Source code in anymap/anymap.py
def add_raster_layer(
self,
layer_id: str,
source_url: str,
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a raster layer to the map."""
source_id = f"{layer_id}_source"
# Add raster source
self.add_source(
source_id, {"type": "raster", "tiles": [source_url], "tileSize": 256}
)
# Add raster layer
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
add_vector_layer(self, layer_id, source_url, source_layer, layer_type='fill', paint=None, layout=None)
¶
Add a vector tile layer to the map.
Source code in anymap/anymap.py
def add_vector_layer(
self,
layer_id: str,
source_url: str,
source_layer: str,
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a vector tile layer to the map."""
source_id = f"{layer_id}_source"
# Add vector source
self.add_source(source_id, {"type": "vector", "url": source_url})
# Add vector layer
layer_config = {
"id": layer_id,
"type": layer_type,
"source": source_id,
"source-layer": source_layer,
}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
clear_all(self)
¶
Clear all layers and sources from the map.
Source code in anymap/anymap.py
def clear_all(self) -> None:
"""Clear all layers and sources from the map."""
self.clear_layers()
self.clear_sources()
clear_layers(self)
¶
Remove all layers from the map.
Source code in anymap/anymap.py
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
clear_sources(self)
¶
Remove all sources from the map.
Source code in anymap/anymap.py
def clear_sources(self) -> None:
"""Remove all sources from the map."""
for source_id in list(self._sources.keys()):
self.remove_source(source_id)
fit_bounds(self, bounds, padding=50)
¶
Fit the map to given bounds.
Source code in anymap/anymap.py
def fit_bounds(self, bounds: List[List[float]], padding: int = 50) -> None:
"""Fit the map to given bounds."""
self.call_js_method("fitBounds", bounds, {"padding": padding})
get_layers(self)
¶
Get all layers currently on the map.
Source code in anymap/anymap.py
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
get_sources(self)
¶
Get all sources currently on the map.
Source code in anymap/anymap.py
def get_sources(self) -> Dict[str, Dict[str, Any]]:
"""Get all sources currently on the map."""
return dict(self._sources)
set_bearing(self, bearing)
¶
Set the map bearing (rotation).
Source code in anymap/anymap.py
def set_bearing(self, bearing: float) -> None:
"""Set the map bearing (rotation)."""
self.bearing = bearing
set_pitch(self, pitch)
¶
Set the map pitch (tilt).
Source code in anymap/anymap.py
def set_pitch(self, pitch: float) -> None:
"""Set the map pitch (tilt)."""
self.pitch = pitch
set_style(self, style)
¶
Set the map style.
Source code in anymap/anymap.py
def set_style(self, style: Union[str, Dict[str, Any]]) -> None:
"""Set the map style."""
if isinstance(style, str):
self.map_style = style
else:
self.call_js_method("setStyle", style)
MapWidget (AnyWidget)
¶
Base class for interactive map widgets using anywidget.
Source code in anymap/anymap.py
class MapWidget(anywidget.AnyWidget):
"""Base class for interactive map widgets using anywidget."""
# Widget traits for communication with JavaScript
center = traitlets.List([0.0, 0.0]).tag(sync=True)
zoom = traitlets.Float(2.0).tag(sync=True)
width = traitlets.Unicode("100%").tag(sync=True)
height = traitlets.Unicode("600px").tag(sync=True)
style = traitlets.Unicode("").tag(sync=True)
# Communication traits
_js_calls = traitlets.List([]).tag(sync=True)
_js_events = traitlets.List([]).tag(sync=True)
# Internal state
_layers = traitlets.Dict({}).tag(sync=True)
_sources = traitlets.Dict({}).tag(sync=True)
def __init__(self, **kwargs):
"""Initialize the map widget."""
super().__init__(**kwargs)
self._event_handlers = {}
self._js_method_counter = 0
def call_js_method(self, method_name: str, *args, **kwargs) -> None:
"""Call a JavaScript method on the map instance."""
call_data = {
"id": self._js_method_counter,
"method": method_name,
"args": args,
"kwargs": kwargs,
}
self._js_method_counter += 1
# Trigger sync by creating new list
current_calls = list(self._js_calls)
current_calls.append(call_data)
self._js_calls = current_calls
def on_map_event(self, event_type: str, callback):
"""Register a callback for map events."""
if event_type not in self._event_handlers:
self._event_handlers[event_type] = []
self._event_handlers[event_type].append(callback)
@traitlets.observe("_js_events")
def _handle_js_events(self, change):
"""Handle events from JavaScript."""
events = change["new"]
for event in events:
event_type = event.get("type")
if event_type in self._event_handlers:
for handler in self._event_handlers[event_type]:
handler(event)
def set_center(self, lat: float, lng: float) -> None:
"""Set the map center."""
self.center = [lat, lng]
def set_zoom(self, zoom: float) -> None:
"""Set the map zoom level."""
self.zoom = zoom
def fly_to(self, lat: float, lng: float, zoom: Optional[float] = None) -> None:
"""Fly to a specific location."""
options = {"center": [lat, lng]}
if zoom is not None:
options["zoom"] = zoom
self.call_js_method("flyTo", options)
def add_layer(self, layer_id: str, layer_config: Dict[str, Any]) -> None:
"""Add a layer to the map."""
# Store layer in local state for persistence
current_layers = dict(self._layers)
current_layers[layer_id] = layer_config
self._layers = current_layers
self.call_js_method("addLayer", layer_config, layer_id)
def remove_layer(self, layer_id: str) -> None:
"""Remove a layer from the map."""
# Remove from local state
current_layers = dict(self._layers)
if layer_id in current_layers:
del current_layers[layer_id]
self._layers = current_layers
self.call_js_method("removeLayer", layer_id)
def add_source(self, source_id: str, source_config: Dict[str, Any]) -> None:
"""Add a data source to the map."""
# Store source in local state for persistence
current_sources = dict(self._sources)
current_sources[source_id] = source_config
self._sources = current_sources
self.call_js_method("addSource", source_id, source_config)
def remove_source(self, source_id: str) -> None:
"""Remove a data source from the map."""
# Remove from local state
current_sources = dict(self._sources)
if source_id in current_sources:
del current_sources[source_id]
self._sources = current_sources
self.call_js_method("removeSource", source_id)
def to_html(
self,
filename: Optional[str] = None,
title: str = "Anymap Export",
width: str = "100%",
height: str = "600px",
**kwargs,
) -> str:
"""Export the map to a standalone HTML file.
Args:
filename: Optional filename to save the HTML. If None, returns HTML string.
title: Title for the HTML page
width: Width of the map container
height: Height of the map container
**kwargs: Additional arguments passed to the HTML template
Returns:
HTML string content
"""
# Get the current map state
map_state = {
"center": self.center,
"zoom": self.zoom,
"width": width,
"height": height,
"style": self.style,
"_layers": dict(self._layers),
"_sources": dict(self._sources),
}
# Add class-specific attributes
if hasattr(self, "map_style"):
map_state["map_style"] = self.map_style
if hasattr(self, "bearing"):
map_state["bearing"] = self.bearing
if hasattr(self, "pitch"):
map_state["pitch"] = self.pitch
if hasattr(self, "antialias"):
map_state["antialias"] = self.antialias
if hasattr(self, "access_token"):
map_state["access_token"] = self.access_token
# Generate HTML content
html_content = self._generate_html_template(map_state, title, **kwargs)
# Save to file if filename is provided
if filename:
with open(filename, "w", encoding="utf-8") as f:
f.write(html_content)
return html_content
def _generate_html_template(
self, map_state: Dict[str, Any], title: str, **kwargs
) -> str:
"""Generate the HTML template with map state.
This method should be overridden by subclasses to provide library-specific templates.
"""
raise NotImplementedError("Subclasses must implement _generate_html_template")
__init__(self, **kwargs)
special
¶
Initialize the map widget.
Source code in anymap/anymap.py
def __init__(self, **kwargs):
"""Initialize the map widget."""
super().__init__(**kwargs)
self._event_handlers = {}
self._js_method_counter = 0
add_layer(self, layer_id, layer_config)
¶
Add a layer to the map.
Source code in anymap/anymap.py
def add_layer(self, layer_id: str, layer_config: Dict[str, Any]) -> None:
"""Add a layer to the map."""
# Store layer in local state for persistence
current_layers = dict(self._layers)
current_layers[layer_id] = layer_config
self._layers = current_layers
self.call_js_method("addLayer", layer_config, layer_id)
add_source(self, source_id, source_config)
¶
Add a data source to the map.
Source code in anymap/anymap.py
def add_source(self, source_id: str, source_config: Dict[str, Any]) -> None:
"""Add a data source to the map."""
# Store source in local state for persistence
current_sources = dict(self._sources)
current_sources[source_id] = source_config
self._sources = current_sources
self.call_js_method("addSource", source_id, source_config)
call_js_method(self, method_name, *args, **kwargs)
¶
Call a JavaScript method on the map instance.
Source code in anymap/anymap.py
def call_js_method(self, method_name: str, *args, **kwargs) -> None:
"""Call a JavaScript method on the map instance."""
call_data = {
"id": self._js_method_counter,
"method": method_name,
"args": args,
"kwargs": kwargs,
}
self._js_method_counter += 1
# Trigger sync by creating new list
current_calls = list(self._js_calls)
current_calls.append(call_data)
self._js_calls = current_calls
fly_to(self, lat, lng, zoom=None)
¶
Fly to a specific location.
Source code in anymap/anymap.py
def fly_to(self, lat: float, lng: float, zoom: Optional[float] = None) -> None:
"""Fly to a specific location."""
options = {"center": [lat, lng]}
if zoom is not None:
options["zoom"] = zoom
self.call_js_method("flyTo", options)
on_map_event(self, event_type, callback)
¶
Register a callback for map events.
Source code in anymap/anymap.py
def on_map_event(self, event_type: str, callback):
"""Register a callback for map events."""
if event_type not in self._event_handlers:
self._event_handlers[event_type] = []
self._event_handlers[event_type].append(callback)
remove_layer(self, layer_id)
¶
Remove a layer from the map.
Source code in anymap/anymap.py
def remove_layer(self, layer_id: str) -> None:
"""Remove a layer from the map."""
# Remove from local state
current_layers = dict(self._layers)
if layer_id in current_layers:
del current_layers[layer_id]
self._layers = current_layers
self.call_js_method("removeLayer", layer_id)
remove_source(self, source_id)
¶
Remove a data source from the map.
Source code in anymap/anymap.py
def remove_source(self, source_id: str) -> None:
"""Remove a data source from the map."""
# Remove from local state
current_sources = dict(self._sources)
if source_id in current_sources:
del current_sources[source_id]
self._sources = current_sources
self.call_js_method("removeSource", source_id)
set_center(self, lat, lng)
¶
Set the map center.
Source code in anymap/anymap.py
def set_center(self, lat: float, lng: float) -> None:
"""Set the map center."""
self.center = [lat, lng]
set_zoom(self, zoom)
¶
Set the map zoom level.
Source code in anymap/anymap.py
def set_zoom(self, zoom: float) -> None:
"""Set the map zoom level."""
self.zoom = zoom
to_html(self, filename=None, title='Anymap Export', width='100%', height='600px', **kwargs)
¶
Export the map to a standalone HTML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename |
Optional[str] |
Optional filename to save the HTML. If None, returns HTML string. |
None |
title |
str |
Title for the HTML page |
'Anymap Export' |
width |
str |
Width of the map container |
'100%' |
height |
str |
Height of the map container |
'600px' |
**kwargs |
Additional arguments passed to the HTML template |
{} |
Returns:
| Type | Description |
|---|---|
str |
HTML string content |
Source code in anymap/anymap.py
def to_html(
self,
filename: Optional[str] = None,
title: str = "Anymap Export",
width: str = "100%",
height: str = "600px",
**kwargs,
) -> str:
"""Export the map to a standalone HTML file.
Args:
filename: Optional filename to save the HTML. If None, returns HTML string.
title: Title for the HTML page
width: Width of the map container
height: Height of the map container
**kwargs: Additional arguments passed to the HTML template
Returns:
HTML string content
"""
# Get the current map state
map_state = {
"center": self.center,
"zoom": self.zoom,
"width": width,
"height": height,
"style": self.style,
"_layers": dict(self._layers),
"_sources": dict(self._sources),
}
# Add class-specific attributes
if hasattr(self, "map_style"):
map_state["map_style"] = self.map_style
if hasattr(self, "bearing"):
map_state["bearing"] = self.bearing
if hasattr(self, "pitch"):
map_state["pitch"] = self.pitch
if hasattr(self, "antialias"):
map_state["antialias"] = self.antialias
if hasattr(self, "access_token"):
map_state["access_token"] = self.access_token
# Generate HTML content
html_content = self._generate_html_template(map_state, title, **kwargs)
# Save to file if filename is provided
if filename:
with open(filename, "w", encoding="utf-8") as f:
f.write(html_content)
return html_content
MapboxMap (MapWidget)
¶
Mapbox GL JS implementation of the map widget.
Source code in anymap/anymap.py
class MapboxMap(MapWidget):
"""Mapbox GL JS implementation of the map widget."""
# Mapbox-specific traits
map_style = traitlets.Unicode("mapbox://styles/mapbox/streets-v12").tag(sync=True)
bearing = traitlets.Float(0.0).tag(sync=True)
pitch = traitlets.Float(0.0).tag(sync=True)
antialias = traitlets.Bool(True).tag(sync=True)
access_token = traitlets.Unicode("").tag(sync=True)
# Define the JavaScript module path
_esm = _esm_mapbox
_css = _css_mapbox
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
map_style: str = "mapbox://styles/mapbox/streets-v12",
width: str = "100%",
height: str = "600px",
bearing: float = 0.0,
pitch: float = 0.0,
access_token: str = "",
**kwargs,
):
"""Initialize Mapbox map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level
map_style: Mapbox style URL or style object
width: Widget width
height: Widget height
bearing: Map bearing (rotation) in degrees
pitch: Map pitch (tilt) in degrees
access_token: Mapbox access token (required for Mapbox services).
Get a free token at https://account.mapbox.com/access-tokens/
Can also be set via MAPBOX_TOKEN environment variable.
"""
# Set default access token if not provided
if not access_token:
access_token = self._get_default_access_token()
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
map_style=map_style,
bearing=bearing,
pitch=pitch,
access_token=access_token,
**kwargs,
)
@staticmethod
def _get_default_access_token() -> str:
"""Get default Mapbox access token from environment or return demo token."""
import os
# Try to get from environment variable
token = os.environ.get("MAPBOX_TOKEN") or os.environ.get("MAPBOX_ACCESS_TOKEN")
# If no token found, return empty string - user must provide their own token
if not token:
import warnings
warnings.warn(
"No Mapbox access token found. Please set MAPBOX_ACCESS_TOKEN environment variable "
"or pass access_token parameter. Get a free token at https://account.mapbox.com/access-tokens/",
UserWarning,
)
token = ""
return token
def set_access_token(self, token: str) -> None:
"""Set the Mapbox access token."""
self.access_token = token
def set_style(self, style: Union[str, Dict[str, Any]]) -> None:
"""Set the map style."""
if isinstance(style, str):
self.map_style = style
else:
self.call_js_method("setStyle", style)
def set_bearing(self, bearing: float) -> None:
"""Set the map bearing (rotation)."""
self.bearing = bearing
def set_pitch(self, pitch: float) -> None:
"""Set the map pitch (tilt)."""
self.pitch = pitch
def add_geojson_layer(
self,
layer_id: str,
geojson_data: Dict[str, Any],
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a GeoJSON layer to the map."""
source_id = f"{layer_id}_source"
# Add source
self.add_source(source_id, {"type": "geojson", "data": geojson_data})
# Add layer
layer_config = {"id": layer_id, "type": layer_type, "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
def add_marker(self, lat: float, lng: float, popup: Optional[str] = None) -> None:
"""Add a marker to the map."""
marker_data = {"coordinates": [lng, lat], "popup": popup}
self.call_js_method("addMarker", marker_data)
def fit_bounds(self, bounds: List[List[float]], padding: int = 50) -> None:
"""Fit the map to given bounds."""
self.call_js_method("fitBounds", bounds, {"padding": padding})
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
def get_sources(self) -> Dict[str, Dict[str, Any]]:
"""Get all sources currently on the map."""
return dict(self._sources)
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
def clear_sources(self) -> None:
"""Remove all sources from the map."""
for source_id in list(self._sources.keys()):
self.remove_source(source_id)
def clear_all(self) -> None:
"""Clear all layers and sources from the map."""
self.clear_layers()
self.clear_sources()
def add_raster_layer(
self,
layer_id: str,
source_url: str,
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a raster layer to the map."""
source_id = f"{layer_id}_source"
# Add raster source
self.add_source(
source_id, {"type": "raster", "tiles": [source_url], "tileSize": 256}
)
# Add raster layer
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
def add_vector_layer(
self,
layer_id: str,
source_url: str,
source_layer: str,
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a vector tile layer to the map."""
source_id = f"{layer_id}_source"
# Add vector source
self.add_source(source_id, {"type": "vector", "url": source_url})
# Add vector layer
layer_config = {
"id": layer_id,
"type": layer_type,
"source": source_id,
"source-layer": source_layer,
}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
def add_image_layer(
self,
layer_id: str,
image_url: str,
coordinates: List[List[float]],
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add an image layer to the map."""
source_id = f"{layer_id}_source"
# Add image source
self.add_source(
source_id, {"type": "image", "url": image_url, "coordinates": coordinates}
)
# Add raster layer for the image
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
def add_control(
self,
control_type: str,
position: str = "top-right",
options: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a control to the map.
Args:
control_type: Type of control ('navigation', 'scale', 'fullscreen', 'geolocate')
position: Position on map ('top-left', 'top-right', 'bottom-left', 'bottom-right')
options: Additional options for the control
"""
control_options = options or {}
control_options["position"] = position
self.call_js_method("addControl", control_type, control_options)
def set_terrain(self, terrain_config: Optional[Dict[str, Any]] = None) -> None:
"""Set 3D terrain on the map.
Args:
terrain_config: Terrain configuration dict, or None to remove terrain
"""
self.call_js_method("setTerrain", terrain_config)
def set_fog(self, fog_config: Optional[Dict[str, Any]] = None) -> None:
"""Set atmospheric fog on the map.
Args:
fog_config: Fog configuration dict, or None to remove fog
"""
self.call_js_method("setFog", fog_config)
def add_3d_buildings(self, layer_id: str = "3d-buildings") -> None:
"""Add 3D buildings layer to the map."""
# Add the layer for 3D buildings
layer_config = {
"id": layer_id,
"source": "composite",
"source-layer": "building",
"filter": ["==", "extrude", "true"],
"type": "fill-extrusion",
"minzoom": 15,
"paint": {
"fill-extrusion-color": "#aaa",
"fill-extrusion-height": [
"interpolate",
["linear"],
["zoom"],
15,
0,
15.05,
["get", "height"],
],
"fill-extrusion-base": [
"interpolate",
["linear"],
["zoom"],
15,
0,
15.05,
["get", "min_height"],
],
"fill-extrusion-opacity": 0.6,
},
}
self.add_layer(layer_id, layer_config)
def _generate_html_template(
self, map_state: Dict[str, Any], title: str, **kwargs
) -> str:
"""Generate HTML template for Mapbox GL JS."""
# Serialize map state for JavaScript
map_state_json = json.dumps(map_state, indent=2)
html_template = f"""<!DOCTYPE html>
<html>
<head>
<title>{title}</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script src="https://api.mapbox.com/mapbox-gl-js/v3.6.0/mapbox-gl.js"></script>
<link href="https://api.mapbox.com/mapbox-gl-js/v3.6.0/mapbox-gl.css" rel="stylesheet">
<style>
body {{
margin: 0;
padding: 20px;
font-family: Arial, sans-serif;
}}
#map {{
width: {map_state['width']};
height: {map_state['height']};
border: 1px solid #ccc;
}}
h1 {{
margin-top: 0;
color: #333;
}}
.access-token-warning {{
background-color: #fff3cd;
border: 1px solid #ffeaa7;
color: #856404;
padding: 10px;
margin-bottom: 20px;
border-radius: 4px;
}}
</style>
</head>
<body>
<h1>{title}</h1>
{"<div class='access-token-warning'>Warning: This map requires a Mapbox access token. Please add your token to the mapboxgl.accessToken property.</div>" if not map_state.get('access_token') else ""}
<div id="map"></div>
<script>
// Map state from Python
const mapState = {map_state_json};
// Set Mapbox access token
mapboxgl.accessToken = mapState.access_token || '';
// Initialize Mapbox map
const map = new mapboxgl.Map({{
container: 'map',
style: mapState.map_style || 'mapbox://styles/mapbox/streets-v12',
center: [mapState.center[1], mapState.center[0]], // Convert [lat, lng] to [lng, lat]
zoom: mapState.zoom || 2,
bearing: mapState.bearing || 0,
pitch: mapState.pitch || 0,
antialias: mapState.antialias !== undefined ? mapState.antialias : true
}});
// Restore layers and sources after map loads
map.on('load', function() {{
// Add sources first
const sources = mapState._sources || {{}};
Object.entries(sources).forEach(([sourceId, sourceConfig]) => {{
try {{
map.addSource(sourceId, sourceConfig);
}} catch (error) {{
console.warn(`Failed to add source ${{sourceId}}:`, error);
}}
}});
// Then add layers
const layers = mapState._layers || {{}};
Object.entries(layers).forEach(([layerId, layerConfig]) => {{
try {{
map.addLayer(layerConfig);
}} catch (error) {{
console.warn(`Failed to add layer ${{layerId}}:`, error);
}}
}});
}});
// Add navigation controls
map.addControl(new mapboxgl.NavigationControl());
// Add scale control
map.addControl(new mapboxgl.ScaleControl());
// Log map events for debugging
map.on('click', function(e) {{
console.log('Map clicked at:', e.lngLat);
}});
map.on('load', function() {{
console.log('Map loaded successfully');
}});
map.on('error', function(e) {{
console.error('Map error:', e);
}});
</script>
</body>
</html>"""
return html_template
__init__(self, center=[0.0, 0.0], zoom=2.0, map_style='mapbox://styles/mapbox/streets-v12', width='100%', height='600px', bearing=0.0, pitch=0.0, access_token='', **kwargs)
special
¶
Initialize Mapbox map widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
center |
List[float] |
Map center as [latitude, longitude] |
[0.0, 0.0] |
zoom |
float |
Initial zoom level |
2.0 |
map_style |
str |
Mapbox style URL or style object |
'mapbox://styles/mapbox/streets-v12' |
width |
str |
Widget width |
'100%' |
height |
str |
Widget height |
'600px' |
bearing |
float |
Map bearing (rotation) in degrees |
0.0 |
pitch |
float |
Map pitch (tilt) in degrees |
0.0 |
access_token |
str |
Mapbox access token (required for Mapbox services). Get a free token at https://account.mapbox.com/access-tokens/ Can also be set via MAPBOX_TOKEN environment variable. |
'' |
Source code in anymap/anymap.py
def __init__(
self,
center: List[float] = [0.0, 0.0],
zoom: float = 2.0,
map_style: str = "mapbox://styles/mapbox/streets-v12",
width: str = "100%",
height: str = "600px",
bearing: float = 0.0,
pitch: float = 0.0,
access_token: str = "",
**kwargs,
):
"""Initialize Mapbox map widget.
Args:
center: Map center as [latitude, longitude]
zoom: Initial zoom level
map_style: Mapbox style URL or style object
width: Widget width
height: Widget height
bearing: Map bearing (rotation) in degrees
pitch: Map pitch (tilt) in degrees
access_token: Mapbox access token (required for Mapbox services).
Get a free token at https://account.mapbox.com/access-tokens/
Can also be set via MAPBOX_TOKEN environment variable.
"""
# Set default access token if not provided
if not access_token:
access_token = self._get_default_access_token()
super().__init__(
center=center,
zoom=zoom,
width=width,
height=height,
map_style=map_style,
bearing=bearing,
pitch=pitch,
access_token=access_token,
**kwargs,
)
add_3d_buildings(self, layer_id='3d-buildings')
¶
Add 3D buildings layer to the map.
Source code in anymap/anymap.py
def add_3d_buildings(self, layer_id: str = "3d-buildings") -> None:
"""Add 3D buildings layer to the map."""
# Add the layer for 3D buildings
layer_config = {
"id": layer_id,
"source": "composite",
"source-layer": "building",
"filter": ["==", "extrude", "true"],
"type": "fill-extrusion",
"minzoom": 15,
"paint": {
"fill-extrusion-color": "#aaa",
"fill-extrusion-height": [
"interpolate",
["linear"],
["zoom"],
15,
0,
15.05,
["get", "height"],
],
"fill-extrusion-base": [
"interpolate",
["linear"],
["zoom"],
15,
0,
15.05,
["get", "min_height"],
],
"fill-extrusion-opacity": 0.6,
},
}
self.add_layer(layer_id, layer_config)
add_control(self, control_type, position='top-right', options=None)
¶
Add a control to the map.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
control_type |
str |
Type of control ('navigation', 'scale', 'fullscreen', 'geolocate') |
required |
position |
str |
Position on map ('top-left', 'top-right', 'bottom-left', 'bottom-right') |
'top-right' |
options |
Optional[Dict[str, Any]] |
Additional options for the control |
None |
Source code in anymap/anymap.py
def add_control(
self,
control_type: str,
position: str = "top-right",
options: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a control to the map.
Args:
control_type: Type of control ('navigation', 'scale', 'fullscreen', 'geolocate')
position: Position on map ('top-left', 'top-right', 'bottom-left', 'bottom-right')
options: Additional options for the control
"""
control_options = options or {}
control_options["position"] = position
self.call_js_method("addControl", control_type, control_options)
add_geojson_layer(self, layer_id, geojson_data, layer_type='fill', paint=None)
¶
Add a GeoJSON layer to the map.
Source code in anymap/anymap.py
def add_geojson_layer(
self,
layer_id: str,
geojson_data: Dict[str, Any],
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a GeoJSON layer to the map."""
source_id = f"{layer_id}_source"
# Add source
self.add_source(source_id, {"type": "geojson", "data": geojson_data})
# Add layer
layer_config = {"id": layer_id, "type": layer_type, "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
add_image_layer(self, layer_id, image_url, coordinates, paint=None)
¶
Add an image layer to the map.
Source code in anymap/anymap.py
def add_image_layer(
self,
layer_id: str,
image_url: str,
coordinates: List[List[float]],
paint: Optional[Dict[str, Any]] = None,
) -> None:
"""Add an image layer to the map."""
source_id = f"{layer_id}_source"
# Add image source
self.add_source(
source_id, {"type": "image", "url": image_url, "coordinates": coordinates}
)
# Add raster layer for the image
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
self.add_layer(layer_id, layer_config)
add_marker(self, lat, lng, popup=None)
¶
Add a marker to the map.
Source code in anymap/anymap.py
def add_marker(self, lat: float, lng: float, popup: Optional[str] = None) -> None:
"""Add a marker to the map."""
marker_data = {"coordinates": [lng, lat], "popup": popup}
self.call_js_method("addMarker", marker_data)
add_raster_layer(self, layer_id, source_url, paint=None, layout=None)
¶
Add a raster layer to the map.
Source code in anymap/anymap.py
def add_raster_layer(
self,
layer_id: str,
source_url: str,
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a raster layer to the map."""
source_id = f"{layer_id}_source"
# Add raster source
self.add_source(
source_id, {"type": "raster", "tiles": [source_url], "tileSize": 256}
)
# Add raster layer
layer_config = {"id": layer_id, "type": "raster", "source": source_id}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
add_vector_layer(self, layer_id, source_url, source_layer, layer_type='fill', paint=None, layout=None)
¶
Add a vector tile layer to the map.
Source code in anymap/anymap.py
def add_vector_layer(
self,
layer_id: str,
source_url: str,
source_layer: str,
layer_type: str = "fill",
paint: Optional[Dict[str, Any]] = None,
layout: Optional[Dict[str, Any]] = None,
) -> None:
"""Add a vector tile layer to the map."""
source_id = f"{layer_id}_source"
# Add vector source
self.add_source(source_id, {"type": "vector", "url": source_url})
# Add vector layer
layer_config = {
"id": layer_id,
"type": layer_type,
"source": source_id,
"source-layer": source_layer,
}
if paint:
layer_config["paint"] = paint
if layout:
layer_config["layout"] = layout
self.add_layer(layer_id, layer_config)
clear_all(self)
¶
Clear all layers and sources from the map.
Source code in anymap/anymap.py
def clear_all(self) -> None:
"""Clear all layers and sources from the map."""
self.clear_layers()
self.clear_sources()
clear_layers(self)
¶
Remove all layers from the map.
Source code in anymap/anymap.py
def clear_layers(self) -> None:
"""Remove all layers from the map."""
for layer_id in list(self._layers.keys()):
self.remove_layer(layer_id)
clear_sources(self)
¶
Remove all sources from the map.
Source code in anymap/anymap.py
def clear_sources(self) -> None:
"""Remove all sources from the map."""
for source_id in list(self._sources.keys()):
self.remove_source(source_id)
fit_bounds(self, bounds, padding=50)
¶
Fit the map to given bounds.
Source code in anymap/anymap.py
def fit_bounds(self, bounds: List[List[float]], padding: int = 50) -> None:
"""Fit the map to given bounds."""
self.call_js_method("fitBounds", bounds, {"padding": padding})
get_layers(self)
¶
Get all layers currently on the map.
Source code in anymap/anymap.py
def get_layers(self) -> Dict[str, Dict[str, Any]]:
"""Get all layers currently on the map."""
return dict(self._layers)
get_sources(self)
¶
Get all sources currently on the map.
Source code in anymap/anymap.py
def get_sources(self) -> Dict[str, Dict[str, Any]]:
"""Get all sources currently on the map."""
return dict(self._sources)
set_access_token(self, token)
¶
Set the Mapbox access token.
Source code in anymap/anymap.py
def set_access_token(self, token: str) -> None:
"""Set the Mapbox access token."""
self.access_token = token
set_bearing(self, bearing)
¶
Set the map bearing (rotation).
Source code in anymap/anymap.py
def set_bearing(self, bearing: float) -> None:
"""Set the map bearing (rotation)."""
self.bearing = bearing
set_fog(self, fog_config=None)
¶
Set atmospheric fog on the map.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fog_config |
Optional[Dict[str, Any]] |
Fog configuration dict, or None to remove fog |
None |
Source code in anymap/anymap.py
def set_fog(self, fog_config: Optional[Dict[str, Any]] = None) -> None:
"""Set atmospheric fog on the map.
Args:
fog_config: Fog configuration dict, or None to remove fog
"""
self.call_js_method("setFog", fog_config)
set_pitch(self, pitch)
¶
Set the map pitch (tilt).
Source code in anymap/anymap.py
def set_pitch(self, pitch: float) -> None:
"""Set the map pitch (tilt)."""
self.pitch = pitch
set_style(self, style)
¶
Set the map style.
Source code in anymap/anymap.py
def set_style(self, style: Union[str, Dict[str, Any]]) -> None:
"""Set the map style."""
if isinstance(style, str):
self.map_style = style
else:
self.call_js_method("setStyle", style)
set_terrain(self, terrain_config=None)
¶
Set 3D terrain on the map.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
terrain_config |
Optional[Dict[str, Any]] |
Terrain configuration dict, or None to remove terrain |
None |
Source code in anymap/anymap.py
def set_terrain(self, terrain_config: Optional[Dict[str, Any]] = None) -> None:
"""Set 3D terrain on the map.
Args:
terrain_config: Terrain configuration dict, or None to remove terrain
"""
self.call_js_method("setTerrain", terrain_config)
PotreeMap (MapWidget)
¶
Potree point cloud viewer implementation of the map widget.
Source code in anymap/anymap.py
class PotreeMap(MapWidget):
"""Potree point cloud viewer implementation of the map widget."""
# Potree-specific traits
point_cloud_url = traitlets.Unicode("").tag(sync=True)
point_size = traitlets.Float(1.0).tag(sync=True)
point_size_type = traitlets.Unicode("adaptive").tag(
sync=True
) # "fixed", "adaptive", "attenuation"
point_shape = traitlets.Unicode("square").tag(sync=True) # "square", "circle"
min_node_size = traitlets.Float(100.0).tag(sync=True)
show_grid = traitlets.Bool(False).tag(sync=True)
grid_size = traitlets.Float(10.0).tag(sync=True)
grid_color = traitlets.Unicode("#aaaaaa").tag(sync=True)
background_color = traitlets.Unicode("#000000").tag(sync=True)
edl_enabled = traitlets.Bool(True).tag(sync=True) # Eye Dome Lighting
edl_radius = traitlets.Float(1.0).tag(sync=True)
edl_strength = traitlets.Float(1.0).tag(sync=True)
# Camera controls
camera_position = traitlets.List([0.0, 0.0, 10.0]).tag(sync=True)
camera_target = traitlets.List([0.0, 0.0, 0.0]).tag(sync=True)
fov = traitlets.Float(60.0).tag(sync=True)
near_clip = traitlets.Float(0.1).tag(sync=True)
far_clip = traitlets.Float(1000.0).tag(sync=True)
# Define the JavaScript module path
_esm = _esm_potree
_css = _css_potree
def __init__(
self,
point_cloud_url: str = "",
width: str = "100%",
height: str = "600px",
point_size: float = 1.0,
point_size_type: str = "adaptive",
point_shape: str = "square",
camera_position: List[float] = [0.0, 0.0, 10.0],
camera_target: List[float] = [0.0, 0.0, 0.0],
fov: float = 60.0,
background_color: str = "#000000",
edl_enabled: bool = True,
show_grid: bool = False,
**kwargs,
):
"""Initialize Potree map widget.
Args:
point_cloud_url: URL to the point cloud metadata.json file
width: Widget width
height: Widget height
point_size: Size of rendered points
point_size_type: How point size is calculated ("fixed", "adaptive", "attenuation")
point_shape: Shape of rendered points ("square", "circle")
camera_position: Initial camera position [x, y, z]
camera_target: Camera look-at target [x, y, z]
fov: Field of view in degrees
background_color: Background color of the viewer
edl_enabled: Enable Eye Dome Lighting for better depth perception
show_grid: Show coordinate grid
"""
super().__init__(
width=width,
height=height,
point_cloud_url=point_cloud_url,
point_size=point_size,
point_size_type=point_size_type,
point_shape=point_shape,
camera_position=camera_position,
camera_target=camera_target,
fov=fov,
background_color=background_color,
edl_enabled=edl_enabled,
show_grid=show_grid,
**kwargs,
)
def load_point_cloud(
self, point_cloud_url: str, point_cloud_name: Optional[str] = None
) -> None:
"""Load a point cloud from URL.
Args:
point_cloud_url: URL to the point cloud metadata.json file
point_cloud_name: Optional name for the point cloud
"""
self.point_cloud_url = point_cloud_url
options = {"url": point_cloud_url}
if point_cloud_name:
options["name"] = point_cloud_name
self.call_js_method("loadPointCloud", options)
def set_point_size(self, size: float) -> None:
"""Set the point size."""
self.point_size = size
def set_point_size_type(self, size_type: str) -> None:
"""Set the point size type.
Args:
size_type: "fixed", "adaptive", or "attenuation"
"""
if size_type not in ["fixed", "adaptive", "attenuation"]:
raise ValueError("size_type must be 'fixed', 'adaptive', or 'attenuation'")
self.point_size_type = size_type
def set_point_shape(self, shape: str) -> None:
"""Set the point shape.
Args:
shape: "square" or "circle"
"""
if shape not in ["square", "circle"]:
raise ValueError("shape must be 'square' or 'circle'")
self.point_shape = shape
def set_camera_position(
self, position: List[float], target: Optional[List[float]] = None
) -> None:
"""Set camera position and optionally target.
Args:
position: Camera position [x, y, z]
target: Camera target [x, y, z] (optional)
"""
self.camera_position = position
if target:
self.camera_target = target
def fit_to_screen(self) -> None:
"""Fit the point cloud to the screen."""
self.call_js_method("fitToScreen")
def enable_edl(self, enabled: bool = True) -> None:
"""Enable or disable Eye Dome Lighting.
Args:
enabled: Whether to enable EDL
"""
self.edl_enabled = enabled
def set_edl_settings(self, radius: float = 1.0, strength: float = 1.0) -> None:
"""Set Eye Dome Lighting parameters.
Args:
radius: EDL radius
strength: EDL strength
"""
self.edl_radius = radius
self.edl_strength = strength
def show_coordinate_grid(
self, show: bool = True, size: float = 10.0, color: str = "#aaaaaa"
) -> None:
"""Show or hide coordinate grid.
Args:
show: Whether to show the grid
size: Grid size
color: Grid color
"""
self.show_grid = show
self.grid_size = size
self.grid_color = color
def set_background_color(self, color: str) -> None:
"""Set the background color.
Args:
color: Background color (hex format like "#000000")
"""
self.background_color = color
def clear_point_clouds(self) -> None:
"""Clear all point clouds from the viewer."""
self.call_js_method("clearPointClouds")
def get_camera_position(self) -> List[float]:
"""Get current camera position."""
return list(self.camera_position)
def get_camera_target(self) -> List[float]:
"""Get current camera target."""
return list(self.camera_target)
def take_screenshot(self) -> None:
"""Take a screenshot of the current view."""
self.call_js_method("takeScreenshot")
def set_fov(self, fov: float) -> None:
"""Set field of view.
Args:
fov: Field of view in degrees
"""
self.fov = fov
def set_clip_distances(self, near: float, far: float) -> None:
"""Set near and far clipping distances.
Args:
near: Near clipping distance
far: Far clipping distance
"""
self.near_clip = near
self.far_clip = far
def add_measurement(self, measurement_type: str = "distance") -> None:
"""Add measurement tool.
Args:
measurement_type: Type of measurement ("distance", "area", "volume", "angle")
"""
self.call_js_method("addMeasurement", measurement_type)
def clear_measurements(self) -> None:
"""Clear all measurements."""
self.call_js_method("clearMeasurements")
def set_quality(self, quality: str = "medium") -> None:
"""Set rendering quality.
Args:
quality: Rendering quality ("low", "medium", "high")
"""
if quality not in ["low", "medium", "high"]:
raise ValueError("quality must be 'low', 'medium', or 'high'")
self.call_js_method("setQuality", quality)
def load_multiple_point_clouds(self, point_clouds: List[Dict[str, str]]) -> None:
"""Load multiple point clouds.
Args:
point_clouds: List of point cloud configs with 'url' and optional 'name' keys
"""
self.call_js_method("loadMultiplePointClouds", point_clouds)
def set_classification_visibility(self, classifications: Dict[int, bool]) -> None:
"""Set visibility of point classifications.
Args:
classifications: Dict mapping classification codes to visibility
"""
self.call_js_method("setClassificationVisibility", classifications)
def filter_by_elevation(
self,
min_elevation: Optional[float] = None,
max_elevation: Optional[float] = None,
) -> None:
"""Filter points by elevation.
Args:
min_elevation: Minimum elevation to show
max_elevation: Maximum elevation to show
"""
options = {}
if min_elevation is not None:
options["min"] = min_elevation
if max_elevation is not None:
options["max"] = max_elevation
self.call_js_method("filterByElevation", options)
def clear_filters(self) -> None:
"""Clear all filters."""
self.call_js_method("clearFilters")
__init__(self, point_cloud_url='', width='100%', height='600px', point_size=1.0, point_size_type='adaptive', point_shape='square', camera_position=[0.0, 0.0, 10.0], camera_target=[0.0, 0.0, 0.0], fov=60.0, background_color='#000000', edl_enabled=True, show_grid=False, **kwargs)
special
¶
Initialize Potree map widget.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
point_cloud_url |
str |
URL to the point cloud metadata.json file |
'' |
width |
str |
Widget width |
'100%' |
height |
str |
Widget height |
'600px' |
point_size |
float |
Size of rendered points |
1.0 |
point_size_type |
str |
How point size is calculated ("fixed", "adaptive", "attenuation") |
'adaptive' |
point_shape |
str |
Shape of rendered points ("square", "circle") |
'square' |
camera_position |
List[float] |
Initial camera position [x, y, z] |
[0.0, 0.0, 10.0] |
camera_target |
List[float] |
Camera look-at target [x, y, z] |
[0.0, 0.0, 0.0] |
fov |
float |
Field of view in degrees |
60.0 |
background_color |
str |
Background color of the viewer |
'#000000' |
edl_enabled |
bool |
Enable Eye Dome Lighting for better depth perception |
True |
show_grid |
bool |
Show coordinate grid |
False |
Source code in anymap/anymap.py
def __init__(
self,
point_cloud_url: str = "",
width: str = "100%",
height: str = "600px",
point_size: float = 1.0,
point_size_type: str = "adaptive",
point_shape: str = "square",
camera_position: List[float] = [0.0, 0.0, 10.0],
camera_target: List[float] = [0.0, 0.0, 0.0],
fov: float = 60.0,
background_color: str = "#000000",
edl_enabled: bool = True,
show_grid: bool = False,
**kwargs,
):
"""Initialize Potree map widget.
Args:
point_cloud_url: URL to the point cloud metadata.json file
width: Widget width
height: Widget height
point_size: Size of rendered points
point_size_type: How point size is calculated ("fixed", "adaptive", "attenuation")
point_shape: Shape of rendered points ("square", "circle")
camera_position: Initial camera position [x, y, z]
camera_target: Camera look-at target [x, y, z]
fov: Field of view in degrees
background_color: Background color of the viewer
edl_enabled: Enable Eye Dome Lighting for better depth perception
show_grid: Show coordinate grid
"""
super().__init__(
width=width,
height=height,
point_cloud_url=point_cloud_url,
point_size=point_size,
point_size_type=point_size_type,
point_shape=point_shape,
camera_position=camera_position,
camera_target=camera_target,
fov=fov,
background_color=background_color,
edl_enabled=edl_enabled,
show_grid=show_grid,
**kwargs,
)
add_measurement(self, measurement_type='distance')
¶
Add measurement tool.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
measurement_type |
str |
Type of measurement ("distance", "area", "volume", "angle") |
'distance' |
Source code in anymap/anymap.py
def add_measurement(self, measurement_type: str = "distance") -> None:
"""Add measurement tool.
Args:
measurement_type: Type of measurement ("distance", "area", "volume", "angle")
"""
self.call_js_method("addMeasurement", measurement_type)
clear_filters(self)
¶
Clear all filters.
Source code in anymap/anymap.py
def clear_filters(self) -> None:
"""Clear all filters."""
self.call_js_method("clearFilters")
clear_measurements(self)
¶
Clear all measurements.
Source code in anymap/anymap.py
def clear_measurements(self) -> None:
"""Clear all measurements."""
self.call_js_method("clearMeasurements")
clear_point_clouds(self)
¶
Clear all point clouds from the viewer.
Source code in anymap/anymap.py
def clear_point_clouds(self) -> None:
"""Clear all point clouds from the viewer."""
self.call_js_method("clearPointClouds")
enable_edl(self, enabled=True)
¶
Enable or disable Eye Dome Lighting.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
enabled |
bool |
Whether to enable EDL |
True |
Source code in anymap/anymap.py
def enable_edl(self, enabled: bool = True) -> None:
"""Enable or disable Eye Dome Lighting.
Args:
enabled: Whether to enable EDL
"""
self.edl_enabled = enabled
filter_by_elevation(self, min_elevation=None, max_elevation=None)
¶
Filter points by elevation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
min_elevation |
Optional[float] |
Minimum elevation to show |
None |
max_elevation |
Optional[float] |
Maximum elevation to show |
None |
Source code in anymap/anymap.py
def filter_by_elevation(
self,
min_elevation: Optional[float] = None,
max_elevation: Optional[float] = None,
) -> None:
"""Filter points by elevation.
Args:
min_elevation: Minimum elevation to show
max_elevation: Maximum elevation to show
"""
options = {}
if min_elevation is not None:
options["min"] = min_elevation
if max_elevation is not None:
options["max"] = max_elevation
self.call_js_method("filterByElevation", options)
fit_to_screen(self)
¶
Fit the point cloud to the screen.
Source code in anymap/anymap.py
def fit_to_screen(self) -> None:
"""Fit the point cloud to the screen."""
self.call_js_method("fitToScreen")
get_camera_position(self)
¶
Get current camera position.
Source code in anymap/anymap.py
def get_camera_position(self) -> List[float]:
"""Get current camera position."""
return list(self.camera_position)
get_camera_target(self)
¶
Get current camera target.
Source code in anymap/anymap.py
def get_camera_target(self) -> List[float]:
"""Get current camera target."""
return list(self.camera_target)
load_multiple_point_clouds(self, point_clouds)
¶
Load multiple point clouds.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
point_clouds |
List[Dict[str, str]] |
List of point cloud configs with 'url' and optional 'name' keys |
required |
Source code in anymap/anymap.py
def load_multiple_point_clouds(self, point_clouds: List[Dict[str, str]]) -> None:
"""Load multiple point clouds.
Args:
point_clouds: List of point cloud configs with 'url' and optional 'name' keys
"""
self.call_js_method("loadMultiplePointClouds", point_clouds)
load_point_cloud(self, point_cloud_url, point_cloud_name=None)
¶
Load a point cloud from URL.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
point_cloud_url |
str |
URL to the point cloud metadata.json file |
required |
point_cloud_name |
Optional[str] |
Optional name for the point cloud |
None |
Source code in anymap/anymap.py
def load_point_cloud(
self, point_cloud_url: str, point_cloud_name: Optional[str] = None
) -> None:
"""Load a point cloud from URL.
Args:
point_cloud_url: URL to the point cloud metadata.json file
point_cloud_name: Optional name for the point cloud
"""
self.point_cloud_url = point_cloud_url
options = {"url": point_cloud_url}
if point_cloud_name:
options["name"] = point_cloud_name
self.call_js_method("loadPointCloud", options)
set_background_color(self, color)
¶
Set the background color.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
color |
str |
Background color (hex format like "#000000") |
required |
Source code in anymap/anymap.py
def set_background_color(self, color: str) -> None:
"""Set the background color.
Args:
color: Background color (hex format like "#000000")
"""
self.background_color = color
set_camera_position(self, position, target=None)
¶
Set camera position and optionally target.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
position |
List[float] |
Camera position [x, y, z] |
required |
target |
Optional[List[float]] |
Camera target [x, y, z] (optional) |
None |
Source code in anymap/anymap.py
def set_camera_position(
self, position: List[float], target: Optional[List[float]] = None
) -> None:
"""Set camera position and optionally target.
Args:
position: Camera position [x, y, z]
target: Camera target [x, y, z] (optional)
"""
self.camera_position = position
if target:
self.camera_target = target
set_classification_visibility(self, classifications)
¶
Set visibility of point classifications.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
classifications |
Dict[int, bool] |
Dict mapping classification codes to visibility |
required |
Source code in anymap/anymap.py
def set_classification_visibility(self, classifications: Dict[int, bool]) -> None:
"""Set visibility of point classifications.
Args:
classifications: Dict mapping classification codes to visibility
"""
self.call_js_method("setClassificationVisibility", classifications)
set_clip_distances(self, near, far)
¶
Set near and far clipping distances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
near |
float |
Near clipping distance |
required |
far |
float |
Far clipping distance |
required |
Source code in anymap/anymap.py
def set_clip_distances(self, near: float, far: float) -> None:
"""Set near and far clipping distances.
Args:
near: Near clipping distance
far: Far clipping distance
"""
self.near_clip = near
self.far_clip = far
set_edl_settings(self, radius=1.0, strength=1.0)
¶
Set Eye Dome Lighting parameters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
radius |
float |
EDL radius |
1.0 |
strength |
float |
EDL strength |
1.0 |
Source code in anymap/anymap.py
def set_edl_settings(self, radius: float = 1.0, strength: float = 1.0) -> None:
"""Set Eye Dome Lighting parameters.
Args:
radius: EDL radius
strength: EDL strength
"""
self.edl_radius = radius
self.edl_strength = strength
set_fov(self, fov)
¶
Set field of view.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fov |
float |
Field of view in degrees |
required |
Source code in anymap/anymap.py
def set_fov(self, fov: float) -> None:
"""Set field of view.
Args:
fov: Field of view in degrees
"""
self.fov = fov
set_point_shape(self, shape)
¶
Set the point shape.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
shape |
str |
"square" or "circle" |
required |
Source code in anymap/anymap.py
def set_point_shape(self, shape: str) -> None:
"""Set the point shape.
Args:
shape: "square" or "circle"
"""
if shape not in ["square", "circle"]:
raise ValueError("shape must be 'square' or 'circle'")
self.point_shape = shape
set_point_size(self, size)
¶
Set the point size.
Source code in anymap/anymap.py
def set_point_size(self, size: float) -> None:
"""Set the point size."""
self.point_size = size
set_point_size_type(self, size_type)
¶
Set the point size type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
size_type |
str |
"fixed", "adaptive", or "attenuation" |
required |
Source code in anymap/anymap.py
def set_point_size_type(self, size_type: str) -> None:
"""Set the point size type.
Args:
size_type: "fixed", "adaptive", or "attenuation"
"""
if size_type not in ["fixed", "adaptive", "attenuation"]:
raise ValueError("size_type must be 'fixed', 'adaptive', or 'attenuation'")
self.point_size_type = size_type
set_quality(self, quality='medium')
¶
Set rendering quality.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
quality |
str |
Rendering quality ("low", "medium", "high") |
'medium' |
Source code in anymap/anymap.py
def set_quality(self, quality: str = "medium") -> None:
"""Set rendering quality.
Args:
quality: Rendering quality ("low", "medium", "high")
"""
if quality not in ["low", "medium", "high"]:
raise ValueError("quality must be 'low', 'medium', or 'high'")
self.call_js_method("setQuality", quality)
show_coordinate_grid(self, show=True, size=10.0, color='#aaaaaa')
¶
Show or hide coordinate grid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
show |
bool |
Whether to show the grid |
True |
size |
float |
Grid size |
10.0 |
color |
str |
Grid color |
'#aaaaaa' |
Source code in anymap/anymap.py
def show_coordinate_grid(
self, show: bool = True, size: float = 10.0, color: str = "#aaaaaa"
) -> None:
"""Show or hide coordinate grid.
Args:
show: Whether to show the grid
size: Grid size
color: Grid color
"""
self.show_grid = show
self.grid_size = size
self.grid_color = color
take_screenshot(self)
¶
Take a screenshot of the current view.
Source code in anymap/anymap.py
def take_screenshot(self) -> None:
"""Take a screenshot of the current view."""
self.call_js_method("takeScreenshot")