@cesium/engine 2.0.0 → 2.2.0

package/Source/DataSources/DataSource.js

@@ -18,7 +18,7 @@ Object.defineProperties(DataSource.prototype, {
   /**
    * Gets a human-readable name for this instance.
    * @memberof DataSource.prototype
-   * @type {String}
+   * @type {string}
    */
   name: {
     get: DeveloperError.throwInstantiationError,
@@ -42,7 +42,7 @@ Object.defineProperties(DataSource.prototype, {
   /**
    * Gets a value indicating if the data source is currently loading data.
    * @memberof DataSource.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   isLoading: {
     get: DeveloperError.throwInstantiationError,
@@ -74,7 +74,7 @@ Object.defineProperties(DataSource.prototype, {
   /**
    * Gets whether or not this data source should be displayed.
    * @memberof DataSource.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   show: {
     get: DeveloperError.throwInstantiationError,
@@ -98,7 +98,7 @@ Object.defineProperties(DataSource.prototype, {
  * If implemented, update will be called by {@link DataSourceDisplay} once a frame.
  *
  * @param {JulianDate} time The simulation time.
- * @returns {Boolean} True if this data source is ready to be displayed at the provided time, false otherwise.
+ * @returns {boolean} True if this data source is ready to be displayed at the provided time, false otherwise.
  */
 DataSource.prototype.update = function (time) {
   DeveloperError.throwInstantiationError();

package/Source/DataSources/DataSourceClock.js

@@ -81,7 +81,7 @@ Object.defineProperties(DataSourceClock.prototype, {
    * Gets or sets the desired clock multiplier.
    * See {@link Clock#multiplier}.
    * @memberof DataSourceClock.prototype
-   * @type {Number}
+   * @type {number}
    */
   multiplier: createRawPropertyDescriptor("multiplier"),
 });
@@ -109,7 +109,7 @@ DataSourceClock.prototype.clone = function (result) {
  * Returns true if this DataSourceClock is equivalent to the other
  *
  * @param {DataSourceClock} other The other DataSourceClock to compare to.
- * @returns {Boolean} <code>true</code> if the DataSourceClocks are equal; otherwise, <code>false</code>.
+ * @returns {boolean} <code>true</code> if the DataSourceClocks are equal; otherwise, <code>false</code>.
  */
 DataSourceClock.prototype.equals = function (other) {
   return (

package/Source/DataSources/DataSourceCollection.js

@@ -21,7 +21,7 @@ Object.defineProperties(DataSourceCollection.prototype, {
   /**
    * Gets the number of data sources in this collection.
    * @memberof DataSourceCollection.prototype
-   * @type {Number}
+   * @type {number}
    * @readonly
    */
   length: {
@@ -73,10 +73,10 @@ Object.defineProperties(DataSourceCollection.prototype, {
 /**
  * Adds a data source to the collection.
  *
- * @param {DataSource|Promise.<DataSource>} dataSource A data source or a promise to a data source to add to the collection.
+ * @param {DataSource|Promise<DataSource>} dataSource A data source or a promise to a data source to add to the collection.
  *                                        When passing a promise, the data source will not actually be added
  *                                        to the collection until the promise resolves successfully.
- * @returns {Promise.<DataSource>} A Promise that resolves once the data source has been added to the collection.
+ * @returns {Promise<DataSource>} A Promise that resolves once the data source has been added to the collection.
  */
 DataSourceCollection.prototype.add = function (dataSource) {
   //>>includeStart('debug', pragmas.debug);
@@ -102,8 +102,8 @@ DataSourceCollection.prototype.add = function (dataSource) {
  * Removes a data source from this collection, if present.
  *
  * @param {DataSource} dataSource The data source to remove.
- * @param {Boolean} [destroy=false] Whether to destroy the data source in addition to removing it.
- * @returns {Boolean} true if the data source was in the collection and was removed,
+ * @param {boolean} [destroy=false] Whether to destroy the data source in addition to removing it.
+ * @returns {boolean} true if the data source was in the collection and was removed,
  *                    false if the data source was not in the collection.
  */
 DataSourceCollection.prototype.remove = function (dataSource, destroy) {
@@ -127,7 +127,7 @@ DataSourceCollection.prototype.remove = function (dataSource, destroy) {
 /**
  * Removes all data sources from this collection.
  *
- * @param {Boolean} [destroy=false] whether to destroy the data sources in addition to removing them.
+ * @param {boolean} [destroy=false] whether to destroy the data sources in addition to removing them.
  */
 DataSourceCollection.prototype.removeAll = function (destroy) {
   destroy = defaultValue(destroy, false);
@@ -148,7 +148,7 @@ DataSourceCollection.prototype.removeAll = function (destroy) {
  * Checks to see if the collection contains a given data source.
  *
  * @param {DataSource} dataSource The data source to check for.
- * @returns {Boolean} true if the collection contains the data source, false otherwise.
+ * @returns {boolean} true if the collection contains the data source, false otherwise.
  */
 DataSourceCollection.prototype.contains = function (dataSource) {
   return this.indexOf(dataSource) !== -1;
@@ -158,7 +158,7 @@ DataSourceCollection.prototype.contains = function (dataSource) {
  * Determines the index of a given data source in the collection.
  *
  * @param {DataSource} dataSource The data source to find the index of.
- * @returns {Number} The index of the data source in the collection, or -1 if the data source does not exist in the collection.
+ * @returns {number} The index of the data source in the collection, or -1 if the data source does not exist in the collection.
  */
 DataSourceCollection.prototype.indexOf = function (dataSource) {
   return this._dataSources.indexOf(dataSource);
@@ -167,7 +167,7 @@ DataSourceCollection.prototype.indexOf = function (dataSource) {
 /**
  * Gets a data source by index from the collection.
  *
- * @param {Number} index the index to retrieve.
+ * @param {number} index the index to retrieve.
  * @returns {DataSource} The data source at the specified index.
  */
 DataSourceCollection.prototype.get = function (index) {
@@ -183,7 +183,7 @@ DataSourceCollection.prototype.get = function (index) {
 /**
  * Gets a data source by name from the collection.
  *
- * @param {String} name The name to retrieve.
+ * @param {string} name The name to retrieve.
  * @returns {DataSource[]} A list of all data sources matching the provided name.
  */
 DataSourceCollection.prototype.getByName = function (name) {
@@ -306,7 +306,7 @@ DataSourceCollection.prototype.lowerToBottom = function (dataSource) {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} true if this object was destroyed; otherwise, false.
+ * @returns {boolean} true if this object was destroyed; otherwise, false.
  *
  * @see DataSourceCollection#destroy
  */

package/Source/DataSources/DataSourceDisplay.js

@@ -25,7 +25,7 @@ import PolylineVisualizer from "./PolylineVisualizer.js";
  * @alias DataSourceDisplay
  * @constructor
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Scene} options.scene The scene in which to display the data.
  * @param {DataSourceCollection} options.dataSourceCollection The data sources to display.
  * @param {DataSourceDisplay.VisualizersCallback} [options.visualizersCallback=DataSourceDisplay.defaultVisualizersCallback]
@@ -192,7 +192,7 @@ Object.defineProperties(DataSourceDisplay.prototype, {
   /**
    * Gets a value indicating whether or not all entities in the data source are ready
    * @memberof DataSourceDisplay.prototype
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    */
   ready: {
@@ -208,7 +208,7 @@ Object.defineProperties(DataSourceDisplay.prototype, {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see DataSourceDisplay#destroy
  */
@@ -259,7 +259,7 @@ DataSourceDisplay.prototype.destroy = function () {
  * Updates the display to the provided time.
  *
  * @param {JulianDate} time The simulation time.
- * @returns {Boolean} True if all data sources are ready to be displayed, false otherwise.
+ * @returns {boolean} True if all data sources are ready to be displayed, false otherwise.
  */
 DataSourceDisplay.prototype.update = function (time) {
   //>>includeStart('debug', pragmas.debug);
@@ -335,7 +335,7 @@ const getBoundingSphereBoundingSphereScratch = new BoundingSphere();
  * The bounding sphere is in the fixed frame of the scene's globe.
  *
  * @param {Entity} entity The entity whose bounding sphere to compute.
- * @param {Boolean} allowPartial If true, pending bounding spheres are ignored and an answer will be returned from the currently available data.
+ * @param {boolean} allowPartial If true, pending bounding spheres are ignored and an answer will be returned from the currently available data.
  *                               If false, the the function will halt and return pending if any of the bounding spheres are pending.
  * @param {BoundingSphere} result The bounding sphere onto which to store the result.
  * @returns {BoundingSphereState} BoundingSphereState.DONE if the result contains the bounding sphere,

package/Source/DataSources/DynamicGeometryUpdater.js

@@ -247,7 +247,7 @@ DynamicGeometryUpdater.prototype.getBoundingSphere = function (result) {
  * @memberof DynamicGeometryUpdater
  * @function
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  */
 DynamicGeometryUpdater.prototype.isDestroyed = function () {
   return false;

package/Source/DataSources/EllipseGraphics.js

@@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor
 import createPropertyDescriptor from "./createPropertyDescriptor.js";
 
 /**
- * @typedef {Object} EllipseGraphics.ConstructorOptions
+ * @typedef {object} EllipseGraphics.ConstructorOptions
  *
  * Initialization options for the EllipseGraphics constructor
  *

package/Source/DataSources/EllipsoidGeometryUpdater.js

@@ -105,7 +105,7 @@ Object.defineProperties(EllipsoidGeometryUpdater.prototype, {
  * Creates the geometry instance which represents the fill of the geometry.
  *
  * @param {JulianDate} time The time to use when retrieving initial attribute values.
- * @param {Boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance
+ * @param {boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance
  * @param {Matrix4} [modelMatrixResult] Used to store the result of the model matrix calculation
  * @returns {GeometryInstance} The geometry instance representing the filled portion of the geometry.
  *
@@ -189,7 +189,7 @@ EllipsoidGeometryUpdater.prototype.createFillGeometryInstance = function (
  * Creates the geometry instance which represents the outline of the geometry.
  *
  * @param {JulianDate} time The time to use when retrieving initial attribute values.
- * @param {Boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance
+ * @param {boolean} [skipModelMatrix=false] Whether to compute a model matrix for the geometry instance
  * @param {Matrix4} [modelMatrixResult] Used to store the result of the model matrix calculation
  * @returns {GeometryInstance} The geometry instance representing the outline portion of the geometry.
  *

package/Source/DataSources/EllipsoidGraphics.js

@@ -6,7 +6,7 @@ import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor
 import createPropertyDescriptor from "./createPropertyDescriptor.js";
 
 /**
- * @typedef {Object} EllipsoidGraphics.ConstructorOptions
+ * @typedef {object} EllipsoidGraphics.ConstructorOptions
  *
  * Initialization options for the EllipsoidGraphics constructor
  *

package/Source/DataSources/Entity.js

@@ -61,14 +61,14 @@ function createPropertyTypeDescriptor(name, Type) {
 }
 
 /**
- * @typedef {Object} Entity.ConstructorOptions
+ * @typedef {object} Entity.ConstructorOptions
  *
  * Initialization options for the Entity constructor
  *
- * @property {String} [id] A unique identifier for this object. If none is provided, a GUID is generated.
- * @property {String} [name] A human readable name to display to users. It does not have to be unique.
+ * @property {string} [id] A unique identifier for this object. If none is provided, a GUID is generated.
+ * @property {string} [name] A human readable name to display to users. It does not have to be unique.
  * @property {TimeIntervalCollection} [availability] The availability, if any, associated with this object.
- * @property {Boolean} [show] A boolean value indicating if the entity and its children are displayed.
+ * @property {boolean} [show] A boolean value indicating if the entity and its children are displayed.
  * @property {Property | string} [description] A string Property specifying an HTML description for this entity.
  * @property {PositionProperty | Cartesian3} [position] A Property specifying the entity position.
  * @property {Property} [orientation] A Property specifying the entity orientation.
@@ -88,7 +88,7 @@ function createPropertyTypeDescriptor(name, Type) {
  * @property {PointGraphics | PointGraphics.ConstructorOptions} [point] A point to associate with this entity.
  * @property {PolygonGraphics | PolygonGraphics.ConstructorOptions} [polygon] A polygon to associate with this entity.
  * @property {PolylineGraphics | PolylineGraphics.ConstructorOptions} [polyline] A polyline to associate with this entity.
- * @property {PropertyBag | Object.<string,*>} [properties] Arbitrary properties to associate with this entity.
+ * @property {PropertyBag | Object<string,*>} [properties] Arbitrary properties to associate with this entity.
  * @property {PolylineVolumeGraphics | PolylineVolumeGraphics.ConstructorOptions} [polylineVolume] A polylineVolume to associate with this entity.
  * @property {RectangleGraphics | RectangleGraphics.ConstructorOptions} [rectangle] A rectangle to associate with this entity.
  * @property {WallGraphics | WallGraphics.ConstructorOptions} [wall] A wall to associate with this entity.
@@ -233,7 +233,7 @@ Object.defineProperties(Entity.prototype, {
   /**
    * Gets the unique ID associated with this object.
    * @memberof Entity.prototype
-   * @type {String}
+   * @type {string}
    */
   id: {
     get: function () {
@@ -256,14 +256,14 @@ Object.defineProperties(Entity.prototype, {
    * Gets or sets the name of the object.  The name is intended for end-user
    * consumption and does not need to be unique.
    * @memberof Entity.prototype
-   * @type {String|undefined}
+   * @type {string|undefined}
    */
   name: createRawPropertyDescriptor("name"),
   /**
    * Gets or sets whether this entity should be displayed. When set to true,
    * the entity is only displayed if the parent entity's show property is also true.
    * @memberof Entity.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   show: {
     get: function () {
@@ -295,7 +295,7 @@ Object.defineProperties(Entity.prototype, {
    * Gets whether this entity is being displayed, taking into account
    * the visibility of any ancestor entities.
    * @memberof Entity.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   isShowing: {
     get: function () {
@@ -495,7 +495,7 @@ Object.defineProperties(Entity.prototype, {
  * Given a time, returns true if this object should have data during that time.
  *
  * @param {JulianDate} time The time to check availability for.
- * @returns {Boolean} true if the object should have data during the provided time, false otherwise.
+ * @returns {boolean} true if the object should have data during the provided time, false otherwise.
  */
 Entity.prototype.isAvailable = function (time) {
   //>>includeStart('debug', pragmas.debug);
@@ -513,7 +513,7 @@ Entity.prototype.isAvailable = function (time) {
  * observed with {@link Entity#definitionChanged} and composited
  * with {@link CompositeEntityCollection}
  *
- * @param {String} propertyName The name of the property to add.
+ * @param {string} propertyName The name of the property to add.
  *
  * @exception {DeveloperError} "propertyName" is a reserved property name.
  * @exception {DeveloperError} "propertyName" is already a registered property.
@@ -546,7 +546,7 @@ Entity.prototype.addProperty = function (propertyName) {
 /**
  * Removed a property previously added with addProperty.
  *
- * @param {String} propertyName The name of the property to remove.
+ * @param {string} propertyName The name of the property to remove.
  *
  * @exception {DeveloperError} "propertyName" is a reserved property name.
  * @exception {DeveloperError} "propertyName" is not a registered property.
@@ -597,7 +597,12 @@ Entity.prototype.merge = function (source) {
     //While source is required by the API to be an Entity, we internally call this method from the
     //constructor with an options object to configure initial custom properties.
     //So we need to ignore reserved-non-property.
-    if (name === "parent" || name === "name" || name === "availability") {
+    if (
+      name === "parent" ||
+      name === "name" ||
+      name === "availability" ||
+      name === "children"
+    ) {
       continue;
     }
 
@@ -732,7 +737,7 @@ Entity.prototype.computeModelMatrixForHeightReference = function (
  * instead be rendered as if height is 0.
  *
  * @param {Scene} scene The current scene.
- * @returns {Boolean} Whether or not the current scene supports materials for entities on terrain.
+ * @returns {boolean} Whether or not the current scene supports materials for entities on terrain.
  */
 Entity.supportsMaterialsforEntitiesOnTerrain = function (scene) {
   return GroundPrimitive.supportsMaterials(scene);
@@ -744,7 +749,7 @@ Entity.supportsMaterialsforEntitiesOnTerrain = function (scene) {
  * the provided heights and using the `arcType` parameter instead of clamped to the ground.
  *
  * @param {Scene} scene The current scene.
- * @returns {Boolean} Whether or not the current scene supports polylines on terrain or 3D TIles.
+ * @returns {boolean} Whether or not the current scene supports polylines on terrain or 3D TIles.
  */
 Entity.supportsPolylinesOnTerrain = function (scene) {
   return GroundPolylinePrimitive.isSupported(scene);

package/Source/DataSources/EntityCluster.js

@@ -18,14 +18,14 @@ import KDBush from "kdbush";
 /**
  * Defines how screen space objects (billboards, points, labels) are clustered.
  *
- * @param {Object} [options] An object with the following properties:
- * @param {Boolean} [options.enabled=false] Whether or not to enable clustering.
- * @param {Number} [options.pixelRange=80] The pixel range to extend the screen space bounding box.
- * @param {Number} [options.minimumClusterSize=2] The minimum number of screen space objects that can be clustered.
- * @param {Boolean} [options.clusterBillboards=true] Whether or not to cluster the billboards of an entity.
- * @param {Boolean} [options.clusterLabels=true] Whether or not to cluster the labels of an entity.
- * @param {Boolean} [options.clusterPoints=true] Whether or not to cluster the points of an entity.
- * @param {Boolean} [options.show=true] Determines if the entities in the cluster will be shown.
+ * @param {object} [options] An object with the following properties:
+ * @param {boolean} [options.enabled=false] Whether or not to enable clustering.
+ * @param {number} [options.pixelRange=80] The pixel range to extend the screen space bounding box.
+ * @param {number} [options.minimumClusterSize=2] The minimum number of screen space objects that can be clustered.
+ * @param {boolean} [options.clusterBillboards=true] Whether or not to cluster the billboards of an entity.
+ * @param {boolean} [options.clusterLabels=true] Whether or not to cluster the labels of an entity.
+ * @param {boolean} [options.clusterPoints=true] Whether or not to cluster the points of an entity.
+ * @param {boolean} [options.show=true] Determines if the entities in the cluster will be shown.
  *
  * @alias EntityCluster
  * @constructor
@@ -70,7 +70,7 @@ function EntityCluster(options) {
   /**
    * Determines if entities in this collection will be shown.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @default true
    */
   this.show = defaultValue(options.show, true);
@@ -517,7 +517,7 @@ Object.defineProperties(EntityCluster.prototype, {
   /**
    * Gets or sets whether clustering is enabled.
    * @memberof EntityCluster.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   enabled: {
     get: function () {
@@ -531,7 +531,7 @@ Object.defineProperties(EntityCluster.prototype, {
   /**
    * Gets or sets the pixel range to extend the screen space bounding box.
    * @memberof EntityCluster.prototype
-   * @type {Number}
+   * @type {number}
    */
   pixelRange: {
     get: function () {
@@ -545,7 +545,7 @@ Object.defineProperties(EntityCluster.prototype, {
   /**
    * Gets or sets the minimum number of screen space objects that can be clustered.
    * @memberof EntityCluster.prototype
-   * @type {Number}
+   * @type {number}
    */
   minimumClusterSize: {
     get: function () {
@@ -570,7 +570,7 @@ Object.defineProperties(EntityCluster.prototype, {
   /**
    * Gets or sets whether clustering billboard entities is enabled.
    * @memberof EntityCluster.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   clusterBillboards: {
     get: function () {
@@ -585,7 +585,7 @@ Object.defineProperties(EntityCluster.prototype, {
   /**
    * Gets or sets whether clustering labels entities is enabled.
    * @memberof EntityCluster.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   clusterLabels: {
     get: function () {
@@ -599,7 +599,7 @@ Object.defineProperties(EntityCluster.prototype, {
   /**
    * Gets or sets whether clustering point entities is enabled.
    * @memberof EntityCluster.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   clusterPoints: {
     get: function () {
@@ -981,7 +981,7 @@ EntityCluster.prototype.destroy = function () {
  * @callback EntityCluster.newClusterCallback
  *
  * @param {Entity[]} clusteredEntities An array of the entities contained in the cluster.
- * @param {Object} cluster An object containing the Billboard, Label, and Point
+ * @param {object} cluster An object containing the Billboard, Label, and Point
  * primitives that represent this cluster of entities.
  * @param {Billboard} cluster.billboard
  * @param {Label} cluster.label

package/Source/DataSources/EntityCollection.js

@@ -128,7 +128,7 @@ Object.defineProperties(EntityCollection.prototype, {
    * Gets a globally unique identifier for this collection.
    * @memberof EntityCollection.prototype
    * @readonly
-   * @type {String}
+   * @type {string}
    */
   id: {
     get: function () {
@@ -152,7 +152,7 @@ Object.defineProperties(EntityCollection.prototype, {
    * displayed.  When true, each entity is only displayed if
    * its own show property is also true.
    * @memberof EntityCollection.prototype
-   * @type {Boolean}
+   * @type {boolean}
    */
   show: {
     get: function () {
@@ -305,7 +305,7 @@ EntityCollection.prototype.add = function (entity) {
  * Removes an entity from the collection.
  *
  * @param {Entity} entity The entity to be removed.
- * @returns {Boolean} true if the item was removed, false if it did not exist in the collection.
+ * @returns {boolean} true if the item was removed, false if it did not exist in the collection.
  */
 EntityCollection.prototype.remove = function (entity) {
   if (!defined(entity)) {
@@ -318,7 +318,7 @@ EntityCollection.prototype.remove = function (entity) {
  * Returns true if the provided entity is in this collection, false otherwise.
  *
  * @param {Entity} entity The entity.
- * @returns {Boolean} true if the provided entity is in this collection, false otherwise.
+ * @returns {boolean} true if the provided entity is in this collection, false otherwise.
  */
 EntityCollection.prototype.contains = function (entity) {
   //>>includeStart('debug', pragmas.debug);
@@ -332,8 +332,8 @@ EntityCollection.prototype.contains = function (entity) {
 /**
  * Removes an entity with the provided id from the collection.
  *
- * @param {String} id The id of the entity to remove.
- * @returns {Boolean} true if the item was removed, false if no item with the provided id existed in the collection.
+ * @param {string} id The id of the entity to remove.
+ * @returns {boolean} true if the item was removed, false if no item with the provided id existed in the collection.
  */
 EntityCollection.prototype.removeById = function (id) {
   if (!defined(id)) {
@@ -395,7 +395,7 @@ EntityCollection.prototype.removeAll = function () {
 /**
  * Gets an entity with the specified id.
  *
- * @param {String} id The id of the entity to retrieve.
+ * @param {string} id The id of the entity to retrieve.
  * @returns {Entity|undefined} The entity with the provided id or undefined if the id did not exist in the collection.
  */
 EntityCollection.prototype.getById = function (id) {
@@ -411,7 +411,7 @@ EntityCollection.prototype.getById = function (id) {
 /**
  * Gets an entity with the specified id or creates it and adds it to the collection if it does not exist.
  *
- * @param {String} id The id of the entity to retrieve or create.
+ * @param {string} id The id of the entity to retrieve or create.
  * @returns {Entity} The new or existing object.
  */
 EntityCollection.prototype.getOrCreateEntity = function (id) {