new Entity(id)
Entity instances are the primary data store for processed data.
They are used primarily by the visualizers to create and maintain graphic
primitives that represent the Entity's properties at a specific time.
Name | Type | Description |
---|---|---|
id |
String | optional A unique identifier for this object. If no id is provided, a GUID is generated. |
See:
Source:
DataSources/Entity.js, line 44
Members
-
availability :TimeIntervalCollection
-
The availability, if any, associated with this object. If availability is undefined, it is assumed that this object's other properties will return valid data for any provided time. If availability exists, the objects other properties will only provide valid data if queried within the given interval.Source: DataSources/Entity.js, line 106
-
billboard :BillboardGraphics
-
Gets or sets the billboard.Source: DataSources/Entity.js, line 169
-
box :BoxGraphics
-
Gets or sets the box.Source: DataSources/Entity.js, line 175
-
corridor :CorridorGraphics
-
Gets or sets the corridor.Source: DataSources/Entity.js, line 181
-
cylinder :CylinderGraphics
-
Gets or sets the cylinder.Source: DataSources/Entity.js, line 187
-
readonlydefinitionChanged :Event
-
Gets the event that is raised whenever a new property is assigned.Source: DataSources/Entity.js, line 124
-
description :Property
-
Gets or sets the description.Source: DataSources/Entity.js, line 193
-
ellipse :EllipseGraphics
-
Gets or sets the ellipse.Source: DataSources/Entity.js, line 199
-
ellipsoid :EllipsoidGraphics
-
Gets or sets the ellipsoid.Source: DataSources/Entity.js, line 205
-
id :String
-
Gets the unique ID associated with this object.Source: DataSources/Entity.js, line 112
-
label :LabelGraphics
-
Gets or sets the label.Source: DataSources/Entity.js, line 211
-
model :LabelGraphics
-
Gets or sets the model.Source: DataSources/Entity.js, line 217
-
name :String
-
Gets or sets the name of the object. The name is intended for end-user consumption and does not need to be unique.Source: DataSources/Entity.js, line 135
-
orientation :Property
-
Gets or sets the orientation.Source: DataSources/Entity.js, line 223
-
parent :Entity
-
Gets or sets the parent object.Source: DataSources/Entity.js, line 153
-
path :PathGraphics
-
Gets or sets the path.Source: DataSources/Entity.js, line 229
-
point :PointGraphics
-
Gets or sets the point graphic.Source: DataSources/Entity.js, line 235
-
polygon :PolygonGraphics
-
Gets or sets the polygon.Source: DataSources/Entity.js, line 241
-
polyline :PolylineGraphics
-
Gets or sets the polyline.Source: DataSources/Entity.js, line 247
-
position :PositionProperty
-
Gets or sets the position.Source: DataSources/Entity.js, line 253
-
propertyNames :Event
-
Gets the names of all properties registed on this instance.Source: DataSources/Entity.js, line 159
-
rectangle :RectangleGraphics
-
Gets or sets the rectangle.Source: DataSources/Entity.js, line 259
-
viewFrom :Cartesian3
-
Gets or sets the suggested initial offset for viewing this object with the camera. The offset is defined in the east-north-up reference frame.Source: DataSources/Entity.js, line 266
-
wall :WallGraphics
-
Gets or sets the wall.Source: DataSources/Entity.js, line 272
Methods
-
addProperty(propertyName)
-
Adds a property to this object. Once a property is added, it can be observed with
Entity#definitionChanged
and composited withCompositeEntityCollection
Name Type Description propertyName
String The name of the property to add. Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is already a registered property.
Source: DataSources/Entity.js, line 302 -
-
isAvailable(time)
-
Given a time, returns true if this object should have data during that time.
Name Type Description time
JulianDate The time to check availability for. Returns:
true if the object should have data during the provided time, false otherwise.Source: DataSources/Entity.js, line 281 -
merge(source)
-
Assigns each unassigned property on this object to the value of the same property on the provided source object.
Name Type Description source
Entity The object to be merged into this object. Source: DataSources/Entity.js, line 351 -
removeProperty(propertyName)
-
Removed a property previously added with addProperty.
Name Type Description propertyName
String The name of the property to remove. Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is not a registered property.
Source: DataSources/Entity.js, line 329 -