API / Layers
Layer
A component that handles a generic layer. This is intended for use by other type-specific layer components, such as FillLayer, and usually you will want to use one of those in your code instead of directly using this component.
import { Layer } from 'svelte-maplibre'; Generic parameters: FEATURE extends Feature = Feature
Props
- paint
AllPaintProperties - layout
AllLayoutProperties - applyToClusters
boolean - requireSource
booleanDefault:
true
Inherited from CommonLayerProps
- id
anyDefault:
getId('layer') - source
stringSet the source for this layer. This can be omitted when the Layer is created in the slot of a source component.
- sourceLayer
stringWhen setting up a layer for a vector tile source, the source layer to which this layer corresponds.
- beforeId
stringDraw this layer under another layer. This is only evaluated when the component is created.
- beforeLayerType
string | ((layer: maplibregl.LayerSpecification) => boolean)Draw this layer all layers of this type. This is only evaluated when the component is created.
- filter
maplibregl.ExpressionSpecification - minzoom
number - maxzoom
number - hoverCursor
stringSet the cursor style to this value when the mouse is over the layer.
- manageHoverState
booleanDefault:
falseEnable to use hoverStateFilter or filter on
hover-state. Features must have anidproperty for this to work. - eventsIfTopMost
booleanDefault:
false - interactive
booleanDefault:
trueHandle mouse events on this layer.
- children
Snippet - onclick
(e: LayerClickInfo<FEATURE>) => void - ondblclick
(e: LayerClickInfo<FEATURE>) => void - onmouseenter
(e: LayerClickInfo<FEATURE>) => void - onmousemove
(e: LayerClickInfo<FEATURE>) => void - onmouseleave
(e: Pick<LayerClickInfo<FEATURE>, 'map' | 'layer' | 'source'>) => void
Source: src/lib/Layer.svelte