Allow custom geoJson description function

.gitignore

@@ -1,3 +1,4 @@
+/wwwroot
 /.metadata
 /Build
 /Instrumented

.npmignore

@@ -0,0 +1,22 @@
+/.metadata
+/Apps
+/Build
+/Documentation
+/Instrumented
+/Specs
+/Tools
+/launches
+/Cesium-*.zip
+.DS_Store
+Thumbs.db
+
+/Apps/CesiumViewer/Gallery/gallery-index.js
+
+/Apps/Sandcastle/jsHintOptions.js
+/Apps/Sandcastle/gallery/gallery-index.js
+
+/Source/Cesium.js
+
+/Specs/SpecList.js
+
+/node_modules

CHANGES.md

@@ -1,6 +1,10 @@
 Change Log
 ==========
 
+### 1.16 - 2015-12-01
+
+* `GeoJsonDataSource.load` now takes an optional `describeProperty` function for generating feature description properties. [#3140](https://github.com/AnalyticalGraphicsInc/cesium/pull/3140)
+
 ### 1.15 - 2015-11-02
 
 * Breaking changes

CONTRIBUTORS.md

@@ -32,6 +32,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Cesiu
    * [Kevin Ring](https://github.com/kring)
    * [Keith Grochow](https://github.com/kgrochow)
    * [Chloe Chen](https://github.com/chloeleichen)
+   * [Arthur Street](https://github.com/RacingTadpole)
 * [EU Edge](http://euedge.com/)
    * [Ákos Maróy](https://github.com/akosmaroy)
 * [Raytheon Intelligence and Information Systems](http://www.raytheon.com/)

Source/Core/Clock.js

@@ -205,5 +205,31 @@ define([
         return currentTime;
     };
 
+    /**
+     * Makes a copy of this instance.
+     * @param {Clock} [result] The instance to which to copy this object.  If this is undefined, a new {@link Clock} is created.
+     * @return {Clock} The {@link Clock} to which this instance was copied.
+     */
+    Clock.clone = function(clock, result) {
+        if (!defined(clock)) {
+            return undefined;
+        }
+
+        if (!defined(result)) {
+            result = new Clock();
+        }
+
+        result.startTime = clock.startTime;
+        result.stopTime = clock.stopTime;
+        result.currentTime = clock.currentTime;
+        result.multiplier = clock.multiplier;
+        result.clockStep = clock.clockStep;
+        result.clockRange = clock.clockRange;
+        result.canAnimate = clock.canAnimate;
+        result.shouldAnimate = clock.shouldAnimate;
+
+        return result;
+    };
+
     return Clock;
 });

Source/Core/loadText.js

@@ -34,7 +34,8 @@ define([
     var loadText = function(url, headers) {
         return loadWithXhr({
             url : url,
-            headers : headers
+            headers : headers,
+            preferText : true
         });
     };
 

Source/Core/loadWithXhr.js

@@ -30,6 +30,10 @@ define([
      * @param {String} [options.data] The data to send with the request, if any.
      * @param {Object} [options.headers] HTTP headers to send with the request, if any.
      * @param {String} [options.overrideMimeType] Overrides the MIME type returned by the server.
+     * @param {Number} [options.timeout] The timeout of the request, in milliseconds.  If the request does not complete
+     *                 within this timeout, it is aborted and the promise is rejected with a RequestErrorEvent with the
+     *                 isTimeout property set to true.  If this property is undefined, no client-side timeout applies.
+     *
      * @returns {Promise.<Object>} a promise that will resolve to the requested data when loaded.
      *
      * @see loadArrayBuffer
@@ -64,11 +68,13 @@ define([
         var data = options.data;
         var headers = options.headers;
         var overrideMimeType = options.overrideMimeType;
+        var preferText = options.preferText;
+        var timeout = options.timeout;
 
         return when(options.url, function(url) {
             var deferred = when.defer();
 
-            loadWithXhr.load(url, responseType, method, data, headers, deferred, overrideMimeType);
+            loadWithXhr.load(url, responseType, method, data, headers, deferred, overrideMimeType, preferText, timeout);
 
             return deferred.promise;
         });
@@ -122,7 +128,7 @@ define([
     }
 
     // This is broken out into a separate function so that it can be mocked for testing purposes.
-    loadWithXhr.load = function(url, responseType, method, data, headers, deferred, overrideMimeType) {
+    loadWithXhr.load = function(url, responseType, method, data, headers, deferred, overrideMimeType, preferText, timeout) {
         var dataUriRegexResult = dataUriRegex.exec(url);
         if (dataUriRegexResult !== null) {
             deferred.resolve(decodeDataUri(dataUriRegexResult, responseType));
@@ -131,8 +137,19 @@ define([
 
         var xhr = new XMLHttpRequest();
 
-        if (defined(overrideMimeType) && defined(xhr.overrideMimeType)) {
-            xhr.overrideMimeType(overrideMimeType);
+        var weWantXml = false;
+
+        if (defined(overrideMimeType)) {
+            if (defined(xhr.overrideMimeType)) {
+                xhr.overrideMimeType(overrideMimeType);
+            } else if (overrideMimeType === 'text/xml' && responseType === 'document') {
+                // This is an old browser without support for overrideMimeType, and we're asking for XML.
+                // Many XML documents are returned without the 'text/xml' MIME type, such as OGC servers,
+                // so our request will fail if we set the responseType without having a way to override the MIME
+                // type.  So request text instead and then parse out the XML from the text.
+                weWantXml = true;
+                responseType = 'text';
+            }
         }
 
         xhr.open(method, url, true);
@@ -149,18 +166,42 @@ define([
             xhr.responseType = responseType;
         }
 
+        if (defined(timeout)) {
+            xhr.timeout = timeout;
+        }
+
         xhr.onload = function() {
             if (xhr.status === 200) {
+                var parser;
+
                 if (defined(xhr.response)) {
-                    deferred.resolve(xhr.response);
+                    if (weWantXml) {
+                        try {
+                            parser = new DOMParser();
+                            deferred.resolve(parser.parseFromString(xhr.response, 'text/xml'));
+                        } catch (ex) {
+                            deferred.reject(ex);
+                        }
+                    } else {
+                        deferred.resolve(xhr.response);
+                    }
                 } else {
                     // busted old browsers.
-                    if (defined(xhr.responseXML) && xhr.responseXML.hasChildNodes()) {
-                        deferred.resolve(xhr.responseXML);
-                    } else if (defined(xhr.responseText)) {
-                        deferred.resolve(xhr.responseText);
+                    if (weWantXml) {
+                        try {
+                            parser = new DOMParser();
+                            deferred.resolve(parser.parseFromString(xhr.responseText, 'text/xml'));
+                        } catch (ex) {
+                            deferred.reject(ex);
+                        }
                     } else {
-                        deferred.reject(new RuntimeError('unknown XMLHttpRequest response type.'));
+                        if (!defaultValue(preferText, false) && defined(xhr.responseXML) && xhr.responseXML.hasChildNodes()) {
+                            deferred.resolve(xhr.responseXML);
+                        } else if (defined(xhr.responseText)) {
+                            deferred.resolve(xhr.responseText);
+                        } else {
+                            deferred.reject(new RuntimeError('unknown XMLHttpRequest response type.'));
+                        }
                     }
                 }
             } else {
@@ -172,6 +213,12 @@ define([
             deferred.reject(new RequestErrorEvent());
         };
 
+        xhr.ontimeout = function(e) {
+            var timeout = new RequestErrorEvent();
+            timeout.isTimeout = true;
+            deferred.reject(timeout);
+        };
+
         xhr.send(data);
     };
 

Source/Core/throttleRequestByServer.js

@@ -73,6 +73,8 @@ define([
         });
     };
 
+    throttleRequestByServer.maximumRequestsPerServer = 6;
+
     /**
      * Specifies the maximum number of requests that can be simultaneously open to a single server.  If this value is higher than
      * the number of requests per server actually allowed by the web browser, Cesium's ability to prioritize requests will be adversely

Source/DataSources/GeoJsonDataSource.js

@@ -89,7 +89,7 @@ define([
 
     var stringifyScratch = new Array(4);
 
-    function describe(properties, nameProperty) {
+    function defaultDescribe(properties, nameProperty) {
         var html = '';
         for ( var key in properties) {
             if (properties.hasOwnProperty(key)) {
@@ -99,7 +99,7 @@ define([
                 var value = properties[key];
                 if (definedNotNull(value)) {
                     if (typeof value === 'object') {
-                        html += '<tr><th>' + key + '</th><td>' + describe(value) + '</td></tr>';
+                        html += '<tr><th>' + key + '</th><td>' + defaultDescribe(value) + '</td></tr>';
                     } else {
                         html += '<tr><th>' + key + '</th><td>' + value + '</td></tr>';
                     }
@@ -114,7 +114,7 @@ define([
         return html;
     }
 
-    function createDescriptionCallback(properties, nameProperty) {
+    function createDescriptionCallback(describe, properties, nameProperty) {
         var description;
         return function(time, result) {
             if (!defined(description)) {
@@ -124,10 +124,14 @@ define([
         };
     }
 
+    function defaultDescribeProperty(properties, nameProperty) {
+        return new CallbackProperty(createDescriptionCallback(defaultDescribe, properties, nameProperty), true);
+    }
+
     //GeoJSON specifies only the Feature object has a usable id property
     //But since "multi" geometries create multiple entity,
     //we can't use it for them either.
-    function createObject(geoJson, entityCollection) {
+    function createObject(geoJson, entityCollection, describe) {
         var id = geoJson.id;
         if (!definedNotNull(id) || geoJson.type !== 'Feature') {
             id = createGuid();
@@ -189,7 +193,7 @@ define([
 
             var description = properties.description;
             if (!defined(description)) {
-                entity.description = new CallbackProperty(createDescriptionCallback(properties, nameProperty), true);
+                entity.description = describe(properties, nameProperty);
             } else if (description !== null) {
                 entity.description = new ConstantProperty(description);
             }
@@ -213,7 +217,7 @@ define([
 
         if (feature.geometry === null) {
             //Null geometry is allowed, so just create an empty entity instance for it.
-            createObject(feature, dataSource._entityCollection);
+            createObject(feature, dataSource._entityCollection, options.describe);
         } else {
             var geometryType = feature.geometry.type;
             var geometryHandler = geometryTypes[geometryType];
@@ -284,7 +288,7 @@ define([
             billboard.verticalOrigin = new ConstantProperty(VerticalOrigin.BOTTOM);
             billboard.image = new ConstantProperty(dataUrl);
 
-            var entity = createObject(geoJson, dataSource._entityCollection);
+            var entity = createObject(geoJson, dataSource._entityCollection, options.describe);
             entity.billboard = billboard;
             entity.position = new ConstantPositionProperty(crsFunction(coordinates));
         }));
@@ -334,7 +338,7 @@ define([
         polyline.width = widthProperty;
         polyline.positions = new ConstantProperty(coordinatesArrayToCartesianArray(coordinates, crsFunction));
 
-        var entity = createObject(geoJson, dataSource._entityCollection);
+        var entity = createObject(geoJson, dataSource._entityCollection, options.describe);
         entity.polyline = polyline;
     }
 
@@ -417,7 +421,7 @@ define([
             polygon.perPositionHeight = new ConstantProperty(true);
         }
 
-        var entity = createObject(geoJson, dataSource._entityCollection);
+        var entity = createObject(geoJson, dataSource._entityCollection, options.describe);
         entity.polygon = polygon;
     }
 
@@ -732,6 +736,8 @@ define([
      * @param {String|Object} data A url, GeoJSON object, or TopoJSON object to be loaded.
      * @param {Object} [options] An object with the following properties:
      * @param {String} [options.sourceUri] Overrides the url to use for resolving relative links.
+     * @param {GeoJsonDataSource~describe} [options.describe=GeoJsonDataSource.defaultDescribeProperty] A function which returns a Property object (or just a string),
+     *                                                                                which converts the properties into an html description.
      * @param {Number} [options.markerSize=GeoJsonDataSource.markerSize] The default size of the map pin created for each point, in pixels.
      * @param {String} [options.markerSymbol=GeoJsonDataSource.markerSymbol] The default symbol of the map pin created for each point.
      * @param {Color} [options.markerColor=GeoJsonDataSource.markerColor] The default color of the map pin created for each point.
@@ -761,6 +767,7 @@ define([
         }
 
         options = {
+            describe: defaultValue(options.describe, defaultDescribeProperty),
             markerSize : defaultValue(options.markerSize, defaultMarkerSize),
             markerSymbol : defaultValue(options.markerSymbol, defaultMarkerSymbol),
             markerColor : defaultValue(options.markerColor, defaultMarkerColor),
@@ -846,5 +853,12 @@ define([
         });
     }
 
+    /**
+     * This callback is displayed as part of the GeoJsonDataSource class.
+     * @callback GeoJsonDataSource~describe
+     * @param {Object} properties The properties of the feature.
+     * @param {String} nameProperty The property key that Cesium estimates to have the name of the feature.
+     */
+
     return GeoJsonDataSource;
 });

Source/Scene/ArcGisMapServerImageryProvider.js

@@ -8,6 +8,7 @@ define([
         '../Core/defined',
         '../Core/defineProperties',
         '../Core/DeveloperError',
+        '../Core/Ellipsoid',
         '../Core/Event',
         '../Core/GeographicProjection',
         '../Core/GeographicTilingScheme',
@@ -31,6 +32,7 @@ define([
         defined,
         defineProperties,
         DeveloperError,
+        Ellipsoid,
         Event,
         GeographicProjection,
         GeographicTilingScheme,
@@ -90,6 +92,8 @@ define([
      * @param {Number} [options.tileHeight=256] The height of each tile in pixels.  This parameter is ignored when accessing a tiled server.
      * @param {Number} [options.maximumLevel] The maximum tile level to request, or undefined if there is no maximum.  This parameter is ignored when accessing
      *                                        a tiled server.
+     * @param {Object} [options.mapServerData] This MapServer's metadata.  This can be supplied to prevent the imagery provider from making an extraneous
+     *                                         request when the application already has the metadata.
      *
      * @see BingMapsImageryProvider
      * @see GoogleEarthImageryProvider
@@ -166,8 +170,9 @@ define([
                             data.fullExtent.spatialReference.wkid === 102113) {
 
                             var projection = new WebMercatorProjection();
-                            var sw = projection.unproject(new Cartesian2(data.fullExtent.xmin, data.fullExtent.ymin));
-                            var ne = projection.unproject(new Cartesian2(data.fullExtent.xmax, data.fullExtent.ymax));
+                            var extent = data.fullExtent;
+                            var sw = projection.unproject(new Cartesian3(Math.max(extent.xmin, -Ellipsoid.WGS84.maximumRadius * Math.PI), Math.max(extent.ymin, -Ellipsoid.WGS84.maximumRadius * Math.PI), 0.0));
+                            var ne = projection.unproject(new Cartesian3(Math.min(extent.xmax, Ellipsoid.WGS84.maximumRadius * Math.PI), Math.min(extent.ymax, Ellipsoid.WGS84.maximumRadius * Math.PI), 0.0));
                             that._rectangle = new Rectangle(sw.longitude, sw.latitude, ne.longitude, ne.latitude);
                         } else if (data.fullExtent.spatialReference.wkid === 4326) {
                             that._rectangle = Rectangle.fromDegrees(data.fullExtent.xmin, data.fullExtent.ymin, data.fullExtent.xmax, data.fullExtent.ymax);
@@ -222,7 +227,9 @@ define([
             when(metadata, metadataSuccess, metadataFailure);
         }
 
-        if (this._useTiles) {
+        if (defined(options.mapServerData)) {
+            metadataSuccess(options.mapServerData);
+        } else if (this._useTiles) {
             requestMetadata();
         } else {
             this._ready = true;