Entity

Entity is a basic component for geographical data visualization.

Entity can have one each, with the following components as children:

EntityDescription: renders description with React
BillboardGraphics: a billboard visualization
BoxGraphics: a box visualization
CorridorGraphics: a corridor visualization
CylinderGraphics: a cylinder visualization
EllipseGraphics: a ellipse visualization
EllipsoidGraphics: a ellipsoid visualization
LabelGraphics: a label visualization
ModelGraphics: a model visualization
PathGraphics: a path visualization
PlaneGraphics: a plane visualization
PointGraphics: a point visualization
PolygonGraphics: a polygon visualization
PolylineGraphics: a polyline visualization
PolylineVolumeGraphics: a polyline visualization with volume
RectangleGraphics: a rectangle visualization
WallGraphics: a wall visualization

Graphics components vs graphics properties

Conclusion: Graphics components are mostly recommended.

For example, Entity component has point property for point visualization. But PointGraphics component is also available. What is the differene?

<Entity point={{ pixelSize: 10 }} />

<Entity>
  <BillboardGraphics pixelSize={10} />
</Entity>

That is same. However as changing only pixelSize property, situations will change. If you change point property, It happens recreating a PointGraphics object. It is equivalent to:

const entity = new Entity({ point: { pixelSize: 10 } });

// change pixelSize property in point property of Entity
entity.point = new PointGraphics({ pixelSize: 20 });
// change pixelSize property of PointGraphics
entity.point.pixelSize = 20;

Updating pixelSize of PointGraphics is more simple and fast.

Cesium element: Entity
Example: Entity

Availability

Either:

Inside Viewer or CesiumWidget component: the entity will be attached to the EntityCollection of the Viewer or CesiumWidget.
Inside CustomDataSource component: the entity will be attached to the EntityCollection of the CustomDataSource.

Properties

Cesium properties

Property	Type	Description
position	Cartesian3 \| PositionProperty \| CallbackPositionProperty \| undefined
show	boolean \| undefined
orientation	Property \| Quaternion \| undefined
properties	PropertyBag \| { [key: string]: any; } \| undefined
ellipsoid	EllipsoidGraphics \| ConstructorOptions \| undefined
name	string \| undefined
entityCollection	EntityCollection
availability	TimeIntervalCollection \| undefined
trackingReferenceFrame	TrackingReferenceFrame \| undefined
parent	Entity \| undefined
billboard	BillboardGraphics \| ConstructorOptions \| undefined
box	BoxGraphics \| ConstructorOptions \| undefined
corridor	CorridorGraphics \| ConstructorOptions \| undefined
cylinder	CylinderGraphics \| ConstructorOptions \| undefined
description	string \| Property \| undefined
ellipse	EllipseGraphics \| ConstructorOptions \| undefined
label	LabelGraphics \| ConstructorOptions \| undefined
model	ModelGraphics \| ConstructorOptions \| undefined
tileset	Cesium3DTilesetGraphics \| ConstructorOptions \| undefined
path	PathGraphics \| ConstructorOptions \| undefined
plane	PlaneGraphics \| ConstructorOptions \| undefined
point	PointGraphics \| ConstructorOptions \| undefined
polygon	PolygonGraphics \| ConstructorOptions \| undefined
polyline	PolylineGraphics \| ConstructorOptions \| undefined
polylineVolume	PolylineVolumeGraphics \| ConstructorOptions \| undefined
rectangle	RectangleGraphics \| ConstructorOptions \| undefined
viewFrom	Cartesian3 \| Property \| undefined
wall	WallGraphics \| ConstructorOptions \| undefined

Cesium read-only properties

Property	Type	Description
id	string

Cesium events

Property	Type	Description
onDefinitionChange	(() => void) \| undefined

Other properties

N/A