@antv/l7-map 2.9.33 → 2.9.35

package/lib/handler/shim/drag_pan.js

@@ -1,55 +1,105 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/handler/shim/drag_pan.ts
-var drag_pan_exports = {};
-__export(drag_pan_exports, {
-  default: () => DragPanHandler
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
 });
-module.exports = __toCommonJS(drag_pan_exports);
-var import_l7_utils = require("@antv/l7-utils");
-var DragPanHandler = class {
-  constructor(el, mousePan, touchPan) {
+exports.default = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _l7Utils = require("@antv/l7-utils");
+
+/**
+ * The `DragPanHandler` allows the user to pan the map by clicking and dragging
+ * the cursor.
+ */
+var DragPanHandler = /*#__PURE__*/function () {
+  /**
+   * @private
+   */
+  function DragPanHandler(el, mousePan, touchPan) {
+    (0, _classCallCheck2.default)(this, DragPanHandler);
     this.el = el;
     this.mousePan = mousePan;
     this.touchPan = touchPan;
   }
-  enable(options) {
-    this.inertiaOptions = options || {};
-    this.mousePan.enable();
-    this.touchPan.enable();
-    if (!import_l7_utils.isMini) {
-      this.el.classList.add("l7-touch-drag-pan");
+  /**
+   * 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,
+   *   });
+   */
+
+
+  (0, _createClass2.default)(DragPanHandler, [{
+    key: "enable",
+    value: function enable(options) {
+      this.inertiaOptions = options || {};
+      this.mousePan.enable();
+      this.touchPan.enable();
+
+      if (!_l7Utils.isMini) {
+        this.el.classList.add('l7-touch-drag-pan');
+      }
     }
-  }
-  disable() {
-    this.mousePan.disable();
-    this.touchPan.disable();
-    if (!import_l7_utils.isMini) {
-      this.el.classList.remove("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();
+
+      if (!_l7Utils.isMini) {
+        this.el.classList.remove('l7-touch-drag-pan');
+      }
     }
-  }
-  isEnabled() {
-    return this.mousePan.isEnabled() && this.touchPan.isEnabled();
-  }
-  isActive() {
-    return this.mousePan.isActive() || this.touchPan.isActive();
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {});
+    /**
+     * 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 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;
+}();
+
+exports.default = DragPanHandler;

package/lib/handler/shim/drag_rotate.js

@@ -1,49 +1,88 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/handler/shim/drag_rotate.ts
-var drag_rotate_exports = {};
-__export(drag_rotate_exports, {
-  default: () => DragRotateHandler
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
 });
-module.exports = __toCommonJS(drag_rotate_exports);
-var DragRotateHandler = class {
-  constructor(options, mouseRotate, mousePitch) {
+exports.default = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+/**
+ * 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 = /*#__PURE__*/function () {
+  /**
+   * @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
+   */
+  function DragRotateHandler(options, mouseRotate, mousePitch) {
+    (0, _classCallCheck2.default)(this, DragRotateHandler);
     this.pitchWithRotate = options.pitchWithRotate;
     this.mouseRotate = mouseRotate;
     this.mousePitch = mousePitch;
   }
-  enable() {
-    this.mouseRotate.enable();
-    if (this.pitchWithRotate) {
-      this.mousePitch.enable();
+  /**
+   * Enables the "drag to rotate" interaction.
+   *
+   * @example
+   * map.dragRotate.enable();
+   */
+
+
+  (0, _createClass2.default)(DragRotateHandler, [{
+    key: "enable",
+    value: function enable() {
+      this.mouseRotate.enable();
+
+      if (this.pitchWithRotate) {
+        this.mousePitch.enable();
+      }
     }
-  }
-  disable() {
-    this.mouseRotate.disable();
-    this.mousePitch.disable();
-  }
-  isEnabled() {
-    return this.mouseRotate.isEnabled() && (!this.pitchWithRotate || this.mousePitch.isEnabled());
-  }
-  isActive() {
-    return this.mouseRotate.isActive() || this.mousePitch.isActive();
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {});
+    /**
+     * Disables the "drag to rotate" interaction.
+     *
+     * @example
+     * map.dragRotate.disable();
+     */
+
+  }, {
+    key: "disable",
+    value: function 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 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;
+}();
+
+exports.default = DragRotateHandler;

package/lib/handler/shim/touch_zoom_rotate.js

@@ -1,30 +1,31 @@
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/handler/shim/touch_zoom_rotate.ts
-var touch_zoom_rotate_exports = {};
-__export(touch_zoom_rotate_exports, {
-  default: () => TouchZoomRotateHandler
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
 });
-module.exports = __toCommonJS(touch_zoom_rotate_exports);
-var import_l7_utils = require("@antv/l7-utils");
-var TouchZoomRotateHandler = class {
-  constructor(el, touchZoom, touchRotate, tapDragZoom) {
+exports.default = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _l7Utils = require("@antv/l7-utils");
+
+/**
+ * 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.
+ */
+var TouchZoomRotateHandler = /*#__PURE__*/function () {
+  /**
+   * @private
+   */
+  function TouchZoomRotateHandler(el, touchZoom, touchRotate, tapDragZoom) {
+    (0, _classCallCheck2.default)(this, TouchZoomRotateHandler);
     this.el = el;
     this.touchZoom = touchZoom;
     this.touchRotate = touchRotate;
@@ -32,40 +33,107 @@ var TouchZoomRotateHandler = class {
     this.rotationDisabled = false;
     this.enabled = true;
   }
-  enable(options) {
-    this.touchZoom.enable(options);
-    if (!this.rotationDisabled) {
-      this.touchRotate.enable(options);
+  /**
+   * 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' });
+   */
+
+
+  (0, _createClass2.default)(TouchZoomRotateHandler, [{
+    key: "enable",
+    value: function enable(options) {
+      this.touchZoom.enable(options);
+
+      if (!this.rotationDisabled) {
+        this.touchRotate.enable(options);
+      }
+
+      this.tapDragZoom.enable();
+
+      if (!_l7Utils.isMini) {
+        this.el.classList.add('l7-touch-zoom-rotate');
+      }
     }
-    this.tapDragZoom.enable();
-    if (!import_l7_utils.isMini) {
-      this.el.classList.add("l7-touch-zoom-rotate");
+    /**
+     * Disables the "pinch to rotate and zoom" interaction.
+     *
+     * @example
+     *   map.touchZoomRotate.disable();
+     */
+
+  }, {
+    key: "disable",
+    value: function disable() {
+      this.touchZoom.disable();
+      this.touchRotate.disable();
+      this.tapDragZoom.disable();
+
+      if (!_l7Utils.isMini) {
+        this.el.classList.remove('l7-touch-zoom-rotate');
+      }
     }
-  }
-  disable() {
-    this.touchZoom.disable();
-    this.touchRotate.disable();
-    this.tapDragZoom.disable();
-    if (!import_l7_utils.isMini) {
-      this.el.classList.remove("l7-touch-zoom-rotate");
+    /**
+     * 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.
+     */
+
+  }, {
+    key: "isEnabled",
+    value: function isEnabled() {
+      return this.touchZoom.isEnabled() && (this.rotationDisabled || this.touchRotate.isEnabled()) && this.tapDragZoom.isEnabled();
     }
-  }
-  isEnabled() {
-    return this.touchZoom.isEnabled() && (this.rotationDisabled || this.touchRotate.isEnabled()) && this.tapDragZoom.isEnabled();
-  }
-  isActive() {
-    return this.touchZoom.isActive() || this.touchRotate.isActive() || this.tapDragZoom.isActive();
-  }
-  disableRotation() {
-    this.rotationDisabled = true;
-    this.touchRotate.disable();
-  }
-  enableRotation() {
-    this.rotationDisabled = false;
-    if (this.touchZoom.isEnabled()) {
-      this.touchRotate.enable();
+    /**
+     * Returns true if the handler is enabled and has detected the start of a zoom/rotate gesture.
+     *
+     * @returns {boolean} //eslint-disable-line
+     */
+
+  }, {
+    key: "isActive",
+    value: function isActive() {
+      return this.touchZoom.isActive() || this.touchRotate.isActive() || this.tapDragZoom.isActive();
     }
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {});
+    /**
+     * Disables the "pinch to rotate" interaction, leaving the "pinch to zoom"
+     * interaction enabled.
+     *
+     * @example
+     *   map.touchZoomRotate.disableRotation();
+     */
+
+  }, {
+    key: "disableRotation",
+    value: function disableRotation() {
+      this.rotationDisabled = true;
+      this.touchRotate.disable();
+    }
+    /**
+     * Enables the "pinch to rotate" interaction.
+     *
+     * @example
+     *   map.touchZoomRotate.enable();
+     *   map.touchZoomRotate.enableRotation();
+     */
+
+  }, {
+    key: "enableRotation",
+    value: function enableRotation() {
+      this.rotationDisabled = false;
+
+      if (this.touchZoom.isEnabled()) {
+        this.touchRotate.enable();
+      }
+    }
+  }]);
+  return TouchZoomRotateHandler;
+}();
+
+exports.default = TouchZoomRotateHandler;