geojs 1.6.3 → 1.6.4

package/src/trackFeature.js

@@ -10,24 +10,24 @@ var util = require('./util');
  * @extends geo.feature.spec
  * @property {geo.geoPosition|function} [position] Position of the data.
  *   Default is (data).
- * @property {float|function} [time] Time of the data.  Default is `(data).t`.
+ * @property {number|function} [time] Time of the data.  Default is `(data).t`.
  * @property {object|function} [track] Tracks from the data.  Default is
  *   (data).  Typically, the data is an array of tracks, each of which is an
  *   array of points, each of which has a position and time.  The position and
  *   time functions are called for each point as `position(trackPoint,
  *   pointIndex, trackEntry, trackEntryIndex)`.
- * @property {float|null} [startTime=null] Start time.  Used for styling.  If
+ * @property {number|null} [startTime=null] Start time.  Used for styling.  If
  *   `null`, this is the duration before the end time if `duration` is not
  *  `null` and the minimum time in any track if `duration` is `null`.
- * @property {float} [endTime=null] End time.  Used for styling and position of
- *   the track head.  If `null` and either of `startTime` or `duration` are
+ * @property {number} [endTime=null] End time.  Used for styling and position
+ *   of the track head.  If `null` and either of `startTime` or `duration` are
  *   `null`, this is the maximum time in any track.
- * @property {float} [duration=null] Duration between start and end times.
+ * @property {number} [duration=null] Duration between start and end times.
  *   Ignored if both start and end times are specified.
- * @property {float|function} [text] Text to use for the head of the track.  If
- *   specified, the track head is rendered as text.  If `undefined` a marker is
- *   used instead.  If `null` or an empty string (`''`), neither a marker nor
- *   text is used.
+ * @property {number|function} [text] Text to use for the head of the track.
+ *   If specified, the track head is rendered as text.  If `undefined` a marker
+ *   is used instead.  If `null` or an empty string (`''`), neither a marker
+ *   nor text is used.
  * @property {geo.trackFeature.styleSpec} [style] Style object with default
  *   style options.
  * @property {geo.lineFeature.styleSpec} [pastStyle] Style object with
@@ -168,7 +168,7 @@ var trackFeature = function (arg) {
    * Calculate an interpolated position given a time.  If the time is outside
    * the range of a track, the first or last point is returned.
    *
-   * @param {float} time The time to compute a position array for.
+   * @param {number} time The time to compute a position array for.
    * @param {string|geo.transform|null} [gcs] `undefined` to use the feature
    *    gcs, `null` to use the map gcs, or any other transform.  This transform
    *    is used for the interpolation; the results are still in feature gcs.
@@ -275,8 +275,8 @@ var trackFeature = function (arg) {
     m_tracks.textFunc = m_this.style.get('text');
     ['past', 'current', 'future'].forEach(key => {
       m_lineFeatures[key]
-        .style(m_this[key + 'Style']())
         .style(m_this.style())
+        .style(m_this[key + 'Style']())
         .line(m_this.style('track'))
         .gcs(m_this.gcs())
         .data(data)
@@ -571,11 +571,11 @@ var trackFeature = function (arg) {
   /**
    * Get/Set time accessor.
    *
-   * @param {float} [val] If not specified, return the current time accessor.
+   * @param {number} [val] If not specified, return the current time accessor.
    *    If specified, use this for the time accessor and return `this`.  If a
    *    function is given, this is called with `(vertexElement, vertexIndex,
    *    dataElement, dataIndex)`.
-   * @returns {float|function|this} The current time or this feature.
+   * @returns {number|function|this} The current time or this feature.
    */
   this.time = function (val) {
     if (val === undefined) {
@@ -636,8 +636,8 @@ var trackFeature = function (arg) {
   /**
    * Get or set the start time.
    *
-   * @param {float|null} [val] If specified, the new start time.
-   * @returns {float|null|this} If set, the instance.  Otherwise, the current
+   * @param {number|null} [val] If specified, the new start time.
+   * @returns {number|null|this} If set, the instance.  Otherwise, the current
    *    start time value.
    */
   this.startTime = function (val) {
@@ -654,8 +654,8 @@ var trackFeature = function (arg) {
   /**
    * Get or set the end time.
    *
-   * @param {float|null} [val] If specified, the new end time.
-   * @returns {float|null|this} If set, the instance.  Otherwise, the current
+   * @param {number|null} [val] If specified, the new end time.
+   * @returns {number|null|this} If set, the instance.  Otherwise, the current
    *    end time value.
    */
   this.endTime = function (val) {
@@ -672,8 +672,8 @@ var trackFeature = function (arg) {
   /**
    * Get or set the duration.
    *
-   * @param {float|null} [val] If specified, the new duration.
-   * @returns {float|null|this} If set, the instance.  Otherwise, the current
+   * @param {number|null} [val] If specified, the new duration.
+   * @returns {number|null|this} If set, the instance.  Otherwise, the current
    *    duration.
    */
   this.duration = function (val) {

package/src/transform.js

@@ -330,11 +330,12 @@ transform.lookup = function (projection) {
  *
  * @param {string} srcPrj The source projection.
  * @param {string} tgtPrj The destination projection.
- * @param {geoPosition|geoPosition[]|number[]} coordinates An array of
- *      coordinate objects.  These may be in object or array form, or a flat
- *      array.
- * @param {number} numberOfComponents For flat arrays, either 2 or 3.
- * @returns {geoPosition|geoPosition[]|number[]} The transformed coordinates.
+ * @param {geo.geoPosition|geo.geoPosition[]|number[]} coordinates An array of
+ *    coordinate objects.  These may be in object or array form, or a flat
+ *    array.
+ * @param {number} [numberOfComponents] For flat arrays, either 2 or 3.
+ * @returns {geo.geoPosition|geo.geoPosition[]|number[]} The transformed
+ *    coordinates.
  */
 transform.transformCoordinates = function (srcPrj, tgtPrj, coordinates, numberOfComponents) {
   'use strict';
@@ -385,10 +386,10 @@ transform.transformCoordinates = function (srcPrj, tgtPrj, coordinates, numberOf
  * components per coordinate.  The array is modified in place.
  *
  * @param {transform} trans The transformation object.
- * @param {geoPosition[]|number[]} coordinates An array of coordinate
+ * @param {geo.geoPosition[]|number[]} coordinates An array of coordinate
  *      objects or a flat array.
  * @param {number} numberOfComponents For flat arrays, either 2 or 3.
- * @returns {geoPosition[]|number[]} The transformed coordinates
+ * @returns {geo.geoPosition[]|number[]} The transformed coordinates
  */
 transform.transformCoordinatesArray = function (trans, coordinates, numberOfComponents) {
   var i, count, offset, xAcc, yAcc, zAcc, writer, output, projPoint,
@@ -654,8 +655,6 @@ transform.affineInverse = function (def, coords) {
  * @param {object} [ellipsoid=proj4.WGS84] An object with at least `a` and one
  *    of `b`, `f`, or `rf` (1 / `f`) -- this works with  proj4 ellipsoid
  *    definitions.
- * @param {number} [maxIterations=100] Maximum number of iterations to use
- *    to test convergence.
  * @returns {number} The distance in meters (or whatever units the ellipsoid
  *    was specified in.
  */

package/src/typedef.js

@@ -234,3 +234,5 @@
  *
  * @typedef {geo.polygonFlat|geo.polygonObject} geo.polygon
  */
+
+module.exports = {};

package/src/ui/sliderWidget.js

@@ -203,7 +203,7 @@ var sliderWidget = function (arg) {
      * Respond to a mouse event on the widget.
      *
      * @param {d3Event} evt The event on the widget.
-     * @param {boolean} trans Truthy for an animated transition.
+     * @param {boolean} [trans] Truthy for an animated transition.
      */
     function respond(evt, trans) {
       var z = m_yscale.invert(d3.mouse(svg.node())[1]),

package/src/util/clustering.js

@@ -18,7 +18,7 @@ var $ = require('jquery');
  *
  * @param {geo.util.ClusterGroup} group The source cluster group
  * @param {number} zoom The zoom level of the current node
- * @param {object[]} children An array of ClusterTrees or point objects
+ * @param {object[]} [children] An array of ClusterTrees or point objects
  */
 function ClusterTree(group, zoom, children) {
   this._group = group;
@@ -136,8 +136,8 @@ ClusterTree.prototype.coords = function () {
  * @class
  * @alias geo.util.ClusterGroup
  * @param {object} opts An options object
- * @param {number} maxZoom The maximum zoom level to calculate.
- * @param {number} radius Size of clustering at zoom 0 in point gcs.
+ * @param {number} [opts.maxZoom] The maximum zoom level to calculate.
+ * @param {number} [opts.radius] Size of clustering at zoom 0 in point gcs.
  */
 function C(opts) {
 

package/src/util/color.js

@@ -59,7 +59,7 @@ var colorName = require('color-name');
 /**
  * @typedef {object} geo.util.cssColorConversionRecord
  * @property {string} name The name of the color conversion.
- * @property {RegEx} regex A regex that, if it matches the color string, will
+ * @property {RegExp} regex A regex that, if it matches the color string, will
  *      cause the process function to be invoked.
  * @property {function} process A function that takes (`color`, `match`) with
  *      the original color string and the results of matching the regex using

package/src/util/common.js

@@ -128,7 +128,7 @@ var util = {
    * Check if an object an HTMLVideoElement element that is loaded.
    *
    * @param {object} vid An object that might be an HTMLVideoElement.
-   * @param {boolean} [allowFailedVideo] If `true`, an viedo element that has
+   * @param {boolean} [allowFailedVideo] If `true`, an video element that has
    *     a source and has failed to load is also considered 'ready' in the
    *     sense that it isn't expected to change to a better state.
    * @returns {boolean} `true` if this is a video that is ready.
@@ -525,7 +525,7 @@ var util = {
    * var map = geo.map($.extend(results.map, {clampZoom: false}));
    * map.createLayer('osm', results.layer);
    *
-   * @param {string} [node] DOM selector for the map container.
+   * @param {string?} node DOM selector for the map container.
    * @param {number} width Width of the whole map contents in pixels.
    * @param {number} height Height of the whole map contents in pixels.
    * @param {number} [tileWidth] If an osm or tile layer is going to be used,
@@ -967,7 +967,7 @@ var util = {
    */
   escapeUnicodeHTML: function (text) {
     return text.replace(/./g, function (k) {
-      var code = k.charCodeAt();
+      var code = k.charCodeAt(0);
       if (code < 127) {
         return k;
       }
@@ -1026,7 +1026,7 @@ var util = {
    * stored as local base64 urls.
    *
    * @param {string} css The css to parse for urls.
-   * @param {jQuery.selector|DOMElement} styleElem The element that receivs
+   * @param {jQuery.selector|HTMLElement} styleElem The element that receives
    *    the css text after dereferencing or the DOM element that has style
    *    that will be updated.
    * @param {jQuery.Deferred} styleDefer A Deferred to resolve once

package/src/util/throttle.js

@@ -43,7 +43,7 @@
  *    unspecified, callback will be executed one final time after the last
  *    throttled-function call. (After the throttled-function has not been
  *    called for `delay` milliseconds, the internal counter is reset)
- * @param {function} callback A function to be executed after `delay`
+ * @param {function} [callback] A function to be executed after `delay`
  *    milliseconds. The `this` context and all arguments are passed through,
  *    as-is, to `callback` when the throttled-function is executed.
  * @param {function} [accumulator] A function to be executed (synchronously)

package/src/webgl/markerFeature.js

@@ -98,7 +98,7 @@ var webgl_markerFeature = function (arg) {
   /**
    * Create and style the data needed to render the markers.
    *
-    @param {boolean} onlyStyle if true, use the existing geometry and just
+    @param {boolean} [onlyStyle] if true, use the existing geometry and just
    *    recalculate the style.
    */
   function createGLMarkers(onlyStyle) {

package/src/webgl/pointFeature.js

@@ -78,7 +78,7 @@ var webgl_pointFeature = function (arg) {
   /**
    * Create and style the data needed to render the points.
    *
-   * @param {boolean} onlyStyle if true, use the existing geometry and just
+   * @param {boolean} [onlyStyle] if true, use the existing geometry and just
    *    recalculate the style.
    */
   function createGLPoints(onlyStyle) {

package/src/webgl/webglRenderer.js

@@ -319,6 +319,7 @@ webglRenderer.supported = function () {
     var canvas, ctx, exts; // eslint-disable-line no-unused-vars
     try {
       canvas = document.createElement('canvas');
+      /** @type {WebGLRenderingContext} */
       ctx = (canvas.getContext('webgl') ||
              canvas.getContext('experimental-webgl'));
       /* getSupportExtensions will throw an exception if the context isn't