geojs 1.8.10 → 1.9.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geojs",
-  "version": "1.8.10",
+  "version": "1.9.2",
   "description": "JavaScript Geo Visualization and Analysis Library",
   "homepage": "https://github.com/OpenGeoscience/geojs",
   "license": "Apache-2.0",
@@ -21,6 +21,7 @@
     "jquery": "^3.6.0",
     "kdbush": "^3.0.0",
     "mousetrap": "^1.6.5",
+    "polybooljs": "git+https://github.com/manubb/polybooljs#eps-logic",
     "proj4": "^2.7.5",
     "vgl": "0.3.11"
   },
@@ -48,19 +49,19 @@
     "eslint-plugin-import": "^2.25.3",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.0.0",
-    "expose-loader": "^3.1.0",
+    "expose-loader": "^4.0.0",
     "express": "^4.17.2",
     "fs-extra": "^10.0.0",
     "glob": "^8.0.1",
     "glslang-validator-prebuilt": "^0.0.7",
-    "imports-loader": "^3.1.1",
+    "imports-loader": "^4.0.0",
     "jaguarjs-jsdoc": "^1.0.2",
     "jasmine-core": "^4.0.0",
     "js-yaml": "^4.1.0",
     "jsdoc": "^3.6.10",
     "jsdoc-autoprivate": "0.0.1",
     "jsonlint-mod": "^1.7.6",
-    "jstransformer-markdown-it": "jstransformers/jstransformer-markdown-it#snyk-fix-9cae6682d6a0ba4f72fd9fec4e488acd",
+    "jstransformer-markdown-it": "git+https://github.com/jstransformers/jstransformer-markdown-it#snyk-fix-9cae6682d6a0ba4f72fd9fec4e488acd",
     "karma": "^6.3.15",
     "karma-chrome-launcher": "^3.1.0",
     "karma-coverage": "^2.1.1",
@@ -85,7 +86,7 @@
     "sinon": "^14.0.0",
     "style-loader": "^3.3.1",
     "stylus": "^0.57.0",
-    "stylus-loader": "^6.2.0",
+    "stylus-loader": "^7.0.0",
     "terser-webpack-plugin": "^5.3.1",
     "touch-emulator": "^1.0.0",
     "typeface-lato": "^1.1.13",

package/src/annotation/annotation.js

@@ -74,6 +74,12 @@ var editHandleFeatureLevel = 3;
  * @property {boolean|string[]} [showLabel=true] `true` to show the annotation
  *    label on annotations in done or edit states.  Alternately, a list of
  *    states in which to show the label.  Falsy to not show the label.
+ * @property {boolean} [allowBooleanOperations] This defaults to `true` for
+ *    annotations that have area and `false` for those without area (e.g.,
+ *    false for lines and points).  If it is truthy, then, when the annotation
+ *    is being created, it checks the metakeys on the first click that defines
+ *    a coordinate to determine what boolean polygon operation should be
+ *    performaned on the completion of the annotation.
  */
 
 /**
@@ -94,7 +100,7 @@ var annotation = function (type, args) {
   }
 
   var m_this = this,
-      m_options = $.extend({}, {showLabel: true}, args || {}),
+      m_options = $.extend(true, {}, this.constructor.defaults, args || {}),
       m_id = m_options.annotationId;
   delete m_options.annotationId;
   if (m_id === undefined || (m_options.layer && m_options.layer.annotationById(m_id))) {
@@ -797,10 +803,14 @@ var annotation = function (type, args) {
       key = styles[i];
       value = util.ensureFunction(objStyle[key])();
       if (value !== undefined) {
+        let defvalue = ((m_this.constructor.defaults || {}).style || {})[key];
         if (key.toLowerCase().match(/color$/)) {
           value = util.convertColorToHex(value, 'needed');
+          defvalue = defvalue !== undefined ? util.convertColorToHex(defvalue, 'needed') : defvalue;
+        }
+        if (value !== defvalue) {
+          obj.properties[key] = value;
         }
-        obj.properties[key] = value;
       }
     }
     for (i = 0; i < textFeature.usedStyles.length; i += 1) {
@@ -1408,6 +1418,13 @@ function constrainAspectRatio(ratio) {
   return constraintFunction;
 }
 
+/**
+ * This object contains the default options to initialize the class.
+ */
+annotation.defaults = {
+  showLabel: true
+};
+
 module.exports = {
   state: annotationState,
   actionOwner: annotationActionOwner,

package/src/annotation/circleAnnotation.js

@@ -19,13 +19,20 @@ const ellipseAnnotation = require('./ellipseAnnotation');
  */
 var circleAnnotation = function (args, annotationName) {
   'use strict';
-  args = $.extend({}, args, {constraint: 1});
   if (!(this instanceof circleAnnotation)) {
     return new circleAnnotation(args, annotationName);
   }
+  args = $.extend(true, {}, this.constructor.defaults, args, {constraint: 1});
   ellipseAnnotation.call(this, args, annotationName || 'circle');
 };
 inherit(circleAnnotation, ellipseAnnotation);
+
+/**
+ * This object contains the default options to initialize the class.
+ */
+circleAnnotation.defaults = $.extend({}, ellipseAnnotation.defaults, {
+});
+
 var circleRequiredFeatures = {};
 circleRequiredFeatures[markerFeature.capabilities.feature] = true;
 registerAnnotation('circle', circleAnnotation, circleRequiredFeatures);

package/src/annotation/ellipseAnnotation.js

@@ -23,7 +23,7 @@ var ellipseAnnotation = function (args, annotationName) {
   if (!(this instanceof ellipseAnnotation)) {
     return new ellipseAnnotation(args, annotationName);
   }
-
+  args = $.extend(true, {}, this.constructor.defaults, args);
   rectangleAnnotation.call(this, args, annotationName || 'ellipse');
 
   var m_this = this;
@@ -70,9 +70,59 @@ var ellipseAnnotation = function (args, annotationName) {
     }
     return features;
   };
+
+  /**
+   * Return this annotation as a polygon list.
+   *
+   * @param {geo.util.polyop.spec} [opts] The ``tolerance`` and
+   *   ``pixelTolerance`` parameters are used if set.  Otherwise, a polygon is
+   *   approximated to 1/10th of a pixel at the map's current maximum zoom
+   *   level.
+   * @returns {geo.polygonList} A list of polygons.
+   */
+  this.toPolygonList = function (opts) {
+    const coord = m_this._coordinates();
+    if (coord.length < 3) {
+      return [];
+    }
+    let tolerance = (opts && opts.tolerance) || 0;
+    if (!tolerance) {
+      const map = m_this.layer().map();
+      if (opts && opts.pixelTolerance) {
+        tolerance = map.unitsPerPixel(map.zoom()) * opts.pixelTolerance;
+      } else {
+        tolerance = map.unitsPerPixel(map.zoomRange().max) * 0.1;
+      }
+    }
+    const w = ((coord[0].x - coord[1].x) ** 2 + (coord[0].y - coord[1].y) ** 2) ** 0.5;
+    const h = ((coord[0].x - coord[3].x) ** 2 + (coord[0].y - coord[3].y) ** 2) ** 0.5;
+    const cx = (coord[0].x + coord[2].x) / 2;
+    const cy = (coord[0].y + coord[2].y) / 2;
+    const radius = Math.max(w, h) / 2;
+    const rotation = -Math.atan2(coord[1].y - coord[0].y, coord[1].x - coord[0].x);
+    const sides = Math.max(12, Math.ceil(Math.PI / Math.acos((radius - tolerance) / (radius + tolerance))));
+    const a = w / 2 * (1 + (1 - Math.cos(Math.PI / sides)) / 2);
+    const b = h / 2 * (1 + (1 - Math.cos(Math.PI / sides)) / 2);
+    const poly = [];
+    const cosr = Math.cos(rotation), sinr = Math.sin(rotation);
+    for (let s = 0; s < sides; s += 1) {
+      const sa = Math.PI * 2 * s / sides;
+      const cosa = Math.cos(sa), sina = Math.sin(sa);
+      const x = cx + a * cosr * cosa - b * sinr * sina;
+      const y = cy + a * sinr * cosa + b * cosr * sina;
+      poly.push([x, y]);
+    }
+    return [[poly]];
+  };
 };
 inherit(ellipseAnnotation, rectangleAnnotation);
 
+/**
+ * This object contains the default options to initialize the class.
+ */
+ellipseAnnotation.defaults = $.extend({}, rectangleAnnotation.defaults, {
+});
+
 var ellipseRequiredFeatures = {};
 ellipseRequiredFeatures[markerFeature.capabilities.feature] = true;
 registerAnnotation('ellipse', ellipseAnnotation, ellipseRequiredFeatures);

package/src/annotation/lineAnnotation.js

@@ -37,8 +37,7 @@ var lineAnnotation = function (args) {
   if (!(this instanceof lineAnnotation)) {
     return new lineAnnotation(args);
   }
-
-  args = $.extend(true, {}, {
+  args = $.extend(true, {}, this.constructor.defaults, {
     style: {
       line: function (d) {
         /* Return an array that has the same number of items as we have
@@ -48,16 +47,7 @@ var lineAnnotation = function (args) {
       },
       position: function (d, i) {
         return m_this.options('vertices')[i];
-      },
-      strokeColor: {r: 0, g: 0, b: 0},
-      strokeOpacity: 1,
-      strokeWidth: 3,
-      closed: false,
-      lineCap: 'butt',
-      lineJoin: 'miter'
-    },
-    highlightStyle: {
-      strokeWidth: 5
+      }
     },
     createStyle: {
       line: function (d) {
@@ -68,15 +58,9 @@ var lineAnnotation = function (args) {
       },
       position: function (d, i) {
         return m_this.options('vertices')[i];
-      },
-      strokeColor: {r: 0, g: 0, b: 1},
-      strokeOpacity: 1,
-      strokeWidth: 3,
-      closed: false,
-      lineCap: 'butt',
-      lineJoin: 'miter'
+      }
     }
-  }, args || {});
+  }, args);
   args.vertices = args.vertices || args.coordinates || [];
   delete args.coordinates;
   annotation.call(this, 'line', args);
@@ -337,6 +321,31 @@ var lineAnnotation = function (args) {
 };
 inherit(lineAnnotation, annotation);
 
+/**
+ * This object contains the default options to initialize the class.
+ */
+lineAnnotation.defaults = $.extend({}, annotation.defaults, {
+  style: {
+    strokeColor: {r: 0, g: 0, b: 0},
+    strokeOpacity: 1,
+    strokeWidth: 3,
+    closed: false,
+    lineCap: 'butt',
+    lineJoin: 'miter'
+  },
+  highlightStyle: {
+    strokeWidth: 5
+  },
+  createStyle: {
+    strokeColor: {r: 0, g: 0, b: 1},
+    strokeOpacity: 1,
+    strokeWidth: 3,
+    closed: false,
+    lineCap: 'butt',
+    lineJoin: 'miter'
+  }
+});
+
 var lineRequiredFeatures = {};
 lineRequiredFeatures[lineFeature.capabilities.basic] = [annotationState.create];
 registerAnnotation('line', lineAnnotation, lineRequiredFeatures);

package/src/annotation/pointAnnotation.js

@@ -40,29 +40,7 @@ var pointAnnotation = function (args) {
     return new pointAnnotation(args);
   }
 
-  args = $.extend(true, {}, {
-    style: {
-      fill: true,
-      fillColor: {r: 0, g: 1, b: 0},
-      fillOpacity: 0.25,
-      radius: 10,
-      scaled: false,
-      stroke: true,
-      strokeColor: {r: 0, g: 0, b: 0},
-      strokeOpacity: 1,
-      strokeWidth: 3
-    },
-    createStyle: {
-      fillColor: {r: 0.3, g: 0.3, b: 0.3},
-      fillOpacity: 0.25,
-      strokeColor: {r: 0, g: 0, b: 1}
-    },
-    highlightStyle: {
-      fillColor: {r: 0, g: 1, b: 1},
-      fillOpacity: 0.5,
-      strokeWidth: 5
-    }
-  }, args || {});
+  args = $.extend(true, {}, this.constructor.defaults, args);
   args.position = args.position || (args.coordinates ? args.coordinates[0] : undefined);
   delete args.coordinates;
   annotation.call(this, 'point', args);
@@ -201,6 +179,33 @@ var pointAnnotation = function (args) {
 };
 inherit(pointAnnotation, annotation);
 
+/**
+ * This object contains the default options to initialize the class.
+ */
+pointAnnotation.defaults = $.extend({}, annotation.defaults, {
+  style: {
+    fill: true,
+    fillColor: {r: 0, g: 1, b: 0},
+    fillOpacity: 0.25,
+    radius: 10,
+    scaled: false,
+    stroke: true,
+    strokeColor: {r: 0, g: 0, b: 0},
+    strokeOpacity: 1,
+    strokeWidth: 3
+  },
+  createStyle: {
+    fillColor: {r: 0.3, g: 0.3, b: 0.3},
+    fillOpacity: 0.25,
+    strokeColor: {r: 0, g: 0, b: 1}
+  },
+  highlightStyle: {
+    fillColor: {r: 0, g: 1, b: 1},
+    fillOpacity: 0.5,
+    strokeWidth: 5
+  }
+});
+
 var pointRequiredFeatures = {};
 pointRequiredFeatures[pointFeature.capabilities.feature] = true;
 registerAnnotation('point', pointAnnotation, pointRequiredFeatures);

package/src/annotation/polygonAnnotation.js

@@ -43,27 +43,11 @@ var polygonAnnotation = function (args) {
     return new polygonAnnotation(args);
   }
 
-  args = $.extend(true, {}, {
+  args = $.extend(true, {}, this.constructor.defaults, {
     style: {
-      fill: true,
-      fillColor: {r: 0, g: 1, b: 0},
-      fillOpacity: 0.25,
-      polygon: function (d) { return d.polygon; },
-      stroke: true,
-      strokeColor: {r: 0, g: 0, b: 0},
-      strokeOpacity: 1,
-      strokeWidth: 3,
-      uniformPolygon: true
-    },
-    highlightStyle: {
-      fillColor: {r: 0, g: 1, b: 1},
-      fillOpacity: 0.5,
-      strokeWidth: 5
+      polygon: function (d) { return d.polygon; }
     },
     createStyle: {
-      closed: false,
-      fillColor: {r: 0.3, g: 0.3, b: 0.3},
-      fillOpacity: 0.25,
       line: function (d) {
         const coord = m_this._coordinates();
         /* Return an array that has the same number of items as we have
@@ -76,11 +60,9 @@ var polygonAnnotation = function (args) {
           return d.x;
         }
         return m_this.options('vertices')[i];
-      },
-      stroke: false,
-      strokeColor: {r: 0, g: 0, b: 1}
+      }
     }
-  }, args || {});
+  }, args);
   args.vertices = args.vertices || args.coordinates || [];
   delete args.coordinates;
   annotation.call(this, 'polygon', args);
@@ -135,6 +117,25 @@ var polygonAnnotation = function (args) {
     return features;
   };
 
+  /**
+   * Return this annotation as a polygon list.
+   *
+   * @param {geo.util.polyop.spec} [opts] Ignored.
+   * @returns {geo.polygonList} A list of polygons.
+   */
+  this.toPolygonList = function (opts) {
+    const coord = m_this._coordinates();
+    if (coord.outer) {
+      const result = [[coord.outer.map((pt) => [pt.x, pt.y])]];
+      (coord.inner || []).forEach((h) => result[0].push(h.map((pt) => [pt.x, pt.y])));
+      return result;
+    }
+    if (coord.length < 3) {
+      return [];
+    }
+    return [[coord.map((pt) => [pt.x, pt.y])]];
+  };
+
   /**
    * Get and optionally set coordinates associated with this annotation in the
    * map gcs coordinate system.
@@ -305,6 +306,35 @@ var polygonAnnotation = function (args) {
 };
 inherit(polygonAnnotation, annotation);
 
+/**
+ * This object contains the default options to initialize the class.
+ */
+polygonAnnotation.defaults = $.extend({}, annotation.defaults, {
+  style: {
+    fill: true,
+    fillColor: {r: 0, g: 1, b: 0},
+    fillOpacity: 0.25,
+    stroke: true,
+    strokeColor: {r: 0, g: 0, b: 0},
+    strokeOpacity: 1,
+    strokeWidth: 3,
+    uniformPolygon: true
+  },
+  highlightStyle: {
+    fillColor: {r: 0, g: 1, b: 1},
+    fillOpacity: 0.5,
+    strokeWidth: 5
+  },
+  createStyle: {
+    closed: false,
+    fillColor: {r: 0.3, g: 0.3, b: 0.3},
+    fillOpacity: 0.25,
+    stroke: false,
+    strokeColor: {r: 0, g: 0, b: 1}
+  },
+  allowBooleanOperations: true
+});
+
 var polygonRequiredFeatures = {};
 polygonRequiredFeatures[polygonFeature.capabilities.feature] = true;
 polygonRequiredFeatures[lineFeature.capabilities.basic] = [annotationState.create];

package/src/annotation/rectangleAnnotation.js

@@ -48,29 +48,7 @@ var rectangleAnnotation = function (args, annotationName) {
     return new rectangleAnnotation(args, annotationName);
   }
 
-  args = $.extend(true, {}, {
-    style: {
-      fill: true,
-      fillColor: {r: 0, g: 1, b: 0},
-      fillOpacity: 0.25,
-      polygon: function (d) { return d.polygon; },
-      stroke: true,
-      strokeColor: {r: 0, g: 0, b: 0},
-      strokeOpacity: 1,
-      strokeWidth: 3,
-      uniformPolygon: true
-    },
-    highlightStyle: {
-      fillColor: {r: 0, g: 1, b: 1},
-      fillOpacity: 0.5,
-      strokeWidth: 5
-    },
-    createStyle: {
-      fillColor: {r: 0.3, g: 0.3, b: 0.3},
-      fillOpacity: 0.25,
-      strokeColor: {r: 0, g: 0, b: 1}
-    }
-  }, args || {});
+  args = $.extend(true, {}, this.constructor.defaults, args);
   args.corners = args.corners || args.coordinates || [];
   delete args.coordinates;
   annotation.call(this, annotationName || 'rectangle', args);
@@ -167,6 +145,19 @@ var rectangleAnnotation = function (args, annotationName) {
     return features;
   };
 
+  /**
+   * Return this annotation as a polygon list.
+   *
+   * @param {geo.util.polyop.spec} [opts] Ignored.
+   * @returns {geo.polygonList} A list of polygons.
+   */
+  this.toPolygonList = function (opts) {
+    if (m_this._coordinates().length < 3) {
+      return [];
+    }
+    return [[m_this._coordinates().map((pt) => [pt.x, pt.y])]];
+  };
+
   /**
    * Get and optionally set coordinates associated with this annotation in the
    * map gcs coordinate system.
@@ -395,6 +386,34 @@ var rectangleAnnotation = function (args, annotationName) {
 };
 inherit(rectangleAnnotation, annotation);
 
+/**
+ * This object contains the default options to initialize the class.
+ */
+rectangleAnnotation.defaults = $.extend({}, annotation.defaults, {
+  style: {
+    fill: true,
+    fillColor: {r: 0, g: 1, b: 0},
+    fillOpacity: 0.25,
+    polygon: function (d) { return d.polygon; },
+    stroke: true,
+    strokeColor: {r: 0, g: 0, b: 0},
+    strokeOpacity: 1,
+    strokeWidth: 3,
+    uniformPolygon: true
+  },
+  highlightStyle: {
+    fillColor: {r: 0, g: 1, b: 1},
+    fillOpacity: 0.5,
+    strokeWidth: 5
+  },
+  createStyle: {
+    fillColor: {r: 0.3, g: 0.3, b: 0.3},
+    fillOpacity: 0.25,
+    strokeColor: {r: 0, g: 0, b: 1}
+  },
+  allowBooleanOperations: true
+});
+
 var rectangleRequiredFeatures = {};
 rectangleRequiredFeatures[polygonFeature.capabilities.feature] = true;
 registerAnnotation('rectangle', rectangleAnnotation, rectangleRequiredFeatures);

package/src/annotation/squareAnnotation.js

@@ -19,13 +19,20 @@ const rectangleAnnotation = require('./rectangleAnnotation');
  */
 var squareAnnotation = function (args, annotationName) {
   'use strict';
-  args = $.extend({}, args, {constraint: 1});
   if (!(this instanceof squareAnnotation)) {
     return new squareAnnotation(args, annotationName);
   }
+  args = $.extend(true, {}, this.constructor.defaults, args, {constraint: 1});
   rectangleAnnotation.call(this, args, annotationName || 'square');
 };
 inherit(squareAnnotation, rectangleAnnotation);
+
+/**
+ * This object contains the default options to initialize the class.
+ */
+squareAnnotation.defaults = $.extend({}, rectangleAnnotation.defaults, {
+});
+
 var squareRequiredFeatures = {};
 squareRequiredFeatures[polygonFeature.capabilities.feature] = true;
 registerAnnotation('square', squareAnnotation, squareRequiredFeatures);