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
Section titled “Availability”Only inside LabelCollection component. A label object will be attached to the parent LabelCollection.
Properties
Section titled “Properties”Cesium properties
Section titled “Cesium properties”| Property | Type | Description |
|---|---|---|
| position | Cartesian3 | |
| disableDepthTestDistance | number | undefined | |
| distanceDisplayCondition | DistanceDisplayCondition | |
| eyeOffset | Cartesian3 | |
| heightReference | HeightReference | |
| horizontalOrigin | HorizontalOrigin | |
| pixelOffset | Cartesian2 | |
| pixelOffsetScaleByDistance | NearFarScalar | |
| scale | number | |
| scaleByDistance | NearFarScalar | |
| show | boolean | |
| translucencyByDistance | NearFarScalar | |
| verticalOrigin | VerticalOrigin | |
| id | any | |
| outlineColor | Color | |
| outlineWidth | number | |
| style | LabelStyle | |
| backgroundColor | Color | |
| backgroundPadding | Cartesian2 | |
| fillColor | Color | |
| font | string | |
| showBackground | boolean | |
| text | string |
Cesium read-only properties
Section titled “Cesium read-only properties”N/A
Cesium events
Section titled “Cesium events”N/A
Other properties
Section titled “Other properties”| Property | Type | Description |
|---|---|---|
| onClick | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onDoubleClick | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMouseDown | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMouseUp | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMiddleClick | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMiddleDown | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMiddleUp | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMouseMove | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onPinchEnd | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onPinchMove | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onPinchStart | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onRightClick | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onRightDown | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onRightUp | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMouseEnter | ((movement: CesiumMovementEvent, target: T) => void) | undefined | |
| onMouseLeave | ((movement: CesiumMovementEvent, target: T) => void) | undefined |