Skip to main content

Label

Lavbel is a label primitive in the LabelCollection.

Primitive is a low layer API for geographical visualization. Entity is more recommended unless performance issues.

Availability

Only inside LabelCollection component. A label object will be attached to the parent LabelCollection.

Properties

Cesium properties

PropertyTypeDescription
disableDepthTestDistancenumber
distanceDisplayConditionDistanceDisplayCondition
eyeOffsetCartesian3
heightReferenceHeightReference
horizontalOriginHorizontalOrigin
pixelOffsetCartesian2
pixelOffsetScaleByDistanceNearFarScalar
positionCartesian3
scalenumber
scaleByDistanceNearFarScalar
showboolean
translucencyByDistanceNearFarScalar
verticalOriginVerticalOrigin
outlineColorColor
outlineWidthnumber
styleLabelStyle
backgroundColorColor
backgroundPaddingCartesian2
fillColorColor
fontstring
showBackgroundboolean
textstring

Cesium read-only properties

N/A

Cesium events

N/A

Other properties

PropertyTypeDescription
onClick(movement: CesiumMovementEvent, target: T) => void
onDoubleClick(movement: CesiumMovementEvent, target: T) => void
onMouseDown(movement: CesiumMovementEvent, target: T) => void
onMouseUp(movement: CesiumMovementEvent, target: T) => void
onMiddleClick(movement: CesiumMovementEvent, target: T) => void
onMiddleDown(movement: CesiumMovementEvent, target: T) => void
onMiddleUp(movement: CesiumMovementEvent, target: T) => void
onMouseMove(movement: CesiumMovementEvent, target: T) => void
onPinchEnd(movement: CesiumMovementEvent, target: T) => void
onPinchMove(movement: CesiumMovementEvent, target: T) => void
onPinchStart(movement: CesiumMovementEvent, target: T) => void
onRightClick(movement: CesiumMovementEvent, target: T) => void
onRightDown(movement: CesiumMovementEvent, target: T) => void
onRightUp(movement: CesiumMovementEvent, target: T) => void
onMouseEnter(movement: CesiumMovementEvent, target: T) => void
onMouseLeave(movement: CesiumMovementEvent, target: T) => void