leaflet-rotate 0.2.1 → 0.2.2

package/src/dom/Draggable.js

@@ -4,8 +4,15 @@
  * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/dom/Draggable.js
  */
 
+/**
+ * A class for making DOM elements draggable (including touch support).
+ * Used internally for map and marker dragging. Only works for elements
+ * that were positioned with [`L.DomUtil.setPosition`](#domutil-setposition).
+ */
+
 L.Draggable.include({
 
+    /** @TODO */
     // updateMapBearing: function(mapBearing) {
     //     this._mapBearing = mapBearing;
     // },

package/src/geo/LatLngBounds.js

@@ -0,0 +1,13 @@
+/**
+ * @external L.LatLngBounds
+ * 
+ * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/geo/LatLngBounds.js
+ */
+
+/**
+ * @TODO find out if should override here some functions in order
+ * to always get  correct { _southWest, _northEast } bounds on a rotaded
+ * map, for example: at 180° "_southWest" should becomes "_northEast"?
+ * 
+ * @see L.Map.getBounds()
+ */

package/src/geometry/Bounds.js

@@ -0,0 +1,13 @@
+/**
+ * @external L.Bounds
+ * 
+ * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/geometry/Bounds.js
+ */
+
+/**
+ * @TODO find out if should override here some functions in order
+ * to always get  correct { min, max } pixel bounds on a rotaded
+ * map, for example: at 180° "min" should becomes "max"?
+ * 
+ * @see L.Map.getPixelBounds()
+ */

package/src/geometry/Point.js

@@ -26,6 +26,11 @@ L.extend(L.Point.prototype, {
      * 3. add (pivot.x, pivot.y) back
      * 
      * same as `this.subtract(pivot).rotate(theta).add(pivot)`
+     * 
+     * @param {Number} theta 
+     * @param {L.Point} pivot 
+     * 
+     * @returns {L.Point}
      */
     rotateFrom: function(theta, pivot) {
         if (!theta) { return this; }

package/src/index.js

@@ -1,7 +1,21 @@
 /**
+ * Export Leaflet classes in the same order as the core library
+ * 
  * @external L
  *
  * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/Leaflet.js
+ * 
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/control/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/core/index.js
+ * 
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/dom/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/geometry/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/geo/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/layer/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/layer/marker/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/layer/tile/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/layer/vector/index.js
+ * @see https://github.com/Leaflet/Leaflet/blob/v1.9.3/src/map/index.js
  */
 
 // import {version} from '../package.json';
@@ -19,9 +33,10 @@ export * from './dom/Draggable';
 
 // geometry
 export * from './geometry/Point';
+export * from './geometry/Bounds';
 
 // geo
-// export * from './geo/index';
+export * from './geo/LatLngBounds';
 
 // layer
 export * from './layer/DivOverlay';
@@ -30,9 +45,7 @@ export * from './layer/Tooltip';
 export * from './layer/marker/Icon';
 export * from './layer/marker/Marker';
 export * from './layer/tile/GridLayer';
-export * from './layer/vector/Canvas';
 export * from './layer/vector/Renderer';
-export * from './layer/vector/SVG';
 
 // map
 export * from './map/Map';

package/src/layer/DivOverlay.js

@@ -8,16 +8,23 @@ const divOverlayProto = L.extend({}, L.DivOverlay.prototype);
 
 L.DivOverlay.include({
 
+    /**
+     * Update L.Popup and L.Tooltip anchor positions after
+     * the map is moved by calling `map.setBearing(theta)`
+     * 
+     * @listens L.Map~rotate
+     */
     getEvents: function() {
         return L.extend(divOverlayProto.getEvents.apply(this, arguments), { rotate: this._updatePosition });
     },
 
+    /**
+     * 0. update element anchor point (divOverlayProto v1.9.3)
+     * 1. rotate around anchor point (subtract anchor -> rotate point -> add anchor)
+     */
     _updatePosition: function() {
-        // 0. update anchor (leaflet v1.9.3)
+        if (!this._map) { return; }
         divOverlayProto._updatePosition.apply(this, arguments);
-        // 1. subtract anchor
-        // 2. rotate element
-        // 3. restore anchor
         if (this._map && this._map._rotate && this._zoomAnimated) {
             var anchor = this._getAnchor();
             var pos = L.DomUtil.getPosition(this._container).subtract(anchor);

package/src/layer/Popup.js

@@ -8,12 +8,12 @@ const popupProto = L.extend({}, L.Popup.prototype);
 
 L.Popup.include({
 
+    /**
+     * 0. update element anchor point (popupProto v1.9.3)
+     * 1. rotate around anchor point (subtract anchor -> rotate point -> add anchor)
+     */
     _animateZoom: function(e) {
-        // 0. update anchor (leaflet v1.9.3)
         popupProto._animateZoom.apply(this, arguments);
-        // 1. subtract anchor
-        // 2. rotate element
-        // 3. restore anchor
         if (this._map && this._map._rotate) {
             var anchor = this._getAnchor();
             var pos = L.DomUtil.getPosition(this._container).subtract(anchor);
@@ -22,7 +22,7 @@ L.Popup.include({
     },
 
     /**
-     * Hot fix for L.Popup.mergeOptions({ keepInView: true, });
+     * Fix for L.popup({ keepInView = true })
      * 
      * @see https://github.com/fnicollet/Leaflet/pull/21
      */
@@ -44,8 +44,8 @@ L.Popup.include({
 
         layerPos._add(L.DomUtil.getPosition(this._container));
 
-        // var containerPos = map.layerPointToContainerPoint(layerPos);
         /** @TODO use popupProto._adjustPan */
+        // var containerPos = map.layerPointToContainerPoint(layerPos);
         var containerPos = layerPos._add(this._map._getMapPanePos()),
             padding = L.point(this.options.autoPanPadding),
             paddingTL = L.point(this.options.autoPanPaddingTopLeft || padding),

package/src/layer/marker/Marker.js

@@ -3,22 +3,33 @@
  * @external L.Handler.MarkerDrag
  * 
  * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/layer/marker/Marker.js
+ * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/layer/marker/Marker.Drag.js
+ * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/dom/Draggable.js
  */
 
 const markerProto = L.extend({}, L.Marker.prototype);
 
 L.Marker.mergeOptions({
 
-    // @option rotation: Number = 0
-    // Rotation of this marker in rad
+    /**
+     * Rotation of this marker in rad
+     * 
+     * @type {Number}
+     */
     rotation: 0,
 
-    // @option rotateWithView: Boolean = false
-    // Rotate this marker when map rotates
+    /**
+     * Rotate this marker when map rotates
+     * 
+     * @type {Boolean}
+     */
     rotateWithView: false,
 
-    // @option scale: Number = undefined
-    // Scale of the marker icon
+    /**
+     * Scale of the marker icon
+     * 
+     * @type {Number}
+     */
     scale: undefined,
 
 });
@@ -79,15 +90,16 @@ var MarkerDrag = {
 
 L.Marker.include({
 
+    /**
+     * Update L.Marker anchor position after the map
+     * is moved by calling `map.setBearing(theta)`
+     * 
+     * @listens L.Map~rotate
+     */
     getEvents: function() {
         return L.extend(markerProto.getEvents.apply(this, arguments), { rotate: this.update });
     },
 
-    onAdd: function(map) {
-        markerProto.onAdd.apply(this, arguments);
-        map.on('rotate', this.update, this);
-    },
-
     _initInteraction: function() {
         var ret = markerProto._initInteraction.apply(this, arguments);
         if (this.dragging && this.dragging.enabled() && this._map && this._map._rotate) {
@@ -132,12 +144,12 @@ L.Marker.include({
         this._resetZIndex();
     },
 
-    _updateZIndex: function(offset) {
-        if (!this._map._rotate) {
-            return markerProto._updateZIndex.apply(this, arguments);
-        }
-        this._icon.style.zIndex = Math.round(this._zIndex + offset);
-    },
+    // _updateZIndex: function(offset) {
+    //     if (!this._map._rotate) {
+    //         return markerProto._updateZIndex.apply(this, arguments);
+    //     }
+    //     this._icon.style.zIndex = Math.round(this._zIndex + offset);
+    // },
 
     setRotation: function(rotation) {
         this.options.rotation = rotation;

package/src/layer/tile/GridLayer.js

@@ -8,6 +8,12 @@ const gridLayerProto = L.extend({}, L.GridLayer.prototype);
 
 L.GridLayer.include({
 
+    /**
+     * Redraw L.TileLayer bounds after the map is
+     * moved by just calling `map.setBearing(theta)`
+     * 
+     * @listens L.Map~rotate
+     */
     getEvents: function() {
         var events = gridLayerProto.getEvents.apply(this, arguments);
         if (this._map._rotate && !this.options.updateWhenIdle) {

package/src/layer/vector/Renderer.js

@@ -8,15 +8,15 @@ const rendererProto = L.extend({}, L.Renderer.prototype);
 
 L.Renderer.include({
 
-    // onAdd: function() {
-    //     rendererProto.onAdd.apply(this, arguments);
-    //     // this._map.on('rotate', this._update, this);
-    // },
-
-    // onRemove: function() {
-    //     rendererProto.onRemove.apply(this, arguments);
-    //     // this._map.off('rotate', this._update, this);
-    // },
+    /**
+     * Redraw L.Canvas and L.SVG renderer bounds after the
+     * map is moved by just calling `map.setBearing(theta)`
+     * 
+     * @listens L.Map~rotate
+     */
+    getEvents: function() {
+        return L.extend(rendererProto.getEvents.apply(this, arguments), { rotate: this._update });
+    },
 
     /**
      * @TODO rechek this changes from leaflet@v1.9.3

package/src/map/handler/CompassBearing.js

@@ -31,7 +31,9 @@ L.Map.CompassBearing = L.Handler.extend({
 
 });
 
-// @section Handlers
-// @property compassBearing: Handler
-// Compass bearing handler.
+/**
+ * Add Compass bearing handler to L.Map (disabled unless `window.DeviceOrientationEvent` is set).
+ * 
+ * @property {L.Map.CompassBearing} compassBearing
+ */
 L.Map.addInitHook('addHandler', 'compassBearing', L.Map.CompassBearing);

package/src/map/handler/ContainerMutation.js

@@ -4,14 +4,23 @@
  * @typedef L.Map.ContainerMutation
  */
 
-// @namespace Map
-// @section Interaction Options
+/**
+ * @TODO check again this file after leaflet v1.9.3 (eg. L.Browser.mutation).
+ * Mutation Observer support will likely be added by default in next releases.
+ */
+
 L.Map.mergeOptions({
 
-    // @option trackContainerMutation: Boolean = false
-    // Whether the map uses [mutation observers](https://developer.mozilla.org/docs/Web/API/MutationObserver)
-    // to detect changes in its container and trigger `invalidateSize`. Disabled
-    // by default due to support not being available in all web browsers.
+    /**
+     * Whether the map uses mutation observers to
+     * detect changes in its container and trigger
+     * `invalidateSize`. Disabled by default due to
+     * support not being available in all web browsers.
+     *
+     * @type {Boolean}
+     * 
+     * @see https://developer.mozilla.org/docs/Web/API/MutationObserver
+     */
     trackContainerMutation: false
 
 });
@@ -19,15 +28,10 @@ L.Map.mergeOptions({
 L.Map.ContainerMutation = L.Handler.extend({
 
     addHooks: function() {
-        /** @TODO check again this property. Will likely be added in future releases (leaflet > v1.9.3) */
-        // if (!L.Browser.mutation) {
-        //     return;
-        // }
-
+        // if (!L.Browser.mutation) { return; }
         if (!this._observer) {
-            this._observer = new MutationObserver(L.Util.bind(this._onMutation, this));
+            this._observer = new MutationObserver(L.Util.bind(this._map.invalidateSize, this._map));
         }
-
         this._observer.observe(this._map.getContainer(), {
             childList: false,
             attributes: true,
@@ -38,20 +42,15 @@ L.Map.ContainerMutation = L.Handler.extend({
     },
 
     removeHooks: function() {
-        /** @TODO check again this property. Will likely be added in future releases (leaflet > v1.9.3) */
-        // if (!L.Browser.mutation) {
-        //     return;
-        // }
+        // if (!L.Browser.mutation) { return; }
         this._observer.disconnect();
     },
 
-    _onMutation: function() {
-        this._map.invalidateSize();
-    },
-
 });
 
-// @section Handlers
-// @property containerMutation: Handler
-// Container mutation handler (disabled unless [`trackContainerMutation`](#map-trackcontainermutation) is set).
+/**
+ * Add Container mutation handler to L.Map (disabled unless `trackContainerMutation` is set).
+ * 
+ * @property {L.Map.ContainerMutation} trackContainerMutation
+ */
 L.Map.addInitHook('addHandler', 'trackContainerMutation', L.Map.ContainerMutation);

package/src/map/handler/ShiftKeyRotate.js

@@ -1,17 +1,16 @@
 
 /**
- * Rotates the map on shift key + mouseheel scrolling (desktop).
+ * Rotates the map on shift key + mousewheel scrolling (desktop).
  * 
  * @typedef L.Map.ShiftKeyRotate
  */
 
-// @namespace Map
-// @section Interaction Options
 L.Map.mergeOptions({
 
-    // @section ShiftKey interaction options
-    // @option shiftKeyRotate: Boolean|String = *
-    // Whether the map can be rotated with a shit-wheel rotation
+    /**
+     * Whether the map can be rotated with shift + wheel scroll
+     * @type {Boolean}
+     */
     shiftKeyRotate: true,
 
 });
@@ -41,12 +40,14 @@ L.Map.ShiftKeyRotate = L.Handler.extend({
 
 });
 
-// @section Handlers
-// @property touchZoom: Handler
-// Touch rotate handler.
+/**
+ * Add ShiftKey handler to L.Map (enabled unless `shiftKeyRotate` is unset).
+ * 
+ * @property {L.Map.ShiftKeyRotate} shiftKeyRotate
+ */
 L.Map.addInitHook('addHandler', 'shiftKeyRotate', L.Map.ShiftKeyRotate);
 
-// decrease "scrollWheelZoom" handler priority over "shiftKeyRotate" handler
+// decrease `scrollWheelZoom` handler priority over `shiftKeyRotate` handler
 L.Map.addInitHook(function() {
     if (this.scrollWheelZoom.enabled() && this.shiftKeyRotate.enabled()) {
         this.scrollWheelZoom.disable();

package/src/map/handler/TouchGestures.js

@@ -7,13 +7,15 @@
  * @typedef L.Map.TouchGestures
  */
 
-// @namespace Map
-// @section Interaction Options
 L.Map.mergeOptions({
 
-    // @option bounceAtZoomLimits: Boolean = true
-    // Set it to false if you don't want the map to zoom beyond min/max zoom
-    // and then bounce back when pinch-zooming.
+    /**
+     * Set it to false if you don't want the map to
+     * zoom beyond min/max zoom and then bounce back
+     * when pinch-zooming.
+     * 
+     * @type {Boolean}
+     */
     bounceAtZoomLimits: true,
 
 });
@@ -92,8 +94,14 @@ L.Map.TouchGestures = L.Handler.extend({
             var bearingDelta = (theta - this._startTheta) * L.DomUtil.RAD_TO_DEG;
             if (vector.y < 0) { bearingDelta += 180; }
             if (bearingDelta) {
-                /// TODO: The pivot should be the last touch point, but zoomAnimation manages to
-                ///   overwrite the rotate pane position. Maybe related to #3529.
+                /**
+                 * @TODO the pivot should be the last touch point,
+                 * but zoomAnimation manages to overwrite the rotate
+                 * pane position. Maybe related to #3529.
+                 * 
+                 * @see https://github.com/Leaflet/Leaflet/pull/3529
+                 * @see https://github.com/fnicollet/Leaflet/commit/a77af51a6b10f308d1b9a16552091d1d0aee8834
+                 */
                 map.setBearing(this._startBearing - bearingDelta);
             }
         }
@@ -161,7 +169,9 @@ L.Map.TouchGestures = L.Handler.extend({
 
 });
 
-// @section Handlers
-// @property touchGestures: Handler
-// Touch gestures handler.
+/**
+ * Add Touch Gestures handler (enabled unless `touchGestures` is unset).
+ * 
+ * @property {L.Map.TouchGestures} touchGestures
+ */
 L.Map.addInitHook('addHandler', 'touchGestures', L.Map.TouchGestures);

package/src/map/handler/TouchRotate.js

@@ -4,13 +4,13 @@
  * @typedef L.Map.TouchRotate
  */
 
-// @namespace Map
-// @section Interaction Options
 L.Map.mergeOptions({
 
-    // @section Touch interaction options
-    // @option touchRotate: Boolean|String = *
-    // Whether the map can be rotated with a two-finger rotation gesture
+    /**
+     * Whether the map can be rotated with a two-finger rotation gesture
+     * 
+     * @type {Boolean}
+     */
     touchRotate: false,
 
 });
@@ -28,7 +28,9 @@ L.Map.TouchRotate = L.Handler.extend({
 
 });
 
-// @section Handlers
-// @property touchZoom: Handler
-// Touch rotate handler.
+/**
+ * Add Touch Rotate handler (disabled unless `touchGestures` is set).
+ * 
+ * @property {L.Map.TouchGestures} touchGestures
+ */
 L.Map.addInitHook('addHandler', 'touchRotate', L.Map.TouchRotate);

package/src/map/handler/TouchZoom.js

@@ -6,25 +6,32 @@
  * @external L.Map.TouchZoom
  */
 
-// @namespace Map
-// @section Interaction Options
 L.Map.mergeOptions({
 
-    // @section Touch interaction options
-    // @option touchZoom: Boolean|String = *
-    // Whether the map can be zoomed by touch-dragging with two fingers. If
-    // passed `'center'`, it will zoom to the center of the view regardless of
-    // where the touch events (fingers) were. Enabled for touch-capable web
-    // browsers.
+    /**
+     * Whether the map can be zoomed by touch-dragging
+     * with two fingers. If passed `'center'`, it will
+     * zoom to the center of the view regardless of
+     * where the touch events (fingers) were. Enabled
+     * for touch-capable web browsers.
+     * 
+     * @type {(Boolean|String)}
+     */
     touchZoom: L.Browser.touch,
 
     /**
-     * @TODO check if this is a duplicate of `L.Map.TouchGestures::bounceAtZoomLimits`
+     * 
      */
 
-    // @option bounceAtZoomLimits: Boolean = true
-    // Set it to false if you don't want the map to zoom beyond min/max zoom
-    // and then bounce back when pinch-zooming.
+    /**
+     * @TODO check if this is a duplicate of `L.Map.TouchGestures::bounceAtZoomLimits`
+     * 
+     * Set it to false if you don't want the map to
+     * zoom beyond min/max zoom and then bounce back
+     * when pinch-zooming.
+     * 
+     * @type {Boolean}
+     */
     bounceAtZoomLimits: false,
 
 });
@@ -44,7 +51,9 @@ L.Map.TouchZoom = L.Handler.extend({
 
 });
 
-// @section Handlers
-// @property touchZoom: Handler
-// Touch zoom handler.
+/**
+ * Add Touch Zoom handler (disabled unless `L.Browser.touch` is set).
+ * 
+ * @property {L.Map.TouchGestures} touchGestures
+ */
 L.Map.addInitHook('addHandler', 'touchZoom', L.Map.TouchZoom);

package/src/layer/vector/Canvas.js

@@ -1,28 +0,0 @@
-/**
- * @external L.Canvas
- * 
- * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/layer/vector/Canvas.js
- */
-
-const canvasProto = L.extend({}, L.Canvas.prototype);
-
-L.Canvas.include({
-
-    // onAdd: function() {
-    //     canvasProto.onAdd.apply(this, arguments);
-    //     // When rotating the canvas itself, it is cleared by some weird reason, so redraw.
-    //     this._map.on('rotate', this._redraw, this);
-    // },
-
-    // onRemove: function() {
-    //     canvasProto.onRemove.apply(this, arguments);
-    //     this._map.off('rotate', this._redraw, this);
-    // },
-
-    // _update: function() {
-    //     canvasProto._update.apply(this, arguments);
-    //     // Tell paths to redraw themselves
-    //     this.fire('update')
-    // },
-
-});

package/src/layer/vector/SVG.js

@@ -1,18 +0,0 @@
-/**
- * @external L.SVG
- * 
- * @see https://github.com/Leaflet/Leaflet/tree/v1.9.3/src/layer/vector/SVG.js
- */
-
-const svgProto = L.extend({}, L.SVG.prototype);
-
-L.SVG.include({
-
-    // _update: function() {
-    //     svgProto._update.apply(this, arguments);
-    //     if (this._map._rotate) {
-    //         this.fire('update');
-    //     }
-    // },
-
-});