KmlDataSource

KmlDataSource provides the way to load and show KML data into the scene. Both KML and KMZ are supported, and can be loaded from a URL, string or raw object.

• Cesium element: KmlDataSource
• Example: KmlDataSource

Availability

Inside Viewer or CesiumWidget components.

Properties

Cesium properties

Property	Type	Description
show	boolean
clustering	EntityCluster
name	string

Cesium read-only properties

Property	Type	Description
ellipsoid	Ellipsoid
canvas	HTMLCanvasElement
camera	Camera
credit	Credit
sourceUri	string
clampToGround	boolean
screenOverlayContainer	string | Element

Cesium events

Property	Type	Description
onChange	(kmlDataSource: KmlDataSource) => void
onError	(kmlDataSource: KmlDataSource, error: any) => void
onLoading	(kmlDataSource: KmlDataSource, isLoaded: boolean) => void
onRefresh	(kmlDataSource: KmlDataSource, urlComponent: string) => void
onUnsupportedNode	(kmlDataSource: KmlDataSource) => void

Other properties

Property	Type	Description
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
onLoad	(kmlDataSouce: KmlDataSource) => void	Calls when the Promise for loading data is fullfilled.
data	string | Resource | Document | Blob