Layers
SymbolLayer
The SymbolLayer component is designed to display icons and text on the map at specific locations.
It allows you to add markers, labels, or custom symbols using various layout and paint properties to control their appearance and behavior.
This layer is especially useful for adding annotations, labels for points of interest, or custom icons to enhance the map’s interactivity.
Reference: Symbol
Usage
The SymbolLayer is typically used with a source like GeojsonSource that contains point data.
Style customization
You can customize the layout properties to control how icons and text are rendered on the map, including their size, color, placement, and rotation.
In the following example we’re gonna be removing the text of the symbol, reduce the icon size and reduce the opacity.
Listening to events
You can listen to layer’s events once you pass the event name like @click, @mousemove and more, to learn more about supported events please visit the offical documentation at MapLayerEventType.
API
Events
The SymbolLayer component’s events.
| Prop | Description | Type |
|---|---|---|
| click | Fired when a pointing device (usually a mouse) is pressed and released contains a visible portion of the specified layer. | MapLayerMouseEvent |
| contextmenu | Fired when the right button of the mouse is clicked or the context menu key is pressed within visible portion of the specified layer. | MapLayerMouseEvent |
| dblclick | Fired when a pointing device (usually a mouse) is pressed and released twice contains a visible portion of the specified layer. | MapLayerMouseEvent |
| mousedown | Fired when a pointing device (usually a mouse) is pressed while inside a visible portion of the specified layer. | MapLayerMouseEvent |
| mouseenter | Fired when a pointing device (usually a mouse) enters a visible portion of a specified layer from outside that layer or outside the map canvas. | MapLayerMouseEvent |
| mouseleave | Fired when a pointing device (usually a mouse) leaves a visible portion of a specified layer, or leaves the map canvas. | MapLayerMouseEvent |
| mousemove | Fired when a pointing device (usually a mouse) is moved while the cursor is inside a visible portion of the specified layer. As you move the cursor across the layer, the event will fire every time the cursor changes position within that layer. | MapLayerMouseEvent |
| mouseout | Fired when a point device (usually a mouse) leaves the visible portion of the specified layer. | MapLayerMouseEvent |
| mouseover | Fired when a pointing device (usually a mouse) is moved inside a visible portion of the specified layer. | MapLayerMouseEvent |
| mouseup | Fired when a pointing device (usually a mouse) is released while inside a visible portion of the specified layer. | MapLayerMouseEvent |
| touchcancel | Fired when a touchstart event occurs within the visible portion of the specified layer. | MapLayerMouseEvent |
| touchend | Fired when a touchend event occurs within the visible portion of the specified layer. | MapLayerMouseEvent |
| touchstart | Fired when a touchstart event occurs within the visible portion of the specified layer. | MapLayerMouseEvent |
Props
The Symbol component’s props.
While an id is typically required for MapLibre layers, the SymbolLayer component automatically generates a unique id if none is provided.
| Prop | Description | Type |
|---|---|---|
| id | The id for the source. Must not be used by any existing source. | Optional string |
| metadata | Arbitrary properties useful to track with the layer, but do not influence rendering. Properties should be prefixed to avoid collisions, like ‘maplibre:’. | Optional |
| source | Name of a source description to be used for this layer. | Optional GeoJSONSourceSpecification or string |
| minzoom | The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. | Optional number in range [0, 24]. |
| maxzoom | The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden. | Optional number in range [0, 24]. |
| filter | A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions. | Optional filter |
| layout | Layout properties for the layer. | Optional HeatmapSpecification[‘layout’] |
| paint | Default paint properties for this layer. | Optional HeatmapSpecification[‘paint’] |