CZML Custom Properties
- "properties":
{ "<propertyName>": { "number": <value> } } — a top-level packet property (a
sibling of "position"/"polygon"/etc., not nested inside a graphics property) holding arbitrary
named data on an entity. Wrap the value by its type: { "number": <value> } for numeric data,
{ "string": "<value>" } for text, { "boolean": true|false } for flags.
- For a value that changes over time, use either:
- The same "epoch" + interleaved-timestamp-and-value pattern as any other sampled property:
{ "epoch": "<ISO8601>", "population": [t0, v0, t1, v1, ...] }, or
- An array of interval-scoped values, each with its own "interval":
"population": [{ "interval": "<ISO8601 start>/<ISO8601 end>", "number": 1000 }, { "interval": "<next start>/<next end>", "number": 2000 }].
This same interval-array pattern also works for any other property (e.g. "position") when an
entity's full timeline needs to be built incrementally from several non-overlapping segments,
as if streamed across separate CZML packets.
Example: a time-varying custom property alongside a polygon entity
[
{ "id": "document", "name": "Custom properties", "version": "1.0" },
{
"id": "region-1",
"properties": {
"epoch": "2026-01-01T00:00:00Z",
"population": [0, 10000, 3600, 12000, 7200, 15000]
},
"polygon": {
"positions": {
"cartographicDegrees": [-90, 30, 0, -89.9, 30, 0, -89.9, 30.1, 0, -90, 30.1, 0]
},
"extrudedHeight": 15000,
"material": { "solidColor": { "color": { "rgba": [0, 128, 255, 150] } } }
}
}
]
1---2name: czml-custom-properties3description: CZML custom/arbitrary entity properties for domain-specific data like population, fuel level, or sensor readings that aren't a standard graphics property, optionally time-varying or split across multiple sequential packets. Use when the intent describes a custom property, custom data field, or a named value attached to an entity that isn't a standard CZML graphics property.4---56# CZML Custom Properties78- "properties": `{ "<propertyName>": { "number": <value> } }` — a top-level packet property (a9 sibling of "position"/"polygon"/etc., not nested inside a graphics property) holding arbitrary10 named data on an entity. Wrap the value by its type: `{ "number": <value> }` for numeric data,11 `{ "string": "<value>" }` for text, `{ "boolean": true|false }` for flags.12- For a value that changes over time, use either:13 - The same "epoch" + interleaved-timestamp-and-value pattern as any other sampled property:14 `{ "epoch": "<ISO8601>", "population": [t0, v0, t1, v1, ...] }`, or15 - An array of interval-scoped values, each with its own "interval":16 `"population": [{ "interval": "<ISO8601 start>/<ISO8601 end>", "number": 1000 }, { "interval": "<next start>/<next end>", "number": 2000 }]`.17 This same interval-array pattern also works for any other property (e.g. "position") when an18 entity's full timeline needs to be built incrementally from several non-overlapping segments,19 as if streamed across separate CZML packets.2021## Example: a time-varying custom property alongside a polygon entity2223```json24[25 { "id": "document", "name": "Custom properties", "version": "1.0" },26 {27 "id": "region-1",28 "properties": {29 "epoch": "2026-01-01T00:00:00Z",30 "population": [0, 10000, 3600, 12000, 7200, 15000]31 },32 "polygon": {33 "positions": {34 "cartographicDegrees": [-90, 30, 0, -89.9, 30, 0, -89.9, 30.1, 0, -90, 30.1, 0]35 },36 "extrudedHeight": 15000,37 "material": { "solidColor": { "color": { "rgba": [0, 128, 255, 150] } } }38 }39 }40]41```
CesiumGS