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.
| Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
Object with the following properties:
|
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.
-
billboard : BillboardGraphics
-
Gets or sets the billboard.
-
Gets or sets the box.
-
corridor : CorridorGraphics
-
Gets or sets the corridor.
-
cylinder : CylinderGraphics
-
Gets or sets the cylinder.
-
readonlydefinitionChanged : Event
-
Gets the event that is raised whenever a property or sub-property is changed or modified.
-
description : Property
-
Gets or sets the description.
-
ellipse : EllipseGraphics
-
Gets or sets the ellipse.
-
ellipsoid : EllipsoidGraphics
-
Gets or sets the ellipsoid.
-
entityCollection : EntityCollection
-
Gets or sets the entity collection that this entity belongs to.
-
Gets the unique ID associated with this object.
-
Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.
-
Gets or sets the label.
-
Gets or sets the model.
-
Gets or sets the name of the object. The name is intended for end-user consumption and does not need to be unique.
-
orientation : Property
-
Gets or sets the orientation.
-
parent : Entity
-
Gets or sets the parent object.
-
Gets or sets the path.
-
Gets or sets the point graphic.
-
polygon : PolygonGraphics
-
Gets or sets the polygon.
-
polyline : PolylineGraphics
-
Gets or sets the polyline.
-
polylineVolume : PolylineVolumeGraphics
-
Gets or sets the polyline volume.
-
position : PositionProperty
-
Gets or sets the position.
-
Gets the names of all properties registered on this instance.
-
rectangle : RectangleGraphics
-
Gets or sets the rectangle.
-
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.
-
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.
-
Gets or sets the wall.
Methods
-
Adds a property to this object. Once a property is added, it can be observed with
Entity#definitionChangedand composited withCompositeEntityCollectionName Type Description propertyNameString The name of the property to add. Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is already a registered property.
-
-
Given a time, returns true if this object should have data during that time.
Name Type Description timeJulianDate The time to check availability for. Returns:
true if the object should have data during the provided time, false otherwise. -
Assigns each unassigned property on this object to the value of the same property on the provided source object.
Name Type Description sourceEntity The object to be merged into this object. -
Removed a property previously added with addProperty.
Name Type Description propertyNameString The name of the property to remove. Throws:
-
DeveloperError : "propertyName" is a reserved property name.
-
DeveloperError : "propertyName" is not a registered property.
-