geojs 1.6.2 → 1.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geojs",
-  "version": "1.6.2",
+  "version": "1.6.6",
   "description": "JavaScript Geo Visualization and Analysis Library",
   "homepage": "https://github.com/OpenGeoscience/geojs",
   "license": "Apache-2.0",
@@ -27,7 +27,7 @@
   "optionalDependencies": {
     "d3": "^3.5.17",
     "hammerjs": "^2.0.8",
-    "vtk.js": "^21.6.1"
+    "vtk.js": "*"
   },
   "devDependencies": {
     "@babel/core": "^7.16.5",
@@ -54,7 +54,6 @@
     "glob": "^7.2.0",
     "glslang-validator-prebuilt": "0.0.6",
     "imports-loader": "^3.1.1",
-    "istanbul-combine": "^0.3.0",
     "jaguarjs-jsdoc": "^1.0.2",
     "jasmine-core": "^4.0.0",
     "js-yaml": "^4.1.0",
@@ -62,7 +61,7 @@
     "jsdoc-autoprivate": "0.0.1",
     "jsonlint-mod": "^1.7.6",
     "jstransformer-markdown-it": "^2.0.0",
-    "karma": "^6.3.11",
+    "karma": "^6.3.13",
     "karma-chrome-launcher": "^3.1.0",
     "karma-coverage": "^2.1.0",
     "karma-firefox-launcher": "^2.1.2",
@@ -82,15 +81,15 @@
     "semantic-release": "^19.0.2",
     "serve-index": "^1.9.1",
     "shader-loader": "^1.3.1",
-    "sinon": "^12.0.1",
+    "sinon": "^13.0.1",
     "string-replace-webpack-plugin": "^0.1.3",
     "style-loader": "^3.3.1",
     "stylus": "^0.56.0",
     "stylus-loader": "^6.2.0",
-    "terser-webpack-plugin": "^5.3.0",
+    "terser-webpack-plugin": "^5.3.1",
     "touch-emulator": "^1.0.0",
     "typeface-lato": "^1.1.13",
-    "webpack": "^5.66.0",
+    "webpack": "^5.68.0",
     "webpack-cli": "^4.9.1",
     "webpack-merge": "^5.8.0"
   },
@@ -147,16 +146,15 @@
     "ci": "npm run ci-build && npm run ci-test",
     "ci-build": "bash -c '(webpack --config webpack.config.js & webpack --config webpack-lean.config.js & npm run docs & npm run get-data-files & npm run lint & npm run puglint & npm run glsllint & npm run build-examples & npm run build-tutorials & wait -n && wait -n && wait -n && wait -n && wait -n && wait -n && wait -n && wait -n && wait -n)'",
     "ci-build-wait": "bash -c '(webpack --config webpack.config.js & webpack --config webpack-lean.config.js & npm run docs & npm run get-data-files & npm run lint & npm run puglint & npm run glsllint & npm run build-examples & npm run build-tutorials & wait -n && wait -n && wait -n && wait -n && wait -n && wait -n && wait -n && wait -n && wait -n && FAIL=0 || FAIL=1; wait; [ \"$FAIL\" == \"0\" ])'",
-    "ci-test": "npm run test-headless && npm run test-webglheadless && npm run test-headed && npm run test-tutorials && npm run combine-coverage",
+    "ci-test": "npm run test-headless && npm run test-webglheadless && npm run test-headed && npm run test-tutorials",
     "ci-xvfb": "npm run ci-clean && npm run ci-build && TEST_SAVE_IMAGE='all' xvfb-run -s '-ac -screen 0 1280x1024x24' npm run ci-test",
     "start": "karma start karma.conf.js",
-    "combine-coverage": "istanbul-combine -d dist/cobertura -r cobertura 'dist/coverage/json/**/coverage-final.json'",
     "examples": "node examples/build.js && webpack --config webpack-examples.config.js && node tutorials/build.js && webpack --config webpack-tutorials.config.js && node ./tests/runners/server.js --host \"${HOST-}\" --port ${PORT-8082} --dist",
     "docs": "jsdoc --pedantic -d dist/apidocs -r src package.json -c jsdoc.conf.json",
     "website": "cd website && npx hexo server",
     "setup-website": "cd website && npm install",
     "build-website": "npm run ci-build && npm run ci-build-website",
-    "ci-build-website": "cp -a dist/built/. website/source/built && bash -c '(npm run build-website-examples & npm run build-website-tutorials & wait -n && wait -n)' && cd dist && find data \\( -name tiles -o -name base-images -o -name '*-hash-stamp' -o -name '*.tgz' \\) -prune -o \\( -print0 \\) | cpio -pmdL0 ../website/source && cp -ar apidocs/. ../website/source/apidocs && cd ../website && npm install && rm -f db.json && npx hexo generate",
+    "ci-build-website": "cp -a dist/built/. website/source/built && bash -c '(npm run build-website-examples & npm run build-website-tutorials & wait -n && wait -n)' && cd dist && cp -ar data ../website/source/. && rm -rf ../website/source/data/tiles && rm -rf ../website/source/data/tiles.tgz && rm -rf ../website/source/data/base-images && rm -rf ../website/source/data/base-images.tgz && cp -ar apidocs/. ../website/source/apidocs && cd ../website && npm install && rm -f db.json && npx hexo generate",
     "prepublishOnly": "webpack --config webpack.config.js && webpack --config webpack-lean.config.js && cp dist/built/*.js .",
     "semantic-release": "semantic-release"
   },

package/src/annotation.js

@@ -145,7 +145,7 @@ var annotation = function (type, args) {
   /**
    * Get or set the name of this annotation.
    *
-   * @param {string|undefined} arg If `undefined`, return the name, otherwise
+   * @param {string|undefined} [arg] If `undefined`, return the name, otherwise
    *    change it.  When setting the name, the value is trimmed of
    *    whitespace.  The name will not be changed to an empty string.
    * @returns {this|string} The current name or this annotation.
@@ -293,7 +293,7 @@ var annotation = function (type, args) {
   /**
    * Get or set the state of this annotation.
    *
-   * @param {string|undefined} arg If `undefined`, return the state,
+   * @param {string|undefined} [arg] If `undefined`, return the state,
    *    otherwise change it.  This should be one of the
    *    {@link geo.annotation.state} values.
    * @returns {this|string} The current state or this annotation.
@@ -352,7 +352,7 @@ var annotation = function (type, args) {
    *    `'remove'` if the annotation should be removed, falsy to not update
    *    anything.
    */
-  this.processAction = function () {
+  this.processAction = function (evt) {
     return undefined;
   };
 
@@ -1081,8 +1081,8 @@ var annotation = function (type, args) {
  *
  * @param {object} m_this The current annotation instance.
  * @param {function} s_actions The parent actions method.
- * @param {string} [state] The state to return actions for.  Defaults to
- *    the current state.
+ * @param {string|undefined} state The state to return actions for.  Defaults
+ *    to the current state.
  * @param {string} name The name of this annotation.
  * @param {Array} originalArgs arguments to original call
  * @returns {geo.actionRecord[]} A list of actions.
@@ -1128,7 +1128,7 @@ function continuousVerticesProcessAction(m_this, evt, name) {
     return;
   }
   var cpp = layer.options('continuousPointProximity');
-  var cpc = layer.options('continuousPointColinearity');
+  var cpc = layer.options('continuousPointCollinearity');
   var ccp = layer.options('continuousCloseProximity');
   if (cpp || cpp === 0) {
     var vertices = m_this.options('vertices');
@@ -1140,7 +1140,7 @@ function continuousVerticesProcessAction(m_this, evt, name) {
     }
     var dist = layer.displayDistance(vertices[vertices.length - 2], null, evt.mouse.map, 'display');
     if (dist && dist > cpp) {
-      // combine nearly colinear points
+      // combine nearly collinear points
       if (vertices.length >= (m_this._lastClickVertexCount || 1) + 3) {
         var d01 = layer.displayDistance(vertices[vertices.length - 3], null, vertices[vertices.length - 2], null),
             d12 = dist,
@@ -1183,6 +1183,10 @@ function continuousVerticesProcessAction(m_this, evt, name) {
  * @property {geo.polygonFeature.styleSpec} [editStyle] The style to apply to a
  *    rectangle in edit mode.
  */
+/*
+ * @typedef {object} geo.rectangleAnnotation.subspec
+ * @typedef {geo.annotation.spec | geo.rectangleAnnotation.subspec} geo.rectangleAnnotation.spec
+ */
 
 /**
  * Rectangle annotation class.

package/src/annotationLayer.js

@@ -21,9 +21,9 @@ var textFeature = require('./textFeature');
  * @property {number} [continuousPointProximity=5] The minimum distance in
  *   display coordinates (pixels) between two adjacent points when dragging
  *   to create an annotation.  `false` disables continuous drawing mode.
- * @property {number} [continuousPointColinearity=1.0deg] The minimum angle
+ * @property {number} [continuousPointCollinearity=1.0deg] The minimum angle
  *   between a series of three points when dragging to not interpret them as
- *   colinear.  Only applies if `continuousPointProximity` is not `false`.
+ *   collinear.  Only applies if `continuousPointProximity` is not `false`.
  * @property {number} [continuousCloseProximity=10] The minimum distance in
  *   display coordinates (pixels) to close a polygon or end drawing a line when
  *   dragging to create an annotation.  `false` never closes at the end of a
@@ -135,8 +135,8 @@ var annotationLayer = function (arg) {
     // continuous drawing modes.
     continuousPointProximity: 5,
     // in radians, minimum angle between continuous points to interpret them as
-    // being coliner
-    continuousPointColinearity: 1.0 * Math.PI / 180,
+    // being collinear
+    continuousPointCollinearity: 1.0 * Math.PI / 180,
     continuousCloseProximity: 10, // in pixels, 0 is exact
     finalPointProximity: 10,  // in pixels, 0 is exact
     showLabels: true,
@@ -399,11 +399,13 @@ var annotationLayer = function (arg) {
    * @param {geo.annotation} annotation The annotation to add.
    * @param {string|geo.transform|null} [gcs] `undefined` to use the interface
    *    gcs, `null` to use the map gcs, or any other transform.
+   * @param {boolean} [update] If `false`, don't update the layer after adding
+   *    the annotation.
    * @returns {this} The current layer.
    * @fires geo.event.annotation.add_before
    * @fires geo.event.annotation.add
    */
-  this.addAnnotation = function (annotation, gcs) {
+  this.addAnnotation = function (annotation, gcs, update) {
     var pos = $.inArray(annotation, m_annotations);
     if (pos < 0) {
       m_this.geoTrigger(geo_event.annotation.add_before, {
@@ -418,8 +420,10 @@ var annotationLayer = function (arg) {
         annotation._coordinates(transform.transformCoordinates(
           gcs, map.gcs(), annotation._coordinates()));
       }
-      m_this.modified();
-      m_this.draw();
+      if (update !== false) {
+        m_this.modified();
+        m_this.draw();
+      }
       m_this.geoTrigger(geo_event.annotation.add, {
         annotation: annotation
       });
@@ -431,7 +435,7 @@ var annotationLayer = function (arg) {
    * Remove an annotation from the layer.
    *
    * @param {geo.annotation} annotation The annotation to remove.
-   * @param {boolean} update If `false`, don't update the layer after removing
+   * @param {boolean} [update] If `false`, don't update the layer after removing
    *    the annotation.
    * @returns {boolean} `true` if an annotation was removed.
    * @fires geo.event.annotation.remove
@@ -603,7 +607,7 @@ var annotationLayer = function (arg) {
    * Return the current set of annotations as a geojson object.  Alternately,
    * add a set of annotations from a geojson object.
    *
-   * @param {string|objectFile} [geojson] If present, add annotations based on
+   * @param {string|object|File} [geojson] If present, add annotations based on
    *    the given geojson object.  If `undefined`, return the current
    *    annotations as geojson.  This may be a JSON string, a javascript
    *    object, or a File object.

package/src/camera.js

@@ -502,7 +502,7 @@ var camera = function (spec) {
    * Project a vector from world space into viewport (display) space.  The
    * resulting vector always has the last component (`w`) equal to 1.
    *
-   * @param {vec2|vec3|vec4} point The point in world coordinates.
+   * @param {vec3|vec4} point The point in world coordinates.
    * @returns {vec4} The point in display coordinates.
    */
   this.worldToDisplay4 = function (point) {
@@ -518,7 +518,7 @@ var camera = function (spec) {
    * Project a vector from viewport (display) space into world space.  The
    * resulting vector always has the last component (`w`) equal to 1.
    *
-   * @param {vec2|vec3|vec4} point The point in display coordinates.
+   * @param {vec3|vec4} point The point in display coordinates.
    * @returns {vec4} The point in world space coordinates.
    */
   this.displayToWorld4 = function (point) {
@@ -788,7 +788,7 @@ var camera = function (spec) {
   /**
    * Represent a glmatrix as a pretty-printed string.
    * @param {mat4} mat A 4 x 4 matrix.
-   * @param {number} prec The number of decimal places.
+   * @param {number} [prec] The number of decimal places.
    * @returns {string}
    */
   this.ppMatrix = function (mat, prec) {
@@ -862,7 +862,7 @@ var camera = function (spec) {
 
 /**
  * Supported projection types.
- * @enum
+ * @enum {boolean}
  */
 camera.projection = {
   perspective: true,
@@ -872,7 +872,7 @@ camera.projection = {
 /**
  * Default camera clipping bounds.  Some features and renderers may rely on the
  * far clip value being more positive than the near clip value.
- * @enum
+ * @enum {number}
  */
 camera.clipbounds = {
   perspective: {

package/src/canvas/pixelmapFeature.js

@@ -1,6 +1,8 @@
 var inherit = require('../inherit');
 var registerFeature = require('../registry').registerFeature;
 var pixelmapFeature = require('../pixelmapFeature');
+var geo_event = require('../event');
+var util = require('../util');
 
 /**
  * Create a new instance of class pixelmapFeature.
@@ -22,6 +24,191 @@ var canvas_pixelmapFeature = function (arg) {
   var object = require('./object');
   object.call(this);
 
+  var m_quadFeature,
+      s_exit = this._exit,
+      m_this = this;
+
+  /**
+   * If the specified coordinates are in the rendered quad, use the basis
+   * information from the quad to determine the pixelmap index value so that it
+   * can be included in the `found` results.
+   *
+   * @param {geo.geoPosition} geo Coordinate.
+   * @param {string|geo.transform|null} [gcs] Input gcs.  `undefined` to use
+   *    the interface gcs, `null` to use the map gcs, or any other transform.
+   * @returns {geo.feature.searchResult} An object with a list of features and
+   *    feature indices that are located at the specified point.
+   */
+  this.pointSearch = function (geo, gcs) {
+    if (m_quadFeature && m_this.m_info) {
+      var result = m_quadFeature.pointSearch(geo, gcs);
+      if (result.index.length === 1 && result.extra && result.extra[result.index[0]].basis) {
+        var basis = result.extra[result.index[0]].basis, x, y, idx;
+        x = Math.floor(basis.x * m_this.m_info.width);
+        y = Math.floor(basis.y * m_this.m_info.height);
+        if (x >= 0 && x < m_this.m_info.width &&
+            y >= 0 && y < m_this.m_info.height) {
+          idx = m_this.m_info.indices[y * m_this.m_info.width + x];
+          result = {
+            index: [idx],
+            found: [m_this.data()[idx]]
+          };
+          return result;
+        }
+      }
+    }
+    return {index: [], found: []};
+  };
+
+  /**
+   * Compute information for this pixelmap image.  It is wasteful to call this
+   * if the pixelmap has already been prepared (it is invalidated by a change
+   * in the image).
+   *
+   * @returns {geo.pixelmapFeature.info}
+   */
+  this._preparePixelmap = function () {
+    var i, idx, pixelData;
+
+    if (!util.isReadyImage(m_this.m_srcImage)) {
+      return;
+    }
+    m_this.m_info = {
+      width: m_this.m_srcImage.naturalWidth,
+      height: m_this.m_srcImage.naturalHeight,
+      canvas: document.createElement('canvas')
+    };
+
+    m_this.m_info.canvas.width = m_this.m_info.width;
+    m_this.m_info.canvas.height = m_this.m_info.height;
+    m_this.m_info.context = m_this.m_info.canvas.getContext('2d');
+
+    m_this.m_info.context.drawImage(m_this.m_srcImage, 0, 0);
+    m_this.m_info.imageData = m_this.m_info.context.getImageData(
+      0, 0, m_this.m_info.canvas.width, m_this.m_info.canvas.height);
+    pixelData = m_this.m_info.imageData.data;
+    m_this.m_info.indices = new Array(pixelData.length / 4);
+    m_this.m_info.area = pixelData.length / 4;
+
+    m_this.m_info.mappedColors = {};
+    for (i = 0; i < pixelData.length; i += 4) {
+      idx = pixelData[i] + (pixelData[i + 1] << 8) + (pixelData[i + 2] << 16);
+      m_this.m_info.indices[i / 4] = idx;
+      if (!m_this.m_info.mappedColors[idx]) {
+        m_this.m_info.mappedColors[idx] = {first: i / 4};
+      }
+      m_this.m_info.mappedColors[idx].last = i / 4;
+    }
+    return m_this.m_info;
+  };
+
+  /**
+   * Given the loaded pixelmap image, create a canvas the size of the image.
+   * Compute a color for each distinct index and recolor the canvas based on
+   * these colors, then draw the resultant image as a quad.
+   *
+   * @fires geo.event.pixelmap.prepared
+   */
+  this._computePixelmap = function () {
+    var data = m_this.data() || [],
+        colorFunc = m_this.style.get('color'),
+        i, idx, lastidx, color, pixelData, indices, mappedColors,
+        updateFirst, updateLast = -1, update, prepared;
+
+    if (!m_this.m_info) {
+      if (!m_this._preparePixelmap()) {
+        return;
+      }
+      prepared = true;
+    }
+    mappedColors = m_this.m_info.mappedColors;
+    updateFirst = m_this.m_info.area;
+    for (idx in mappedColors) {
+      if (mappedColors.hasOwnProperty(idx)) {
+        color = colorFunc(data[idx], +idx) || {};
+        color = [
+          (color.r || 0) * 255,
+          (color.g || 0) * 255,
+          (color.b || 0) * 255,
+          color.a === undefined ? 255 : (color.a * 255)
+        ];
+        mappedColors[idx].update = (
+          !mappedColors[idx].color ||
+          mappedColors[idx].color[0] !== color[0] ||
+          mappedColors[idx].color[1] !== color[1] ||
+          mappedColors[idx].color[2] !== color[2] ||
+          mappedColors[idx].color[3] !== color[3]);
+        if (mappedColors[idx].update) {
+          mappedColors[idx].color = color;
+          updateFirst = Math.min(mappedColors[idx].first, updateFirst);
+          updateLast = Math.max(mappedColors[idx].last, updateLast);
+        }
+      }
+    }
+    /* If nothing was updated, we are done */
+    if (updateFirst >= updateLast) {
+      return;
+    }
+    /* Update only the extent that has changed */
+    pixelData = m_this.m_info.imageData.data;
+    indices = m_this.m_info.indices;
+    for (i = updateFirst; i <= updateLast; i += 1) {
+      idx = indices[i];
+      if (idx !== lastidx) {
+        lastidx = idx;
+        color = mappedColors[idx].color;
+        update = mappedColors[idx].update;
+      }
+      if (update) {
+        pixelData[i * 4] = color[0];
+        pixelData[i * 4 + 1] = color[1];
+        pixelData[i * 4 + 2] = color[2];
+        pixelData[i * 4 + 3] = color[3];
+      }
+    }
+    /* Place the updated area into the canvas */
+    m_this.m_info.context.putImageData(
+      m_this.m_info.imageData, 0, 0, 0, Math.floor(updateFirst / m_this.m_info.width),
+      m_this.m_info.width, Math.ceil((updateLast + 1) / m_this.m_info.width));
+
+    /* If we haven't made a quad feature, make one now.  The quad feature needs
+     * to have the canvas capability. */
+    if (!m_quadFeature) {
+      m_quadFeature = m_this.layer().createFeature('quad', {
+        selectionAPI: false,
+        gcs: m_this.gcs(),
+        visible: m_this.visible(undefined, true)
+      });
+      m_this.dependentFeatures([m_quadFeature]);
+      m_quadFeature.style({
+        image: m_this.m_info.canvas,
+        position: m_this.style.get('position')})
+      .data([{}])
+      .draw();
+    }
+    /* If we prepared the pixelmap and rendered it, send a prepared event */
+    if (prepared) {
+      m_this.geoTrigger(geo_event.pixelmap.prepared, {
+        pixelmap: m_this
+      });
+    }
+  };
+
+  /**
+   * Destroy.  Deletes the associated quadFeature.
+   *
+   * @returns {this}
+   */
+  this._exit = function () {
+    if (m_quadFeature && m_this.layer()) {
+      m_this.layer().deleteFeature(m_quadFeature);
+      m_quadFeature = null;
+      m_this.dependentFeatures([]);
+    }
+    s_exit();
+    return m_this;
+  };
+
   this._init(arg);
   return this;
 };

package/src/choroplethFeature.js

@@ -185,7 +185,7 @@ var choroplethFeature = function (arg) {
   /**
    * Add a geojson polygon feature to the current layer.
    *
-   * @param {geojsonFeature} feature A geojson parsed feature.
+   * @param {geo.geojsonFeature} feature A geojson parsed feature.
    * @param {geo.geoColor} fillColor The fill color for the feature.
    * @returns {geo.polygonFeature}
    */

package/src/domRenderer.js

@@ -38,9 +38,10 @@ var domRenderer = function (arg) {
   /**
    * Initialize.
    *
+   * @param {object} [arg] Optional arguments.
    * @returns {this}
    */
-  this._init = function () {
+  this._init = function (arg) {
     var layer = m_this.layer().node();
 
     if (!m_this.canvas() && layer && layer.length) {

package/src/featureLayer.js

@@ -109,7 +109,7 @@ var featureLayer = function (arg) {
   /**
    * Get/Set drawables.
    *
-   * @param {geo.feature[]} val A list of features, or unspecified to return
+   * @param {geo.feature[]} [val] A list of features, or unspecified to return
    *    the current feature list.  If a list is provided, features are added or
    *    removed as needed.
    * @returns {geo.feature[]|this} The current features associated with the

package/src/fileReader.js

@@ -6,7 +6,7 @@ var object = require('./object');
  * Object specification for a fileReader.
  *
  * @typedef {object} geo.fileReader.spec
- * @property {geo.featureLayer} layer The target feature layer.
+ * @property {geo.featureLayer} [layer] The target feature layer.
  */
 
 /**
@@ -15,7 +15,7 @@ var object = require('./object');
  * @class
  * @alias geo.fileReader
  * @extends geo.object
- * @param {geo.fileReader.spec} arg
+ * @param {geo.fileReader.spec} [arg]
  * @returns {geo.fileReader}
  */
 var fileReader = function (arg) {

package/src/imageTile.js

@@ -11,7 +11,8 @@ var tile = require('./tile');
  * @property {object} [size] The size of each tile.
  * @property {number} [size.x=256] Width in pixels.
  * @property {number} [size.y=256] Height in pixels.
- * @property {string} [crossDomain='anonymous'] Image CORS attribute.
+ * @property {string} [crossDomain='anonymous'] Image CORS attribute.  This is
+ *   used for the `crossorigin` property when loading images.
  */
 
 /**

package/src/isolineFeature.js

@@ -657,7 +657,7 @@ var isolineFeature = function (arg) {
    * the generated labels.  The viewport calculation is conservative, as the
    * map could be rotated, changed size, or have other modifications.
    *
-   * @returns {exit}
+   * @returns {this}
    */
   this._updateLabelPositions = function () {
     var last = m_lastLabelPositions;

package/src/layer.js

@@ -291,7 +291,7 @@ var layer = function (arg) {
   /**
    * Get root node of the layer.
    *
-   * @returns {div}
+   * @returns {HTMLDivElement}
    */
   this.node = function () {
     return m_node;
@@ -579,9 +579,11 @@ var layer = function (arg) {
    * Update layer.
    *
    * This is a stub that should be subclassed.
+   *
+   * @param {object} [arg] An object, possibly with an ``event`` key and value.
    * @returns {this}
    */
-  this._update = function () {
+  this._update = function (arg) {
     return m_this;
   };
 

package/src/lineFeature.js

@@ -396,9 +396,9 @@ var lineFeature = function (arg) {
    *
    * @param {array} data A new data array.
    * @param {number} [tolerance] The maximum variation allowed in map.gcs
-   *    units.  A value of zero will only remove perfectly colinear points.  If
-   *    not specified, this is set to a half display pixel at the map's current
-   *    zoom level.
+   *    units.  A value of zero will only remove perfectly collinear points.
+   *    If not specified, this is set to a half display pixel at the map's
+   *    current zoom level.
    * @param {function} [posFunc=this.style.get('position')] The function to
    *    get the position of each vertex.
    * @param {function} [lineFunc=this.style.get('line')] The function to get

package/src/map.js

@@ -517,7 +517,7 @@ var map = function (arg) {
    * view center.  Rotation mostly ignores `clampBoundsX`, as the behavior
    * feels peculiar otherwise.
    *
-   * @param {number} rotation Absolute angle in radians (positive is
+   * @param {number} [rotation] Absolute angle in radians (positive is
    *    clockwise).
    * @param {object} [origin] If specified, rotate about this origin.
    * @param {geo.geoPosition} origin.geo The gcs coordinates of the
@@ -830,7 +830,7 @@ var map = function (arg) {
    *    coordinate to convert.
    * @param {string|geo.transform|null} [gcs] Output gcs.  `undefined` to use
    *    the interface gcs, `null` to use the map gcs, or any other transform.
-   * @returns {geo.geoPosition|geoPosition[]} GCS space coordinates.
+   * @returns {geo.geoPosition|geo.geoPosition[]} GCS space coordinates.
    */
   this.displayToGcs = function (c, gcs) {
     c = m_this.displayToWorld(c); // done via camera
@@ -954,9 +954,10 @@ var map = function (arg) {
   /**
    * Initialize the map.
    *
+   * @param {object} [arg] Optional arguments.
    * @returns {this} The map object.
    */
-  this._init = function () {
+  this._init = function (arg) {
 
     if (m_node === undefined || m_node === null) {
       throw new Error('Map require DIV node');
@@ -1296,7 +1297,7 @@ var map = function (arg) {
           y: p[1]
         }, null, true, true);
       } else {
-        m_center = m_this.gcsToWorld({x: p[0], y: p[1]}, null, true, true);
+        m_center = m_this.gcsToWorld({x: p[0], y: p[1]}, null);
         m_this.zoom(p[2], m_transition.zoomOrigin, true);
       }
       m_this.rotation(p[3], undefined, true);
@@ -1494,7 +1495,7 @@ var map = function (arg) {
    * @param {number} rotation The requested rotation in clockwise radians.
    * @param {string|geo.transform|null} [gcs] `undefined` to use the interface
    *    gcs, `null` to use the map gcs, or any other transform.
-   * @param {boolean} ignoreDiscreteZoom If `true`, ignore the `discreteZoom`
+   * @param {boolean} [ignoreDiscreteZoom] If `true`, ignore the `discreteZoom`
    *    option when determining the new view.
    * @param {boolean} [ignoreClampBounds] If `true` and `clampBoundsX` or
    *    `clampBoundsY` is set, allow the bounds to be less clamped.
@@ -1728,11 +1729,11 @@ var map = function (arg) {
    * @param {boolean|null} [opts.attribution=null] If `null` or unspecified,
    *    include the attribution only if all layers are used.  If false, never
    *    include the attribution.  If `true`, always include it.
-   * @param {HTMLObject[]|string[]} [opts.html] A list of additional HTML
+   * @param {HTMLElement[]|string[]} [opts.html] A list of additional HTML
    *    elements, selectors, or jQuery elements to render on top of the map.
    *    These are rendered in order, with the last one topmost.
-   * @returns {deferred} A jQuery Deferred object.  The done function receives
-   *    either a data URL or an `HTMLCanvasElement` with the result.
+   * @returns {jQueryDeferred} A jQuery Deferred object.  The done function
+   *    receives either a data URL or an `HTMLCanvasElement` with the result.
    * @fires geo.event.screenshot.ready
    */
   this.screenshot = function (layers, type, encoderOptions, opts) {
@@ -1916,7 +1917,7 @@ var map = function (arg) {
   /**
    * Return the nearest valid zoom level to the requested zoom.
    * @param {number} zoom A zoom level to adjust to current settings
-   * @param {boolean} ignoreDiscreteZoom If `true`, ignore the `discreteZoom`
+   * @param {boolean} [ignoreDiscreteZoom] If `true`, ignore the `discreteZoom`
    *    option when determining the new view.
    * @returns {number} The zoom level clamped to the allowed zoom range and
    *    with other settings applied.
@@ -1960,10 +1961,11 @@ var map = function (arg) {
    * Draw a layer image to a canvas context.  The layer's opacity and transform
    * are applied.  This is used as part of making a screenshot.
    *
-   * @param {context} context The 2d canvas context to draw into.
+   * @param {CanvasRenderingContext2D} context The 2d canvas context to draw
+   *    into.
    * @param {number} opacity The opacity in the range [0, 1].
    * @param {object} elem A jQuery element that might have a transform.
-   * @param {HTMLImageObject} img The image or canvas to draw to the canvas.
+   * @param {HTMLImageElement} img The image or canvas to draw to the canvas.
    * @param {string} [mixBlendMode] the mix-blend-mode used to add this layer.
    * @private
    */
@@ -2155,12 +2157,12 @@ var map = function (arg) {
    * Return a valid rotation angle.
    *
    * @param {number} rotation Proposed rotation.
-   * @param {boolean} ignoreRotationFunc If truthy and rotations are allowed,
+   * @param {boolean} [ignoreRotationFunc] If truthy and rotations are allowed,
    *    allow any rotation.  Otherwise, the rotation is passed through the
    *    `allowRotation` function.
-   * @param {boolean} noRangeLimit If falsy, ensure that the rotation is in the
-   *    range [0, 2*PI).  If it is very close to zero, it is snapped to zero.
-   *    If true, the rotation can have any value.
+   * @param {boolean} [noRangeLimit] If falsy, ensure that the rotation is in
+   *    the range [0, 2*PI).  If it is very close to zero, it is snapped to
+   *    zero.  If true, the rotation can have any value.
    * @returns {number} the validated rotation
    * @private
    */