new Entity(options)
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:
|
See:
Source:
DataSources/Entity.js, line 118
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 204
-
billboard :BillboardGraphics
-
Gets or sets the billboard.Source: DataSources/Entity.js, line 326
-
box :BoxGraphics
-
Gets or sets the box.Source: DataSources/Entity.js, line 332
-
corridor :CorridorGraphics
-
Gets or sets the corridor.Source: DataSources/Entity.js, line 338
-
cylinder :CylinderGraphics
-
Gets or sets the cylinder.Source: DataSources/Entity.js, line 344
-
readonlydefinitionChanged :Event
-
Gets the event that is raised whenever a property or sub-property is changed or modified.Source: DataSources/Entity.js, line 222
-
description :Property
-
Gets or sets the description.Source: DataSources/Entity.js, line 350
-
ellipse :EllipseGraphics
-
Gets or sets the ellipse.Source: DataSources/Entity.js, line 356
-
ellipsoid :EllipsoidGraphics
-
Gets or sets the ellipsoid.Source: DataSources/Entity.js, line 362
-
id :String
-
Gets the unique ID associated with this object.Source: DataSources/Entity.js, line 210
-
isShowing :Boolean
-
Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.Source: DataSources/Entity.js, line 272
-
label :LabelGraphics
-
Gets or sets the label.Source: DataSources/Entity.js, line 368
-
model :ModelGraphics
-
Gets or sets the model.Source: DataSources/Entity.js, line 374
-
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 233
-
orientation :Property
-
Gets or sets the orientation.Source: DataSources/Entity.js, line 380
-
parent :Entity
-
Gets or sets the parent object.Source: DataSources/Entity.js, line 282
-
path :PathGraphics
-
Gets or sets the path.Source: DataSources/Entity.js, line 386
-
point :PointGraphics
-
Gets or sets the point graphic.Source: DataSources/Entity.js, line 392
-
polygon :PolygonGraphics
-
Gets or sets the polygon.Source: DataSources/Entity.js, line 398
-
polyline :PolylineGraphics
-
Gets or sets the polyline.Source: DataSources/Entity.js, line 404
-
polylineVolume :PolylineVolumeGraphics
-
Gets or sets the polyline volume.Source: DataSources/Entity.js, line 410
-
position :PositionProperty
-
Gets or sets the position.Source: DataSources/Entity.js, line 416
-
propertyNames :Event
-
Gets the names of all properties registered on this instance.Source: DataSources/Entity.js, line 316
-
rectangle :RectangleGraphics
-
Gets or sets the rectangle.Source: DataSources/Entity.js, line 422
-
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.Source: DataSources/Entity.js, line 240
-
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.Source: DataSources/Entity.js, line 429
-
wall :WallGraphics
-
Gets or sets the wall.Source: DataSources/Entity.js, line 435
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 465 -
-
isAvailable(time) → Boolean
-
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 444 -
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 514 -
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 492 -