Entity - Cesium Documentation

# Entity

#### 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:

  Name | Type | 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.
  `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.

  ##### See:

  - Visualizing Special Data
  Source: DataSources/Entity.js, line 117

### 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 203

#### billboard :BillboardGraphics

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

#### box :BoxGraphics

  Gets or sets the box.
  Source: DataSources/Entity.js, line 331

#### corridor :CorridorGraphics

  Gets or sets the corridor.
  Source: DataSources/Entity.js, line 337

#### cylinder :CylinderGraphics

  Gets or sets the cylinder.
  Source: DataSources/Entity.js, line 343

#### readonlydefinitionChanged :Event

  Gets the event that is raised whenever a property or sub-property is changed or modified.
  Source: DataSources/Entity.js, line 221

#### description :Property

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

#### ellipse :EllipseGraphics

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

#### ellipsoid :EllipsoidGraphics

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

#### id :String

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

#### isShowing :Boolean

  Gets whether this entity is being displayed, taking into account the visibility of any ancestor entities.
  Source: DataSources/Entity.js, line 271

#### label :LabelGraphics

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

#### model :ModelGraphics

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

#### 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 232

#### orientation :Property

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

#### parent :Entity

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

#### path :PathGraphics

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

#### point :PointGraphics

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

#### polygon :PolygonGraphics

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

#### polyline :PolylineGraphics

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

#### polylineVolume :PolylineVolumeGraphics

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

#### position :PositionProperty

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

#### propertyNames :Event

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

#### rectangle :RectangleGraphics

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

#### 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 239

#### 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 428

#### wall :WallGraphics

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

### 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:

  - DeveloperError : "propertyName" is a reserved property name.
  - DeveloperError : "propertyName" is already a registered property.
  Source: DataSources/Entity.js, line 464

#### 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 443

#### 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 513

#### 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 491