Entity

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 32

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 88

billboard :BillboardGraphics

Gets or sets the billboard.
Source: DataSources/Entity.js, line 151

readonlydefinitionChanged :Event

Gets the event that is raised whenever a new property is assigned.
Source: DataSources/Entity.js, line 106

description :Property

Gets or sets the description.
Source: DataSources/Entity.js, line 157

ellipse :EllipseGraphics

Gets or sets the ellipse.
Source: DataSources/Entity.js, line 163

ellipsoid :EllipsoidGraphics

Gets or sets the ellipsoid.
Source: DataSources/Entity.js, line 169

id :String

Gets the unique ID associated with this object.
Source: DataSources/Entity.js, line 94

label :LabelGraphics

Gets or sets the label.
Source: DataSources/Entity.js, line 175

model :LabelGraphics

Gets or sets the model.
Source: DataSources/Entity.js, line 181

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 117

orientation :Property

Gets or sets the orientation.
Source: DataSources/Entity.js, line 187

parent :Entity

Gets or sets the parent object.
Source: DataSources/Entity.js, line 135

path :PathGraphics

Gets or sets the path.
Source: DataSources/Entity.js, line 193

point :PointGraphics

Gets or sets the point graphic.
Source: DataSources/Entity.js, line 199

polygon :PolygonGraphics

Gets or sets the polygon.
Source: DataSources/Entity.js, line 205

polyline :PolylineGraphics

Gets or sets the polyline.
Source: DataSources/Entity.js, line 211

position :PositionProperty

Gets or sets the position.
Source: DataSources/Entity.js, line 217

propertyNames :Event

Gets the names of all properties registed on this instance.
Source: DataSources/Entity.js, line 141

rectangle :RectangleGraphics

Gets or sets the rectangle.
Source: DataSources/Entity.js, line 223

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 230

wall :WallGraphics

Gets or sets the wall.
Source: DataSources/Entity.js, line 236

Methods

addProperty(propertyName)

Adds a property to this object. Once a property is added, it can be observed with Entity#definitionChanged and composited with CompositeEntityCollection
Name Type Description
propertyName String The name of the property to add.
Throws:
Source: DataSources/Entity.js, line 266

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 245

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 315

removeProperty(propertyName)

Removed a property previously added with addProperty.
Name Type Description
propertyName String The name of the property to remove.
Throws:
Source: DataSources/Entity.js, line 293