Layers
FillLayer
The FillLayer component enables you to render solid or patterned polygons directly onto your map, making it ideal for visualizing geographic boundaries, regions, or any defined areas based on coordinate data.
With a range of customizable paint and layout options, FillLayer gives you precise control over fill color, opacity, borders, and patterns, allowing you to easily style polygons to match the unique look and feel of your application.
Reference: Fill
Usage
The FillLayer is often used within a GeojsonSource to render polygonal data, but it can also be customized through its paint properties for fine-tuned visual styling.
Style customization
The FillLayer allows you to customize the appearance of the filled areas using various paint properties, here’s an example:
Toggle layer visibility
You can programmatically control the visibility of the fill layer on the map using the exposed toggle() method.
This method toggles the layer’s visibility by interacting with MapLibre’s setLayoutProperty() function.
Behind the scenes, it adjusts the visibility property of the fill layer between visible and none.
Rerendering data
The data prop in the GeojsonSource is reactive, once the data changes, LibreGL automatically rerenders the layer like a charm, ensuring your map always reflects the latest data, here is an example:
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 FillLayer 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 FillLayer component’s props.
While an id is typically required for MapLibre layers, the FillLayer 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 Record<string, string> |
| 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 FillLayerSpecification[‘layout’] |
| paint | Default paint properties for this layer. | Optional FillLayerSpecification[‘paint’] |