@antv/l7-map 2.9.19 → 2.9.22-alpha.0

package/es/geo/edge_insets.js

@@ -1,10 +1,20 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { clamp, interpolate as _interpolate } from '../util';
-import Point from './point';
+// @ts-ignore
+import { clamp, interpolate as _interpolate } from "../util";
+import Point from "./point";
+/**
+ * An `EdgeInset` object represents screen space padding applied to the edges of the viewport.
+ * This shifts the apprent center or the vanishing point of the map. This is useful for adding floating UI elements
+ * on top of the map and having the vanishing point shift as UI elements resize.
+ *
+ * @param {number} [top=0]
+ * @param {number} [bottom=0]
+ * @param {number} [left=0]
+ * @param {number} [right=0]
+ */
 
-var EdgeInsets = function () {
+var EdgeInsets = /*#__PURE__*/function () {
   function EdgeInsets() {
     var top = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
     var bottom = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
@@ -13,14 +23,6 @@ var EdgeInsets = function () {
 
     _classCallCheck(this, EdgeInsets);
 
-    _defineProperty(this, "top", void 0);
-
-    _defineProperty(this, "bottom", void 0);
-
-    _defineProperty(this, "left", void 0);
-
-    _defineProperty(this, "right", void 0);
-
     if (isNaN(top) || top < 0 || isNaN(bottom) || bottom < 0 || isNaN(left) || left < 0 || isNaN(right) || right < 0) {
       throw new Error('Invalid value for edge-insets, top, bottom, left and right must all be numbers');
     }
@@ -30,6 +32,16 @@ var EdgeInsets = function () {
     this.left = left;
     this.right = right;
   }
+  /**
+   * Interpolates the inset in-place.
+   * This maintains the current inset value for any inset not present in `target`.
+   *
+   * @param {PaddingOptions} target
+   * @param {number} t
+   * @returns {EdgeInsets}
+   * @memberof EdgeInsets
+   */
+
 
   _createClass(EdgeInsets, [{
     key: "interpolate",
@@ -52,9 +64,20 @@ var EdgeInsets = function () {
 
       return this;
     }
+    /**
+     * Utility method that computes the new apprent center or vanishing point after applying insets.
+     * This is in pixels and with the top left being (0.0) and +y being downwards.
+     *
+     * @param {number} width
+     * @param {number} height
+     * @returns {Point}
+     * @memberof EdgeInsets
+     */
+
   }, {
     key: "getCenter",
     value: function getCenter(width, height) {
+      // Clamp insets so they never overflow width/height and always calculate a valid center
       var x = clamp((this.left + width - this.right) / 2, 0, width);
       var y = clamp((this.top + height - this.bottom) / 2, 0, height);
       return new Point(x, y);
@@ -69,6 +92,14 @@ var EdgeInsets = function () {
     value: function clone() {
       return new EdgeInsets(this.top, this.bottom, this.left, this.right);
     }
+    /**
+     * Returns the current sdtate as json, useful when you want to have a
+     * read-only representation of the inset.
+     *
+     * @returns {PaddingOptions}
+     * @memberof EdgeInsets
+     */
+
   }, {
     key: "toJSON",
     value: function toJSON() {
@@ -84,5 +115,4 @@ var EdgeInsets = function () {
   return EdgeInsets;
 }();
 
-export { EdgeInsets as default };
-//# sourceMappingURL=edge_insets.js.map
+export { EdgeInsets as default };

package/es/geo/lng_lat.js

@@ -1,18 +1,13 @@
 import _typeof from "@babel/runtime/helpers/typeof";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { wrap as _wrap } from '../util';
+import { wrap as _wrap } from "../util";
 export var earthRadius = 6371008.8;
 
-var LngLat = function () {
+var LngLat = /*#__PURE__*/function () {
   function LngLat(lng, lat) {
     _classCallCheck(this, LngLat);
 
-    _defineProperty(this, "lng", void 0);
-
-    _defineProperty(this, "lat", void 0);
-
     if (isNaN(lng) || isNaN(lat)) {
       throw new Error("Invalid LngLat object: (".concat(lng, ", ").concat(lat, ")"));
     }
@@ -34,7 +29,16 @@ var LngLat = function () {
     key: "toArray",
     value: function toArray() {
       return [this.lng, this.lat];
-    }
+    } // public toBounds(radius: number = 0) {
+    //   const earthCircumferenceInMetersAtEquator = 40075017;
+    //   const latAccuracy = (360 * radius) / earthCircumferenceInMetersAtEquator;
+    //   const lngAccuracy = latAccuracy / Math.cos((Math.PI / 180) * this.lat);
+    //   return new LngLatBounds(
+    //     new LngLat(this.lng - lngAccuracy, this.lat - latAccuracy),
+    //     new LngLat(this.lng + lngAccuracy, this.lat + latAccuracy),
+    //   );
+    // }
+
   }, {
     key: "toString",
     value: function toString() {
@@ -63,7 +67,8 @@ var LngLat = function () {
 
       if (!Array.isArray(input) && _typeof(input) === 'object' && input !== null) {
         var lng = 'lng' in input ? input.lng : input.lon;
-        return new LngLat(Number(lng), Number(input.lat));
+        return new LngLat( // flow can't refine this to have one of lng or lat, so we have to cast to any
+        Number(lng), Number(input.lat));
       }
 
       throw new Error('`LngLatLike` argument must be specified as a LngLat instance, an object {lng: <lng>, lat: <lat>}, an object {lon: <lng>, lat: <lat>}, or an array of [<lng>, <lat>]');
@@ -73,5 +78,4 @@ var LngLat = function () {
   return LngLat;
 }();
 
-export { LngLat as default };
-//# sourceMappingURL=lng_lat.js.map
+export { LngLat as default };

package/es/geo/lng_lat_bounds.js

@@ -1,17 +1,13 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import LngLat from './lng_lat';
+import LngLat from "./lng_lat";
 
-var LngLatBounds = function () {
+var LngLatBounds = /*#__PURE__*/function () {
   function LngLatBounds(sw, ne) {
     _classCallCheck(this, LngLatBounds);
 
-    _defineProperty(this, "ne", void 0);
-
-    _defineProperty(this, "sw", void 0);
-
-    if (!sw) {} else if (ne) {
+    if (!sw) {// noop
+    } else if (ne) {
       this.setSouthWest(sw).setNorthEast(ne);
     } else if (sw.length === 4) {
       this.setSouthWest([sw[0], sw[1]]).setNorthEast([sw[2], sw[3]]);
@@ -147,6 +143,7 @@ var LngLatBounds = function () {
       var containsLongitude = this.sw.lng <= lng && lng <= this.ne.lng;
 
       if (this.sw.lng > this.ne.lng) {
+        // wrapped coordinates
         containsLongitude = this.sw.lng >= lng && lng >= this.ne.lng;
       }
 
@@ -166,5 +163,4 @@ var LngLatBounds = function () {
   return LngLatBounds;
 }();
 
-export { LngLatBounds as default };
-//# sourceMappingURL=lng_lat_bounds.js.map
+export { LngLatBounds as default };

package/es/geo/mercator.js

@@ -1,8 +1,15 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import LngLat, { earthRadius } from '../geo/lng_lat';
-var earthCircumfrence = 2 * Math.PI * earthRadius;
+import LngLat, { earthRadius } from "../geo/lng_lat";
+/*
+ * The average circumference of the world in meters.
+ */
+
+var earthCircumfrence = 2 * Math.PI * earthRadius; // meters
+
+/*
+ * The circumference at a line of latitude in meters.
+ */
 
 function circumferenceAtLatitude(latitude) {
   return earthCircumfrence * Math.cos(latitude * Math.PI / 180);
@@ -27,22 +34,27 @@ export function latFromMercatorY(y) {
 export function altitudeFromMercatorZ(z, y) {
   return z * circumferenceAtLatitude(latFromMercatorY(y));
 }
+/**
+ * Determine the Mercator scale factor for a given latitude, see
+ * https://en.wikipedia.org/wiki/Mercator_projection#Scale_factor
+ *
+ * At the equator the scale factor will be 1, which increases at higher latitudes.
+ *
+ * @param {number} lat Latitude
+ * @returns {number} scale factor
+ * @private
+ */
+
 export function mercatorScale(lat) {
   return 1 / Math.cos(lat * Math.PI / 180);
 }
 
-var MercatorCoordinate = function () {
+var MercatorCoordinate = /*#__PURE__*/function () {
   function MercatorCoordinate(x, y) {
     var z = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
 
     _classCallCheck(this, MercatorCoordinate);
 
-    _defineProperty(this, "x", void 0);
-
-    _defineProperty(this, "y", void 0);
-
-    _defineProperty(this, "z", void 0);
-
     this.x = +x;
     this.y = +y;
     this.z = +z;
@@ -61,6 +73,7 @@ var MercatorCoordinate = function () {
   }, {
     key: "meterInMercatorCoordinateUnits",
     value: function meterInMercatorCoordinateUnits() {
+      // 1 meter / circumference at equator in meters * Mercator projection scale factor at this latitude
       return 1 / earthCircumfrence * mercatorScale(latFromMercatorY(this.y));
     }
   }], [{
@@ -75,5 +88,4 @@ var MercatorCoordinate = function () {
   return MercatorCoordinate;
 }();
 
-export { MercatorCoordinate as default };
-//# sourceMappingURL=mercator.js.map
+export { MercatorCoordinate as default };

package/es/geo/point.js

@@ -1,15 +1,10 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
 
-var Point = function () {
+var Point = /*#__PURE__*/function () {
   function Point(x, y) {
     _classCallCheck(this, Point);
 
-    _defineProperty(this, "x", void 0);
-
-    _defineProperty(this, "y", void 0);
-
     this.x = x;
     this.y = y;
   }
@@ -233,5 +228,4 @@ var Point = function () {
   return Point;
 }();
 
-export { Point as default };
-//# sourceMappingURL=point.js.map
+export { Point as default };

package/es/geo/simple.js

@@ -1,8 +1,15 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import LngLat, { earthRadius } from '../geo/lng_lat';
-var earthCircumfrence = 2 * Math.PI * earthRadius;
+import LngLat, { earthRadius } from "../geo/lng_lat";
+/*
+ * The average circumference of the world in meters.
+ */
+
+var earthCircumfrence = 2 * Math.PI * earthRadius; // meters
+
+/*
+ * The circumference at a line of latitude in meters.
+ */
 
 function circumferenceAtLatitude(latitude) {
   return earthCircumfrence * Math.cos(latitude * Math.PI / 180);
@@ -26,22 +33,27 @@ export function latFromMercatorY(y) {
 export function altitudeFromMercatorZ(z, y) {
   return z;
 }
+/**
+ * Determine the Mercator scale factor for a given latitude, see
+ * https://en.wikipedia.org/wiki/Mercator_projection#Scale_factor
+ *
+ * At the equator the scale factor will be 1, which increases at higher latitudes.
+ *
+ * @param {number} lat Latitude
+ * @returns {number} scale factor
+ * @private
+ */
+
 export function mercatorScale(lat) {
   return 1;
 }
 
-var SimpleCoordinate = function () {
+var SimpleCoordinate = /*#__PURE__*/function () {
   function SimpleCoordinate(x, y) {
     var z = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
 
     _classCallCheck(this, SimpleCoordinate);
 
-    _defineProperty(this, "x", void 0);
-
-    _defineProperty(this, "y", void 0);
-
-    _defineProperty(this, "z", void 0);
-
     this.x = +x;
     this.y = +y;
     this.z = +z;
@@ -60,6 +72,7 @@ var SimpleCoordinate = function () {
   }, {
     key: "meterInMercatorCoordinateUnits",
     value: function meterInMercatorCoordinateUnits() {
+      // 1 meter / circumference at equator in meters * Mercator projection scale factor at this latitude
       return 1;
     }
   }], [{
@@ -74,5 +87,4 @@ var SimpleCoordinate = function () {
   return SimpleCoordinate;
 }();
 
-export { SimpleCoordinate as default };
-//# sourceMappingURL=simple.js.map
+export { SimpleCoordinate as default };