Allow custom geoJson description function

CHANGES.md

@@ -34,6 +34,7 @@ Change Log
 * Updated `requirejs` from 2.1.9 to 2.1.20. [#3107](https://github.com/AnalyticalGraphicsInc/cesium/pull/3107)
 * Updated `almond` from 0.2.6 to 0.3.1. [#3107](https://github.com/AnalyticalGraphicsInc/cesium/pull/3107)
 * Made `TileMapServiceImageryProvider` and `CesiumTerrainProvider` work properly when the provided base url contains query parameters and fragments.
+* Allow custom geoJson description function.
 
 ### 1.14 - 2015-10-01
 

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/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)) {
@@ -127,7 +127,7 @@ define([
     //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 +189,7 @@ define([
 
             var description = properties.description;
             if (!defined(description)) {
-                entity.description = new CallbackProperty(createDescriptionCallback(properties, nameProperty), true);
+                entity.description = new CallbackProperty(createDescriptionCallback(describe, properties, nameProperty), true);
             } else if (description !== null) {
                 entity.description = new ConstantProperty(description);
             }
@@ -213,7 +213,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 +284,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 +334,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 +417,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 +732,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 {Function} [options.describe=GeoJsonDataSource.defaultDescribe] A custom function used to convert the properties into an html description.
+     *                                                                        It takes two arguments: the properties and a nameProperty.
      * @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 +763,7 @@ define([
         }
 
         options = {
+            describe: defaultValue(options.describe, defaultDescribe),
             markerSize : defaultValue(options.markerSize, defaultMarkerSize),
             markerSymbol : defaultValue(options.markerSymbol, defaultMarkerSymbol),
             markerColor : defaultValue(options.markerColor, defaultMarkerColor),

Specs/DataSources/GeoJsonDataSourceSpec.js

@@ -270,7 +270,7 @@ defineSuite([
         });
     });
 
-    it('Creates description from properties', function() {
+    it('Creates default description from properties', function() {
         var featureWithProperties = {
             type : 'Feature',
             geometry : point,
@@ -296,6 +296,43 @@ defineSuite([
         });
     });
 
+    it('Creates custom description from properties', function() {
+        var featureWithProperties = {
+            type : 'Feature',
+            geometry : point,
+            properties : {
+                prop1 : 'dog',
+                prop2 : 'cat',
+                prop3 : 'liger'
+            }
+        };
+
+        function testDescribe(properties) {
+            var desc = '';
+            for (var key in properties) {
+                if (properties.hasOwnProperty(key)) {
+                    var value = properties[key];
+                    desc +=  key + ' = ' + value + '. ';
+                }
+            }
+            return desc;
+        }
+
+        var dataSource = new GeoJsonDataSource();
+        var options = {
+            describe: testDescribe
+        };
+        return dataSource.load(featureWithProperties, options).then(function() {
+            var entityCollection = dataSource.entities;
+            var entity = entityCollection.values[0];
+            expect(entity.description).toBeDefined();
+            var description = entity.description.getValue(time);
+            expect(description).toContain('prop1 = dog');
+            expect(description).toContain('prop2 = cat');
+            expect(description).toContain('prop3 = liger');
+        });
+    });
+
     it('Uses description if present', function() {
         var featureWithDescription = {
             type : 'Feature',