@antv/l7-map 2.21.0 → 2.21.2

package/lib/handler/shim/dblclick_zoom.js

@@ -5,18 +5,18 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 /**
  * The `DoubleClickZoomHandler` allows the user to zoom the map at a point by
  * double clicking or double tapping.
  */
-var DoubleClickZoomHandler = exports.default = /*#__PURE__*/function () {
+class DoubleClickZoomHandler {
   /**
    * @private
    */
-  function DoubleClickZoomHandler(clickZoom, TapZoom) {
-    (0, _classCallCheck2.default)(this, DoubleClickZoomHandler);
+  constructor(clickZoom, TapZoom) {
+    (0, _defineProperty2.default)(this, "clickZoom", void 0);
+    (0, _defineProperty2.default)(this, "tapZoom", void 0);
     this.clickZoom = clickZoom;
     this.tapZoom = TapZoom;
   }
@@ -27,47 +27,38 @@ var DoubleClickZoomHandler = exports.default = /*#__PURE__*/function () {
    * @example
    * map.doubleClickZoom.enable();
    */
-  (0, _createClass2.default)(DoubleClickZoomHandler, [{
-    key: "enable",
-    value: function enable() {
-      this.clickZoom.enable();
-      this.tapZoom.enable();
-    }
+  enable() {
+    this.clickZoom.enable();
+    this.tapZoom.enable();
+  }
 
-    /**
-     * Disables the "double click to zoom" interaction.
-     *
-     * @example
-     * map.doubleClickZoom.disable();
-     */
-  }, {
-    key: "disable",
-    value: function disable() {
-      this.clickZoom.disable();
-      this.tapZoom.disable();
-    }
+  /**
+   * Disables the "double click to zoom" interaction.
+   *
+   * @example
+   * map.doubleClickZoom.disable();
+   */
+  disable() {
+    this.clickZoom.disable();
+    this.tapZoom.disable();
+  }
 
-    /**
-     * Returns a Boolean indicating whether the "double click to zoom" interaction is enabled.
-     *
-     * @returns {boolean} `true` if the "double click to zoom" interaction is enabled.
-     */
-  }, {
-    key: "isEnabled",
-    value: function isEnabled() {
-      return this.clickZoom.isEnabled() && this.tapZoom.isEnabled();
-    }
+  /**
+   * Returns a Boolean indicating whether the "double click to zoom" interaction is enabled.
+   *
+   * @returns {boolean} `true` if the "double click to zoom" interaction is enabled.
+   */
+  isEnabled() {
+    return this.clickZoom.isEnabled() && this.tapZoom.isEnabled();
+  }
 
-    /**
-     * Returns a Boolean indicating whether the "double click to zoom" interaction is active, i.e. currently being used.
-     *
-     * @returns {boolean} `true` if the "double click to zoom" interaction is active.
-     */
-  }, {
-    key: "isActive",
-    value: function isActive() {
-      return this.clickZoom.isActive() || this.tapZoom.isActive();
-    }
-  }]);
-  return DoubleClickZoomHandler;
-}();
+  /**
+   * Returns a Boolean indicating whether the "double click to zoom" interaction is active, i.e. currently being used.
+   *
+   * @returns {boolean} `true` if the "double click to zoom" interaction is active.
+   */
+  isActive() {
+    return this.clickZoom.isActive() || this.tapZoom.isActive();
+  }
+}
+exports.default = DoubleClickZoomHandler;

package/lib/handler/shim/drag_pan.d.ts

@@ -0,0 +1,61 @@
+import type { MousePanHandler } from '../mouse/';
+import type { TouchPanHandler } from '../touch/';
+export interface IDragPanOptions {
+    linearity?: number;
+    easing?: (t: number) => number;
+    deceleration?: number;
+    maxSpeed?: number;
+}
+/**
+ * The `DragPanHandler` allows the user to pan the map by clicking and dragging
+ * the cursor.
+ */
+export default class DragPanHandler {
+    inertiaOptions: IDragPanOptions;
+    private el;
+    private mousePan;
+    private touchPan;
+    /**
+     * @private
+     */
+    constructor(el: HTMLElement, mousePan: MousePanHandler, touchPan: TouchPanHandler);
+    /**
+     * Enables the "drag to pan" interaction.
+     *
+     * @param {Object} [options] Options object
+     * @param {number} [options.linearity=0] factor used to scale the drag velocity
+     * @param {Function} [options.easing=bezier(0, 0, 0.3, 1)] easing function applled to `map.panTo` when applying the drag.
+     * @param {number} [options.maxSpeed=1400] the maximum value of the drag velocity.
+     * @param {number} [options.deceleration=2500] the rate at which the speed reduces after the pan ends.
+     *
+     * @example
+     *   map.dragPan.enable();
+     * @example
+     *   map.dragPan.enable({
+     *      linearity: 0.3,
+     *      easing: bezier(0, 0, 0.3, 1),
+     *      maxSpeed: 1400,
+     *      deceleration: 2500,
+     *   });
+     */
+    enable(options?: IDragPanOptions): void;
+    /**
+     * Disables the "drag to pan" interaction.
+     *
+     * @example
+     * map.dragPan.disable();
+     */
+    disable(): void;
+    /**
+     * Returns a Boolean indicating whether the "drag to pan" interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "drag to pan" interaction is enabled.
+     */
+    isEnabled(): boolean;
+    /**
+     * Returns a Boolean indicating whether the "drag to pan" interaction is active, i.e. currently being used.
+     *
+     * @returns {boolean} `true` if the "drag to pan" interaction is active.
+     */
+    isActive(): boolean;
+}

package/lib/handler/shim/drag_pan.js

@@ -5,18 +5,20 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 /**
  * The `DragPanHandler` allows the user to pan the map by clicking and dragging
  * the cursor.
  */
-var DragPanHandler = exports.default = /*#__PURE__*/function () {
+class DragPanHandler {
   /**
    * @private
    */
-  function DragPanHandler(el, mousePan, touchPan) {
-    (0, _classCallCheck2.default)(this, DragPanHandler);
+  constructor(el, mousePan, touchPan) {
+    (0, _defineProperty2.default)(this, "inertiaOptions", void 0);
+    (0, _defineProperty2.default)(this, "el", void 0);
+    (0, _defineProperty2.default)(this, "mousePan", void 0);
+    (0, _defineProperty2.default)(this, "touchPan", void 0);
     this.el = el;
     this.mousePan = mousePan;
     this.touchPan = touchPan;
@@ -41,50 +43,41 @@ var DragPanHandler = exports.default = /*#__PURE__*/function () {
    *      deceleration: 2500,
    *   });
    */
-  (0, _createClass2.default)(DragPanHandler, [{
-    key: "enable",
-    value: function enable(options) {
-      this.inertiaOptions = options || {};
-      this.mousePan.enable();
-      this.touchPan.enable();
-      this.el.classList.add('l7-touch-drag-pan');
-    }
+  enable(options) {
+    this.inertiaOptions = options || {};
+    this.mousePan.enable();
+    this.touchPan.enable();
+    this.el.classList.add('l7-touch-drag-pan');
+  }
 
-    /**
-     * Disables the "drag to pan" interaction.
-     *
-     * @example
-     * map.dragPan.disable();
-     */
-  }, {
-    key: "disable",
-    value: function disable() {
-      this.mousePan.disable();
-      this.touchPan.disable();
-      this.el.classList.remove('l7-touch-drag-pan');
-    }
+  /**
+   * Disables the "drag to pan" interaction.
+   *
+   * @example
+   * map.dragPan.disable();
+   */
+  disable() {
+    this.mousePan.disable();
+    this.touchPan.disable();
+    this.el.classList.remove('l7-touch-drag-pan');
+  }
 
-    /**
-     * Returns a Boolean indicating whether the "drag to pan" interaction is enabled.
-     *
-     * @returns {boolean} `true` if the "drag to pan" interaction is enabled.
-     */
-  }, {
-    key: "isEnabled",
-    value: function isEnabled() {
-      return this.mousePan.isEnabled() && this.touchPan.isEnabled();
-    }
+  /**
+   * Returns a Boolean indicating whether the "drag to pan" interaction is enabled.
+   *
+   * @returns {boolean} `true` if the "drag to pan" interaction is enabled.
+   */
+  isEnabled() {
+    return this.mousePan.isEnabled() && this.touchPan.isEnabled();
+  }
 
-    /**
-     * Returns a Boolean indicating whether the "drag to pan" interaction is active, i.e. currently being used.
-     *
-     * @returns {boolean} `true` if the "drag to pan" interaction is active.
-     */
-  }, {
-    key: "isActive",
-    value: function isActive() {
-      return this.mousePan.isActive() || this.touchPan.isActive();
-    }
-  }]);
-  return DragPanHandler;
-}();
+  /**
+   * Returns a Boolean indicating whether the "drag to pan" interaction is active, i.e. currently being used.
+   *
+   * @returns {boolean} `true` if the "drag to pan" interaction is active.
+   */
+  isActive() {
+    return this.mousePan.isActive() || this.touchPan.isActive();
+  }
+}
+exports.default = DragPanHandler;

package/lib/handler/shim/drag_rotate.d.ts

@@ -0,0 +1,46 @@
+import type { MousePitchHandler, MouseRotateHandler } from '../mouse';
+/**
+ * The `DragRotateHandler` allows the user to rotate the map by clicking and
+ * dragging the cursor while holding the right mouse button or `ctrl` key.
+ */
+export default class DragRotateHandler {
+    private mouseRotate;
+    private mousePitch;
+    private pitchWithRotate;
+    /**
+     * @param {Object} [options]
+     * @param {number} [options.bearingSnap] The threshold, measured in degrees, that determines when the map's
+     *   bearing will snap to north.
+     * @param {bool} [options.pitchWithRotate=true] Control the map pitch in addition to the bearing
+     * @private
+     */
+    constructor(options: {
+        pitchWithRotate: boolean;
+    }, mouseRotate: MouseRotateHandler, mousePitch: MousePitchHandler);
+    /**
+     * Enables the "drag to rotate" interaction.
+     *
+     * @example
+     * map.dragRotate.enable();
+     */
+    enable(): void;
+    /**
+     * Disables the "drag to rotate" interaction.
+     *
+     * @example
+     * map.dragRotate.disable();
+     */
+    disable(): void;
+    /**
+     * Returns a Boolean indicating whether the "drag to rotate" interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "drag to rotate" interaction is enabled.
+     */
+    isEnabled(): boolean;
+    /**
+     * Returns a Boolean indicating whether the "drag to rotate" interaction is active, i.e. currently being used.
+     *
+     * @returns {boolean} `true` if the "drag to rotate" interaction is active.
+     */
+    isActive(): boolean;
+}

package/lib/handler/shim/drag_rotate.js

@@ -5,13 +5,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 /**
  * The `DragRotateHandler` allows the user to rotate the map by clicking and
  * dragging the cursor while holding the right mouse button or `ctrl` key.
  */
-var DragRotateHandler = exports.default = /*#__PURE__*/function () {
+class DragRotateHandler {
   /**
    * @param {Object} [options]
    * @param {number} [options.bearingSnap] The threshold, measured in degrees, that determines when the map's
@@ -19,8 +18,10 @@ var DragRotateHandler = exports.default = /*#__PURE__*/function () {
    * @param {bool} [options.pitchWithRotate=true] Control the map pitch in addition to the bearing
    * @private
    */
-  function DragRotateHandler(options, mouseRotate, mousePitch) {
-    (0, _classCallCheck2.default)(this, DragRotateHandler);
+  constructor(options, mouseRotate, mousePitch) {
+    (0, _defineProperty2.default)(this, "mouseRotate", void 0);
+    (0, _defineProperty2.default)(this, "mousePitch", void 0);
+    (0, _defineProperty2.default)(this, "pitchWithRotate", void 0);
     this.pitchWithRotate = options.pitchWithRotate;
     this.mouseRotate = mouseRotate;
     this.mousePitch = mousePitch;
@@ -32,49 +33,40 @@ var DragRotateHandler = exports.default = /*#__PURE__*/function () {
    * @example
    * map.dragRotate.enable();
    */
-  (0, _createClass2.default)(DragRotateHandler, [{
-    key: "enable",
-    value: function enable() {
-      this.mouseRotate.enable();
-      if (this.pitchWithRotate) {
-        this.mousePitch.enable();
-      }
+  enable() {
+    this.mouseRotate.enable();
+    if (this.pitchWithRotate) {
+      this.mousePitch.enable();
     }
+  }
 
-    /**
-     * Disables the "drag to rotate" interaction.
-     *
-     * @example
-     * map.dragRotate.disable();
-     */
-  }, {
-    key: "disable",
-    value: function disable() {
-      this.mouseRotate.disable();
-      this.mousePitch.disable();
-    }
+  /**
+   * Disables the "drag to rotate" interaction.
+   *
+   * @example
+   * map.dragRotate.disable();
+   */
+  disable() {
+    this.mouseRotate.disable();
+    this.mousePitch.disable();
+  }
 
-    /**
-     * Returns a Boolean indicating whether the "drag to rotate" interaction is enabled.
-     *
-     * @returns {boolean} `true` if the "drag to rotate" interaction is enabled.
-     */
-  }, {
-    key: "isEnabled",
-    value: function isEnabled() {
-      return this.mouseRotate.isEnabled() && (!this.pitchWithRotate || this.mousePitch.isEnabled());
-    }
+  /**
+   * Returns a Boolean indicating whether the "drag to rotate" interaction is enabled.
+   *
+   * @returns {boolean} `true` if the "drag to rotate" interaction is enabled.
+   */
+  isEnabled() {
+    return this.mouseRotate.isEnabled() && (!this.pitchWithRotate || this.mousePitch.isEnabled());
+  }
 
-    /**
-     * Returns a Boolean indicating whether the "drag to rotate" interaction is active, i.e. currently being used.
-     *
-     * @returns {boolean} `true` if the "drag to rotate" interaction is active.
-     */
-  }, {
-    key: "isActive",
-    value: function isActive() {
-      return this.mouseRotate.isActive() || this.mousePitch.isActive();
-    }
-  }]);
-  return DragRotateHandler;
-}();
+  /**
+   * Returns a Boolean indicating whether the "drag to rotate" interaction is active, i.e. currently being used.
+   *
+   * @returns {boolean} `true` if the "drag to rotate" interaction is active.
+   */
+  isActive() {
+    return this.mouseRotate.isActive() || this.mousePitch.isActive();
+  }
+}
+exports.default = DragRotateHandler;

package/lib/handler/shim/touch_zoom_rotate.d.ts

@@ -0,0 +1,70 @@
+import type TapDragZoomHandler from '../tap/tap_drag_zoom';
+import type { TouchRotateHandler, TouchZoomHandler } from '../touch';
+/**
+ * The `TouchZoomRotateHandler` allows the user to zoom and rotate the map by
+ * pinching on a touchscreen.
+ *
+ * They can zoom with one finger by double tapping and dragging. On the second tap,
+ * hold the finger down and drag up or down to zoom in or out.
+ */
+export default class TouchZoomRotateHandler {
+    private el;
+    private touchZoom;
+    private touchRotate;
+    private tapDragZoom;
+    private rotationDisabled;
+    private enabled;
+    /**
+     * @private
+     */
+    constructor(el: HTMLElement, touchZoom: TouchZoomHandler, touchRotate: TouchRotateHandler, tapDragZoom: TapDragZoomHandler);
+    /**
+     * Enables the "pinch to rotate and zoom" interaction.
+     *
+     * @param {Object} [options] Options object.
+     * @param {string} [options.around] If "center" is passed, map will zoom around the center
+     *
+     * @example
+     *   map.touchZoomRotate.enable();
+     * @example
+     *   map.touchZoomRotate.enable({ around: 'center' });
+     */
+    enable(options: {
+        around?: 'center';
+    }): void;
+    /**
+     * Disables the "pinch to rotate and zoom" interaction.
+     *
+     * @example
+     *   map.touchZoomRotate.disable();
+     */
+    disable(): void;
+    /**
+     * Returns a Boolean indicating whether the "pinch to rotate and zoom" interaction is enabled.
+     *
+     * @returns {boolean} `true` if the "pinch to rotate and zoom" interaction is enabled.
+     */
+    isEnabled(): boolean;
+    /**
+     * Returns true if the handler is enabled and has detected the start of a zoom/rotate gesture.
+     *
+     * @returns {boolean} //eslint-disable-line
+     */
+    isActive(): boolean;
+    /**
+     * Disables the "pinch to rotate" interaction, leaving the "pinch to zoom"
+     * interaction enabled.
+     *
+     * @example
+     *   map.touchZoomRotate.disableRotation();
+     */
+    disableRotation(): void;
+    /**
+     * Enables the "pinch to rotate" interaction.
+     *
+     * @example
+     *   map.touchZoomRotate.enable();
+     *   map.touchZoomRotate.enableRotation();
+     */
+    enableRotation(): void;
+}