Skip to content
Resium Resium

Entity

Entity is a basic component for geographical data visualization.

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

Graphics components vs graphics properties

Section titled “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.

Availability

Section titled “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

Section titled “Properties”

Cesium properties

Section titled “Cesium properties”
PropertyTypeDescription
positionCartesian3 | PositionProperty | CallbackPositionProperty | undefined
showboolean | undefined
orientationProperty | Quaternion | undefined
propertiesPropertyBag | { [key: string]: any; } | undefined
ellipsoidEllipsoidGraphics | ConstructorOptions | undefined
namestring | undefined
entityCollectionEntityCollection
availabilityTimeIntervalCollection | undefined
trackingReferenceFrameTrackingReferenceFrame | undefined
parentEntity | undefined
billboardBillboardGraphics | ConstructorOptions | undefined
boxBoxGraphics | ConstructorOptions | undefined
corridorCorridorGraphics | ConstructorOptions | undefined
cylinderCylinderGraphics | ConstructorOptions | undefined
descriptionstring | Property | undefined
ellipseEllipseGraphics | ConstructorOptions | undefined
labelLabelGraphics | ConstructorOptions | undefined
modelModelGraphics | ConstructorOptions | undefined
tilesetCesium3DTilesetGraphics | ConstructorOptions | undefined
pathPathGraphics | ConstructorOptions | undefined
planePlaneGraphics | ConstructorOptions | undefined
pointPointGraphics | ConstructorOptions | undefined
polygonPolygonGraphics | ConstructorOptions | undefined
polylinePolylineGraphics | ConstructorOptions | undefined
polylineVolumePolylineVolumeGraphics | ConstructorOptions | undefined
rectangleRectangleGraphics | ConstructorOptions | undefined
viewFromCartesian3 | Property | undefined
wallWallGraphics | ConstructorOptions | undefined

Cesium read-only properties

Section titled “Cesium read-only properties”
PropertyTypeDescription
idstring

Cesium events

Section titled “Cesium events”
PropertyTypeDescription
onDefinitionChange(() => void) | undefined

Other properties

Section titled “Other properties”

N/A