Skip to content

Properties

Time-dynamic and constant property types. Attach them to entity graphics to animate values over time (see the time-dynamic example).

import cesiumkit

position = cesiumkit.SampledPositionProperty()
position.add_sample(
    cesiumkit.JulianDate.from_iso8601("2026-07-14T18:00:00Z"),
    cesiumkit.Cartesian3.from_degrees(0, 0, 400000),
)
position.add_sample(
    cesiumkit.JulianDate.from_iso8601("2026-07-14T18:05:00Z"),
    cesiumkit.Cartesian3.from_degrees(10, 10, 400000),
)

viewer = cesiumkit.Viewer()
viewer.add_entity(cesiumkit.Entity(name="Satellite", position=position))

properties

Property system for time-dynamic values in cesiumkit.

Classes:

Name Description
PropertyBase

Base for the Cesium Property system.

ConstantProperty

Wraps a constant value as a property.

SampledProperty

A property with time-tagged samples and interpolation.

SampledPositionProperty

A SampledProperty specialized for Cartesian3 positions.

TimeIntervalCollectionProperty

Property defined over time intervals.

CallbackProperty

Property defined by a JS callback function.

ReferenceProperty

Property that references another entity's property.

PropertyBase

Bases: CesiumBase

Base for the Cesium Property system.

ConstantProperty

Bases: PropertyBase

Wraps a constant value as a property.

SampledProperty

Bases: PropertyBase

A property with time-tagged samples and interpolation.

Methods:

Name Description
add_sample

Add a time-value sample.

add_samples

Add multiple samples at once.

add_sample

add_sample(time: str | Any, value: Any) -> None

Add a time-value sample.

Parameters:

Name Type Description Default
time str | Any

ISO 8601 string or JulianDate

required
value Any

The value at this time

required

add_samples

add_samples(times: list, values: list) -> None

Add multiple samples at once.

SampledPositionProperty

Bases: PropertyBase

A SampledProperty specialized for Cartesian3 positions.

Methods:

Name Description
add_sample

Add a time-position sample.

add_samples

Add multiple samples at once.

to_czml

Export as CZML position with time-tagged samples.

add_sample

add_sample(time: str | Any, position: Any) -> None

Add a time-position sample.

Parameters:

Name Type Description Default
time str | Any

ISO 8601 string or JulianDate

required
position Any

Cartesian3 or Cartesian3FromDegrees

required

add_samples

add_samples(times: list, positions: list) -> None

Add multiple samples at once.

to_czml

to_czml() -> dict

Export as CZML position with time-tagged samples.

TimeIntervalCollectionProperty

Bases: PropertyBase

Property defined over time intervals.

Methods:

Name Description
add_interval

Add a time interval with associated data.

add_interval

add_interval(start: str, stop: str, data: Any) -> None

Add a time interval with associated data.

CallbackProperty

Bases: PropertyBase

Property defined by a JS callback function.

Wrap callbacks in :class:JsCode. Raw strings remain accepted through 1.x for compatibility with 0.x and emit a project deprecation warning.

ReferenceProperty

Bases: PropertyBase

Property that references another entity's property.