Vertex/edge snapping engine with configurable tolerance. Snaps drawing tools to nearby features.

Constructor

new SnapEngine(options?: SnapOptions)

Parameter	Type		Description
options	SnapOptions	optional	Snap configuration

SnapOptions

Field	Type		Description
vertex	boolean	optional	Enable vertex snapping Default: true
edge	boolean	optional	Enable edge snapping Default: false
tolerance	number	optional	Snap tolerance in pixels Default: 10

Methods

snap()

snap(screenX: number, screenY: number, mapCoords: [number, number], toScreen: Function): SnapResult

Snap to nearest vertex/edge. Returns { coords, type: 'vertex'|'edge'|'none' }.

Returns SnapResult

addSourceLayer()

addSourceLayer(layer: SnapSourceLayer): void

Add a snap source layer.

Returns void

removeSourceLayer()

removeSourceLayer(layer: SnapSourceLayer): void

Remove a snap source.

Returns void

setTolerance()

setTolerance(px: number): void

Change snap tolerance.

Returns void