leaflet-event-forwarder

Catches unhandled canvas layer events and re-dispatches them to the next layer in the stack

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
leaflet-event-forwarder
910.0.34 years ago4 years agoMinified + gzip package size for leaflet-event-forwarder in KB

Readme

A plugin for leaflet v1^.
Catches unhandled canvas layer events and re-dispatches them to the next pane in a container.

Example use:

const map = L.map("map");
// prepare a container to hold our z stackable layer panes
const container = map.createPane('stack-container');

const myEventForwarder = new L.eventForwarder({
  // ref to leaflet map
  map: map,
  // events to forward
  events: {
    click: true,
    mousemove: true
  },
  // throttle options for mousemove events (same as underscore.js)
  throttleMs: 100,
  throttleOptions: {
    leading: true,
    trailing: false
  }
});

// enable event forwarding
myEventForwarder.enable();

// disable event forwarding
myEventForwarder.disable();

Shouts outs

by perliedman

License

Apache 2