czmlProperties
Defines a graphical vector that originates at the position property and extends in the provided direction for the provided length.
Defines a graphical vector that originates at the position property and extends in the provided direction for the provided length.
whether or not to show this property
of this property
The direction of the vector.
The graphical length of the vector.
The minimum graphical length of the vector in pixels.
represents time availability as a String or an array of strings
represents time availability as a String or an array of strings
the availability time value(s)
A billboard, or viewport-aligned image.
A billboard, or viewport-aligned image. The billboard is positioned in the scene by the position property. A billboard is sometimes called a marker.
This color value is multiplied with the values of the billboard's "image" to produce the final color.
The eye offset of the billboard, which is the offset in eye coordinates at which to place the billboard relative to the position property. Eye coordinates are a left-handed coordinate system where the X-axis points toward the viewer's right, the Y-axis points up, and the Z-axis points into the screen.
The horizontal origin of the billboard. It controls whether the billboard image is left-, center-, or right-aligned with the position.
The image displayed on the billboard, expressed as a URL. For broadest client compatibility, the URL should be accessible via Cross-Origin Resource Sharing (CORS). The URL may also be a data URI.
The offset, in viewport pixels, of the billboard origin from the position. A pixel offset is the number of pixels up and to the right to place the billboard, relative to the position.
The scale of the billboard. The scale is multiplied with the pixel size of the billboard's image. For example, if the scale is 2.0, the billboard will be rendered with twice the number of pixels, in each direction, of the image.
The rotation of the billboard offset from the alignedAxes.
whether or not to show this property
The vertical origin of the billboard. It controls whether the billboard image is bottom-, center-, or top-aligned with the position.
whether this billboard's size (width and height) should be measured in meters, otherwise size is measured in pixels
The aligned axis is the unit vector, in world coordinates, that the billboard up vector points towards. The default is the zero vector, which means the billboard is aligned to the screen up vector.
The width of the billboard, in pixels (or meters, if sizeInMeters is true). By default, the native width of the image is used
The height of the billboard, in pixels (or meters, if sizeInMeters is true). By default, the native height of the image is use
The height reference of the billboad, which indicates if the position is relative to terrain or not.
How the billboard's scale should change based on the billboard's distance from the camera. This scalar value will be multiplied by scale
How the billboard's translucency should change based on the billboard's distance from the camera. This scalar value should range from 0 to 1
How the billboard's pixel offset should change based on the billboard's distance from the camera. This scalar value will be multiplied by pixelOffset
A sub-region of the image which will be used for the billboard, rather than the entire image, measured in pixels from the bottom-left
A box, which is a closed rectangular cuboid
A box, which is a closed rectangular cuboid
A boolean Property specifying the visibility of the box.
The dimensions of the box
A Property specifying the material used to fill the box.
A boolean Property specifying whether the box is filled with the provided material.
A boolean Property specifying whether the box is outlined.
A Property specifying the Color of the outline.
A numeric Property specifying the width of the outline.
a CZML document contains a single JSON array where each object-literal element in the array is a CZML packet.
a CZML document contains a single JSON array where each object-literal element in the array is a CZML packet.
the list Packet of this document
A CZML packet describes the graphical properties for a single object in the scene, such as a single aircraft.
A CZML packet describes the graphical properties for a single object in the scene, such as a single aircraft.
The ID of the object described by this packet. IDs do not need to be GUIDs, but they do need to uniquely identify a single object within a CZML source and any other CZML sources loaded into the same scope. If this property is not specified, the client will automatically generate a unique one. However, this prevents later packets from referring to this object in order to, for example, add more data to it.
The name of the object. It does not have to be unique and is intended for user consumption.
The ID of the parent object or folder.
An HTML description of the object.
The CZML version being written. Only valid on the document object.
Whether the client should delete all existing data for this object, identified by ID. If true, all other properties in this packet will be ignored.
The set of properties of this object
The clock settings for the entire data set.
The clock settings for the entire data set. Only valid on the document object.
The current time.
The multiplier, which in TICK_DEPENDENT mode is the number of seconds to advance each tick. In SYSTEM_CLOCK_DEPENDENT mode, it is the multiplier applied to the amount of time elapsed between ticks. This value is ignored in SYSTEM_CLOCK mode.
The behavior of a clock when its current time reaches its start or end points. Valid values are 'UNBOUNDED', 'CLAMPED', and 'LOOP_STOP'.
Defines how a clock steps in time. Valid values are 'SYSTEM_CLOCK', 'SYSTEM_CLOCK_MULTIPLIER', and 'TICK_DEPENDENT'.
an interval of time.
A conical sensor volume taking into account occlusion of an ellipsoid, i.e., the globe.
A conical sensor volume taking into account occlusion of an ellipsoid, i.e., the globe.
whether or not to show this property
The inner half angle of the cone.
The outer half angle of the cone.
The minimum clock angle limit of the cone.
The maximum clock angle limit of the cone.
The radial limit of the cone.
Whether or not the intersection of the cone with the Earth is shown.
The color of the intersection of the cone with the Earth.
The width of the intersection in pixels.
Whether or not the intersections of the cone with the earth are shown.
Whether or not lateral surfaces are shown.
Whether or not ellipsoid surfaces are shown.
The material to use for the cone's ellipsoid surface.
Whether or not ellipsoid horizon surfaces are shown.
The material to use for the cone's ellipsoid horizon surface.
Whether or not dome surfaces are shown.
The material to use for the cone's dome.
Indicates what part of a sensor should be displayed.
A corridor, which is a shape defined by a centerline and width that conforms to the curvature of the globe.
A corridor, which is a shape defined by a centerline and width that conforms to the curvature of the globe. It can be placed on the surface or at altitude and can optionally be extruded into a volume
A boolean Property specifying the visibility of the corridor.
The array of positions defining the centerline of the corridor
The width of the corridor
A numeric Property specifying the height of the corridor.
A numeric Property specifying the altitude of the corridor extrusion.
The corner type of the corridor
A numeric Property specifying the angular distance between points on the corridor.
A Property specifying the material used to fill the corridor.
A boolean Property specifying whether the corridor is filled with the provided material.
A boolean Property specifying whether the corridor is outlined.
A Property specifying the Color of the outline.
A numeric Property specifying the width of the outline.
A custom sensor volume taking into account occlusion of an ellipsoid, i.e., the globe.
A custom sensor volume taking into account occlusion of an ellipsoid, i.e., the globe.
whether or not to show this property
The list of directions defining the pyramid.
The radial limit of the pyramid.
Whether or not the intersection of the pyramid with the Earth is shown.
The color of the intersection of the pyramid with the Earth.
The width of the intersection in pixels.
Whether or not the intersections of the pyramid with the earth are shown.
Whether or not lateral surfaces are shown.
Whether or not ellipsoid surfaces are shown.
The material to use for the pyramid's ellipsoid surface.
Whether or not ellipsoid horizon surfaces are shown.
The material to use for the pyramid's dome.
Indicates what part of a sensor should be displayed.
a CzmlProperty representing custom properties
a CzmlProperty representing custom properties
a map with key = the field name, and value = a CustomProperty
A cylinder
A cylinder
A boolean Property specifying the visibility of the cylinder.
The length of the cylinder
The top radius of the cylinder
The bottom radius of the cylinder
A Property specifying the material used to fill the cylinder.
A boolean Property specifying whether the cylinder is filled with the provided material.
A boolean Property specifying whether the cylinder is outlined.
A Property specifying the Color of the outline.
A numeric Property specifying the width of the outline.
Describes a 3d Cartesian property which can optionally vary over time.
Describes a 3d Cartesian property which can optionally vary over time. Can represent the dimensions of the ellipsoid radii. It is also used in NodeTransformation for scale and translation
The Cartesian [X, Y, Z] in meters. If the array has three elements, the cartesian is constant. If it has four or more elements, they are time-tagged samples arranged as [Time, X, Y, Z, Time, X, Y, Z, Time, X, Y, Z, ...], where Time is an ISO 8601 date and time string or seconds since epoch.
Time interval
A reference property.
the time interpolatable part of this property
An array of CzmlPosition.
An array of CzmlPosition. This CzmlPositions property is used only in CZMLPacket.
the array of CzmlPosition
all CzmlPacket constituent properties extend this trait (see also object CzmlProperty)
An ellipse, which is a closed curve on the surface of the Earth.
An ellipse, which is a closed curve on the surface of the Earth. The ellipse is positioned using the position property.
whether or not to show this property
The length of the ellipse's semi-major axis in meters.
The length of the ellipse's semi-minor axis in meters.
The angle from north (counter-clockwise) in radians.
The material to use to fill the ellipse.
The height of the ellipse when perPositionHeight is false.
The extruded height of the ellipse.
The sampling distance, in radians.
The rotation of any applied texture coordinates.
Whether or not the ellipse is filled.
Whether or not the ellipse is outlined.
The color of the ellipse outline.
The number of vertical lines to use when outlining an extruded ellipse.
An ellipsoid, which is a closed quadric surface that is a three dimensional analogue of an ellipse.
An ellipsoid, which is a closed quadric surface that is a three dimensional analogue of an ellipse. The ellipsoid is positioned and oriented using the position and orientation properties.
whether or not to show this property
The dimensions of the ellipsoid.
Whether or not the ellipsoid is filled.
The material to display on the surface of the ellipsoid.
Whether or not the ellipsoid is outlined.
The color of the ellipsoid outline.
The number of times to partition the ellipsoid into stacks.
The number of times to partition the ellipsoid into radial slices.
The number of points per outline line, determining the granularity of the curvature.
Defines a fan, which starts at a point or apex and extends in a specified list of directions from the apex.
Defines a fan, which starts at a point or apex and extends in a specified list of directions from the apex. Each pair of directions forms a face of the fan extending to the specified radius.
whether or not to show this property
The list of directions defining the fan.
The radial limit of the fan.
When true, the magnitude of each direction is used instead of a constant radius.
The material to display on the surface of the fan.
Whether or not the fan is filled.
Whether or not the fan is outlined.
The number of outline rings to draw, starting from the outer edge and equidistantly spaced towards the center.
The color of the fan outline.
A string of text.
A string of text. The label is positioned in the scene by the position property.
The eye offset of the label, which is the offset in eye coordinates at which to place the label relative to the position property. Eye coordinates are a left-handed coordinate system where the X-axis points toward the viewer's right, the Y-axis points up, and the Z-axis points into the screen.
The fill color of the label.
The font to use for the label.
The horizontal origin of the label. It controls whether the label is left-, center-, or right-aligned with the position.
The height reference of the label, which indicates if the position is relative to terrain or not.
The outline color of the label.
The outline width of the label.
The offset, in viewport pixels, of the label origin from the position. A pixel offset is the number of pixels up and to the right to place the label, relative to the position.
The scale of the label. The scale is multiplied with the pixel size of the label's text. For example, if the scale is 2.0, the label will be rendered with twice the number of pixels, in each direction, of the text.
whether or not to show this property
The style of the label.
The text displayed by the label.
The vertical origin of the label. It controls whether the label image is bottom-, center-, or top-aligned with the position.
A 3D model.
A 3D model. The model is positioned and oriented using the position and orientation properties.
whether or not to show this property
The scale of the property.
The approximate minimum pixel size of the model regardless of zoom.
The URL of a glTF model.
Whether or not the model can be rendered before all textures have loaded
Whether or not to run animations.
The height reference of the model, which indicates if the position is relative to terrain or not.
node transformations.
The orientation of the object in the world.
The orientation of the object in the world. The orientation has no direct visual representation, but it is used to orient models, cones, and pyramids attached to the object.
The orientation specified as a 4-dimensional unit magnitude quaternion, specified as [X, Y, Z, W]
an interval
A reference property.
the time interpolatable part of this property
Characterises a packet in the CZML document.
A path, which is a polyline defined by the motion of an object over time.
A path, which is a polyline defined by the motion of an object over time. The possible vertices of the path are specified by the position property.
whether or not to show this property
The material to use to draw the path.
The width of the path line.
The maximum step-size, in seconds, used to sample the path. If the position property has data points farther apart than resolution specfies, additional steps will be taken, creating a smoother path.
The time ahead of the animation time, in seconds, to show the path.
The time behind the animation time, in seconds, to show the path.
A point, or viewport-aligned circle.
A point, or viewport-aligned circle. The point is positioned in the scene by the position property.
of the point.
The color of the outline of the point.
The width of the outline of the point.
The size of the point, in pixels.
whether or not to show this property
The height reference of the point, which indicates if the position is relative to terrain or not.
A polygon, which is a closed shape on the surface of the Earth.
A polygon, which is a closed shape on the surface of the Earth.
The array of positions defining a simple polygon.
whether or not to show this property
The material to use to fill the polygon.
The height of the polygon when perPositionHeight is false.
The extruded height of the polygon.
The sampling distance, in radians.
The rotation of any applied texture.
Whether or not the polygon is filled.
Whether or not the polygon is outlined.
The color of the polygon outline.
Whether to use the height of each position to define the polygon or a constant height above the surface.
A polyline, which is a line in the scene composed of multiple segments.
A polyline, which is a line in the scene composed of multiple segments.
The array of positions defining the polyline as a line strip.
whether or not to show this property
The material to use to draw the polyline.
The width of the polyline.
The sampling distance, in radians
Whether or not the positions are connected as great arcs (the default) or as straight lines.
The rectangle conforms to the curvature of the globe and can be placed on the surface or at altitude and can optionally be extruded into a volume.
The rectangle conforms to the curvature of the globe and can be placed on the surface or at altitude and can optionally be extruded into a volume.
the coordinate of the rectangle in WsenDegrees
A boolean Property specifying the visibility of the rectangle.
A Property specifying the material used to fill the rectangle.
A numeric Property specifying the altitude of the rectangle.
A numeric Property specifying the altitude of the rectangle extrusion.
A numeric Property specifying the angular distance between points on the rectangle.
A numeric property specifying the rotation of the rectangle clockwise from north.
A numeric property specifying the rotation of the rectangle texture counter-clockwise from north.
A boolean Property specifying whether the rectangle is filled with the provided material.
A boolean Property specifying whether the rectangle is outlined.
A Property specifying the Color of the outline.
A numeric Property specifying the width of the outline.
A boolean Property specifying whether the rectangle has a bottom cover when extruded.
A boolean Property specifying whether the rectangle has a top cover when extruded
A rectangular pyramid sensor volume taking into account occlusion of an ellipsoid, i.e., the globe.
A rectangular pyramid sensor volume taking into account occlusion of an ellipsoid, i.e., the globe.
whether or not to show this property
The X half angle.
The Y half angle.
The radial limit of the pyramid.
Whether or not the intersection of the pyramid with the Earth is shown.
The color of the intersection of the pyramid with the Earth.
The width of the intersection in pixels.
Whether or not the intersections of the pyramid with the earth are shown.
the lateral Surface Material
Whether or not ellipsoid surfaces are shown.
The material to use for the pyramid's ellipsoid surface.
Whether or not ellipsoid horizon surfaces are shown.
The material to use for the pyramid's ellipsoid horizon surface.
Whether or not dome surfaces are shown.
The material to use for the pyramid's dome.
Indicates what part of a sensor should be displayed.
A suggested camera location when viewing an object, specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
A suggested camera location when viewing an object, specified as a Cartesian position in the East (x), North (y), Up (z) reference frame relative to the object's position.
The Cartesian [X, Y, Z] in meters. If the array has three elements, the cartesian is constant. If it has four or more elements, they are time-tagged samples arranged as [Time, X, Y, Z, Time, X, Y, Z, Time, X, Y, Z, ...], where Time is an ISO 8601 date and time string or seconds since epoch.
A reference property.
the time interpolatable part of this property
Describes a two dimensional wall defined as a line strip and optional maximum and minimum heights.
Describes a two dimensional wall defined as a line strip and optional maximum and minimum heights. The wall conforms to the curvature of the globe and can be placed along the surface or at altitude.
A Property specifying the array of Cartesian3 positions which define the top of the wall.
A boolean Property specifying the visibility of the wall.
A Property specifying the material used to fill the wall.
A Property specifying an array of heights to be used for the bottom of the wall instead of the globe surface.
A Property specifying an array of heights to be used for the top of the wall instead of the height of each position.
A numeric Property specifying the angular distance between each latitude and longitude point.
A boolean Property specifying whether the wall is filled with the provided material.
A boolean Property specifying whether the wall is outlined.
A Property specifying the Color of the outline.
A numeric Property specifying the width of the outline.
a CzmlProperty
The Cesium CZML language as described in the following references:
https://github.com/AnalyticalGraphicsInc/cesium/wiki/CZML-Structure https://github.com/AnalyticalGraphicsInc/cesium/wiki/CZML-Content https://github.com/AnalyticalGraphicsInc/cesium/wiki/CZML-Guide
CZML is a JSON schema for describing a time-dynamic graphical scene, primarily for display in a web browser running Cesium. It describes lines, points, billboards (markers), models and other graphical primitives, and specifies how they change with time.
This package implements the CZML object as a list of CZMLPacket, the CZMLPacket object and all its constituent czml properties.