Class: Entity

Entity

new Entity(optionsopt)

Entity instances aggregate multiple forms of visualization into a single high-level object. They can be created manually and added to Viewer#entities or be produced by data sources, such as CzmlDataSource and GeoJsonDataSource.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Description
id String <optional>
 A unique identifier for this object. If none is provided, a GUID is generated.
name String <optional>
 A human readable name to display to users. It does not have to be unique.
availability TimeIntervalCollection <optional>
 The availability, if any, associated with this object.
show Boolean <optional>
 A boolean value indicating if the entity and its children are displayed.
description Property <optional>
 A string Property specifying an HTML description for this entity.
position PositionProperty <optional>
 A Property specifying the entity position.
orientation Property <optional>
 A Property specifying the entity orientation.
viewFrom Property <optional>
 A suggested initial offset for viewing this object.
parent Entity <optional>
 A parent entity to associate with this entity.
billboard BillboardGraphics <optional>
 A billboard to associate with this entity.
box BoxGraphics <optional>
 A box to associate with this entity.
corridor CorridorGraphics <optional>
 A corridor to associate with this entity.
cylinder CylinderGraphics <optional>
 A cylinder to associate with this entity.
ellipse EllipseGraphics <optional>
 A ellipse to associate with this entity.
ellipsoid EllipsoidGraphics <optional>
 A ellipsoid to associate with this entity.
label LabelGraphics <optional>
 A options.label to associate with this entity.
model ModelGraphics <optional>
 A model to associate with this entity.
path PathGraphics <optional>
 A path to associate with this entity.
point PointGraphics <optional>
 A point to associate with this entity.
polygon PolygonGraphics <optional>
 A polygon to associate with this entity.
polyline PolylineGraphics <optional>
 A polyline to associate with this entity.
polylineVolume PolylineVolumeGraphics <optional>
 A polylineVolume to associate with this entity.
rectangle RectangleGraphics <optional>
 A rectangle to associate with this entity.
wall WallGraphics <optional>
 A wall to associate with this entity.
Source:
See:

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.
Type:
Source:

billboard :BillboardGraphics

Gets or sets the billboard.
Type:
Source:

box :BoxGraphics

Gets or sets the box.
Type:
Source:

corridor :CorridorGraphics

Gets or sets the corridor.
Type:
Source:

cylinder :CylinderGraphics

Gets or sets the cylinder.
Type:
Source:

(readonly) definitionChanged :Event

Gets the event that is raised whenever a property or sub-property is changed or modified.
Type:
Source:

description :Property

Gets or sets the description.
Type:
Source:

ellipse :EllipseGraphics

Gets or sets the ellipse.
Type:
Source:

ellipsoid :EllipsoidGraphics

Gets or sets the ellipsoid.
Type:
Source:

entityCollection :EntityCollection

Gets or sets the entity collection that this entity belongs to.
Type:
Source:

id :String

Gets the unique ID associated with this object.
Type:
  • String
Source:

isShowing :Boolean

Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.
Type:
  • Boolean
Source:

label :LabelGraphics

Gets or sets the label.
Type:
Source:

model :ModelGraphics

Gets or sets the model.
Type:
Source:

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.
Type:
  • String
Source:

orientation :Property

Gets or sets the orientation.
Type:
Source:

parent :Entity

Gets or sets the parent object.
Type:
Source:

path :PathGraphics

Gets or sets the path.
Type:
Source:

point :PointGraphics

Gets or sets the point graphic.
Type:
Source:

polygon :PolygonGraphics

Gets or sets the polygon.
Type:
Source:

polyline :PolylineGraphics

Gets or sets the polyline.
Type:
Source:

polylineVolume :PolylineVolumeGraphics

Gets or sets the polyline volume.
Type:
Source:

position :PositionProperty

Gets or sets the position.
Type:
Source:

propertyNames :Array

Gets the names of all properties registered on this instance.
Type:
  • Array
Source:

rectangle :RectangleGraphics

Gets or sets the rectangle.
Type:
Source:

show :Boolean

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.
Type:
  • Boolean
Source:

viewFrom :Property

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.
Type:
Source:

wall :WallGraphics

Gets or sets the wall.
Type:
Source:

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
Parameters:
Name Type Description
propertyName String The name of the property to add.
Source:
Throws:

isAvailable(time) → {Boolean}

Given a time, returns true if this object should have data during that time.
Parameters:
Name Type Description
time JulianDate The time to check availability for.
Source:
Returns:
true if the object should have data during the provided time, false otherwise.
Type
Boolean

merge(source)

Assigns each unassigned property on this object to the value of the same property on the provided source object.
Parameters:
Name Type Description
source Entity The object to be merged into this object.
Source:

removeProperty(propertyName)

Removed a property previously added with addProperty.
Parameters:
Name Type Description
propertyName String The name of the property to remove.
Source:
Throws: