Mapbox-GL Draw Snap Mode

Custom mode for Mapbox GL Draw that adds snapping ability while drawing features. It provides options to show guiding lines, control snapping sensibility, and whether to snap to midpoints on each segment.

Demo

See a full example in the docs folder, or check at the Demo.

Install

npm i mapbox-gl-draw-snap-mode

or use CDN:

<script src="https://unpkg.com/mapbox-gl-draw-snap-mode"></script>

Usage

import {
  SnapPolygonMode,
  SnapPointMode,
  SnapLineMode,
  SnapModeDrawStyles,
} from "mapbox-gl-draw-snap-mode";
// or global variable mapboxGlDrawSnapMode when using script tag

const draw = new MapboxDraw({
  modes: {
    ...MapboxDraw.modes,
    draw_point: SnapPointMode,
    draw_polygon: SnapPolygonMode,
    draw_line_string: SnapLineMode,
  },
  // Styling guides
  styles: SnapModeDrawStyles,
  userProperties: true,
  // Config snapping features
  snap: true,
  snapOptions: {
    snapPx: 15, // defaults to 15
    snapToMidPoints: true, // defaults to false
    snapVertexPriorityDistance: 0.0025, // defaults to 1.25
  },
  guides: false,
});

draw.changeMode("draw_polygon");

options

snapPx

The min distnace (in pixels) where snapping to the line/segments would take effect.

snapToMidPoints

Controls whether to snap to line/segments midpoints (an imaginary point in the middle of each segment) or not.

snapVertexPriorityDistance

The min distance (in Kilometers) from each vertex, where snapping to that vertex would take priority over snapping to line/segments.

Changing settings

Changing settings would take effect while snapping imidiately, so you can control snapping behaivior using draw.options.snap, like so:

// turn snapping off
draw.options.snap = false;

// and back on
draw.options.snap = true;

Snapping can also be disabled holding Alt (Option) key.

You can also create a custom mapbox-gl draw toolbar to control this, take a look at the example in the docs directory.

Developing and testing

Install dependencies, start the dev server:

npm install
npm start

to preview, change script source in docs/index.html file as so:

- <script src="https://unpkg.com/mapbox-gl-draw-snap-mode"></script>
+ <!-- <script src="https://unpkg.com/mapbox-gl-draw-snap-mode"></script> -->

- <!-- <script src="index.js"></script> -->
+ <script src="index.js"></script>

Remember to revert this change before git push.

Publishing

To GitHub and NPM:

npm version (major|minor|patch)
git push --tags
git push
npm publish

Acknowledgement

This project is heavily inspired by this work of @davidgilbertson and leaflet-geoman project.