Struct MapHandle 

pub struct MapHandle { /* private fields */ }

A handle to a MapLibre map instance.

This is a lightweight Clone wrapper. Store it in a Signal<Option<MapHandle>> and set it in the on_ready callback.

Implementations

impl MapHandle

pub fn add_navigation_control(&self, position: ControlPosition)

Add a navigation control (zoom +/- buttons and compass)

pub fn remove_navigation_control(&self, position: ControlPosition)

Remove a navigation control.

pub fn add_geolocate_control(&self, position: ControlPosition)

Add a geolocate control.

pub fn remove_geolocate_control(&self, position: ControlPosition)

Remove a geolocate control.

pub fn add_scale_control(&self, position: ControlPosition)

Add a scale control.

pub fn remove_scale_control(&self, position: ControlPosition)

Remove a scale control.

pub fn add_fullscreen_control(&self, position: ControlPosition)

Add a fullscreen control.

pub fn remove_fullscreen_control(&self, position: ControlPosition)

Remove a fullscreen control.

pub fn add_attribution_control(&self, position: ControlPosition)

Add an attribution control.

pub fn remove_attribution_control(&self, position: ControlPosition)

Remove an attribution control.

impl MapHandle

pub fn eval(&self, js_code: &str)

Execute arbitrary JavaScript against this map’s instance.

The JS code receives map as a variable referencing the MapLibre map object. This is a fire-and-forget operation.

pub async fn eval_async<T: DeserializeOwned>(&self, _js_code: &str) -> Option<T>

impl MapHandle

pub fn set_feature_state(&self, feature: &FeatureIdentifier, state: Value)

Set feature state for styling (hover effects, selection, etc.)

pub fn remove_feature_state(&self, feature: &FeatureIdentifier)

Remove all feature state

impl MapHandle

pub async fn get_zoom(&self) -> Option<f64>

pub async fn get_center(&self) -> Option<LatLng>

pub async fn get_bearing(&self) -> Option<f64>

pub async fn get_pitch(&self) -> Option<f64>

pub async fn get_bounds(&self) -> Option<Bounds>

impl MapHandle

pub fn load_image(&self, id: &str, url: &str)

Load an image from a URL and add it to the map’s sprite

pub async fn load_image_async(&self, _id: &str, _url: &str) -> bool

Load an image and wait for it to complete (returns true on success)

pub async fn has_image(&self, _id: &str) -> bool

Check if an image exists in the map’s sprite

pub fn remove_image(&self, id: &str)

Remove an image from the map’s sprite

impl MapHandle

pub fn on_layer_click(&self, layer_id: &str)

Register a click handler on a layer (events dispatched via on_layer_click).

pub fn off_layer_click(&self, layer_id: &str)

Unregister a click handler on a layer.

pub fn on_layer_hover(&self, layer_id: &str)

Register hover handlers on a layer (events dispatched via on_layer_hover).

pub fn off_layer_hover(&self, layer_id: &str)

Unregister hover handlers on a layer.

impl MapHandle

pub fn add_layer(&self, options: LayerOptions)

Add a layer to the map

pub fn remove_layer(&self, id: &str)

Remove a layer from the map

pub fn set_paint_property(&self, layer_id: &str, name: &str, value: Value)

Set a paint property on a layer

pub fn set_layout_property(&self, layer_id: &str, name: &str, value: Value)

Set a layout property on a layer

pub fn move_layer(&self, layer_id: &str, before_id: Option<&str>)

Move a layer to a different position in the layer stack

If before_id is Some, the layer is moved before that layer. If before_id is None, the layer is moved to the top.

pub fn set_filter(&self, layer_id: &str, filter: Value)

Set a filter on a layer

impl MapHandle

pub fn add_marker(&self, id: &str, position: LatLng, options: MarkerOptions)

Add a marker at the given position

pub fn remove_marker(&self, id: &str)

Remove a marker

pub fn update_marker_position(&self, id: &str, position: LatLng)

Update a marker’s position

impl MapHandle

pub fn fly_to(&self, options: FlyToOptions)

Fly to a location with animation

pub fn ease_to(&self, options: EaseToOptions)

Ease to a location with animation

pub fn jump_to(&self, options: JumpToOptions)

Jump to a location instantly (no animation)

pub fn fit_bounds(&self, bounds: Bounds, options: FitBoundsOptions)

Fit the map to the given bounds

pub fn pan_to(&self, position: LatLng)

Pan to a coordinate

pub fn pan_by(&self, x: i32, y: i32)

Pan by pixel offset (instant, no animation)

pub fn zoom_to(&self, zoom: f64)

Set zoom level

pub fn zoom_in(&self)

Zoom in one level

pub fn zoom_out(&self)

Zoom out one level

pub fn rotate_to(&self, bearing: f64)

Set bearing (rotation)

pub fn set_pitch(&self, pitch: f64)

Set pitch (tilt)

pub fn reset_north(&self)

Reset bearing to north (0 degrees)

pub fn set_move_event_throttle(&self, throttle_ms: u32)

Set throttle for on_move events in milliseconds (0 = every animation frame)

impl MapHandle

pub fn set_padding(&self, padding: Padding)

Set viewport padding

pub async fn get_padding(&self) -> Option<Padding>

Get current viewport padding

impl MapHandle

pub fn add_popup( &self, id: &str, position: LatLng, html: &str, options: PopupOptions, )

Add a standalone popup at a position

pub fn remove_popup(&self, id: &str)

Remove a popup

impl MapHandle

pub async fn query_rendered_features( &self, _options: QueryOptions, ) -> Vec<QueryFeature>

pub async fn query_rendered_features_at( &self, _point: Point, _options: QueryOptions, ) -> Vec<QueryFeature>

pub async fn query_source_features( &self, _source_id: &str, _options: QueryOptions, ) -> Vec<QueryFeature>

impl MapHandle

pub fn add_geojson_source(&self, id: &str, options: GeoJsonSourceOptions)

Add a GeoJSON source to the map

pub fn add_vector_source(&self, id: &str, options: VectorSourceOptions)

Add a vector tile source to the map

pub fn add_raster_source(&self, id: &str, options: RasterSourceOptions)

Add a raster tile source to the map

pub fn add_raster_dem_source(&self, id: &str, options: RasterDemSourceOptions)

Add a raster DEM source (for terrain)

pub fn add_image_source(&self, id: &str, options: ImageSourceOptions)

Add an image source to the map

pub fn update_geojson_source(&self, id: &str, data: Value)

Update the data of an existing GeoJSON source

pub fn remove_source(&self, id: &str)

Remove a source from the map

impl MapHandle

pub fn set_style(&self, url: &str)

Change the map’s style URL

impl MapHandle

pub fn set_terrain(&self, options: TerrainOptions)

Enable 3D terrain

pub fn remove_terrain(&self)

Remove 3D terrain

pub fn set_sky(&self, options: SkyOptions)

Set sky properties

pub fn remove_sky(&self)

Remove sky

pub fn set_fog(&self, options: FogOptions)

Set fog/atmosphere properties

pub fn remove_fog(&self)

Remove fog/atmosphere

impl MapHandle

pub fn map_id(&self) -> &str

Get the internal map ID (useful for debugging).

Trait Implementations

impl Clone for MapHandle

fn clone(&self) -> MapHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MapHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MapHandle

fn eq(&self, other: &MapHandle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MapHandle

impl StructuralPartialEq for MapHandle