Package-level declarations
Types
Metadata for one stored anchor point using direct storage.
Metadata for one stored anchor point.
A function used to compute the local animation time for a ModelAnimation.
An appearance defines the full GLSL vertex and fragment shaders and the render state used to draw a Primitive. All appearances implement this base Appearance interface.
ArcGisBaseMapType enumerates the ArcGIS image tile layers that are supported by default.
Default options for accessing the ArcGIS image tile service.
A collection of key-value pairs that is stored as a hash for easy lookup but also provides an array for fast iteration.
Common atmosphere settings used by 3D Tiles and models for rendering sky atmosphere, ground atmosphere, and fog.
Creates an instance of an AxisAlignedBoundingBox from the minimum and maximum points along the x, y, and z axes.
A renderable collection of billboards. Billboards are viewport-aligned images positioned in the 3D scene.
Describes a two dimensional icon located at the position of the containing Entity.
A Visualizer which maps Entity.billboard to a Billboard.
A function used to compare two items while performing a binary search.
Provides geocoding through Bing Maps.
The types of imagery provided by Bing Maps.
Determines how two pixels' values are combined.
Determines how blending factors are computed.
The blending state combines BlendEquation and BlendFunction and the enabled flag to define the full blending state for combining source and destination fragments when rendering.
Determines how opaque and translucent parts of billboards, points, and labels are blended with the scene.
A bounding rectangle given by a corner, width and height.
A bounding sphere with a center and a radius.
A ParticleEmitter that emits particles within a box. Particles will be positioned randomly within the box and have initial velocities emanating from the center of the box.
Describes a cube centered at the origin.
A GeometryUpdater for boxes. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes a box. The center position and orientation are determined by the containing Entity.
A description of the outline of a cube centered at the origin.
A function that returns the value of the position property.
A PositionProperty whose value is lazily evaluated by a callback function.
A Property whose value is lazily evaluated by a callback function.
A function that returns the value of the property.
Aggregates input events. For example, suppose the following inputs are received between frames: left mouse button down, mouse move, mouse move, left mouse button up. These events will be aggregated into one event with a start and end position of the mouse.
Enumerates the available input for interacting with the camera.
The function that is called when the request is cancelled.
A 2D Cartesian point.
A 3D Cartesian point.
A 4D Cartesian point.
A position defined by longitude, latitude, and height.
Geocodes queries containing longitude and latitude coordinates and an optional height. Query format: longitude latitude (height) with longitude/latitude in degrees and height in meters.
A Catmull-Rom spline is a cubic spline where the tangent at control points, except the first and last, are computed using the previous and next control points. Catmull-Rom splines are in the class C1.
A tile in a Cesium3DTileset. When a tile is first created, its content is not loaded; the content is loaded on-demand when needed based on the view.
Defines how per-feature colors set from the Cesium API or declarative styling blend with the source colors from the original feature, e.g. glTF material or per-point color in the tile.
The content of a tile in a Cesium3DTileset.
A feature of a Cesium3DTileset.
A point feature of a Cesium3DTileset.
A 3D Tiles tileset, used for streaming massive heterogeneous 3D geospatial datasets.
A 3D Tiles tileset represented by an Entity. The tileset modelMatrix is determined by the containing Entity position and orientation or is left unset if position is undefined.
A Visualizer which maps Entity.tileset to a Cesium3DTileset.
A style that is applied to a Cesium3DTileset.
A VoxelProvider that fetches voxel data from a 3D Tiles tileset.
A widget containing a Cesium scene.
A MaterialProperty that maps to checkerboard Material uniforms.
A ParticleEmitter that emits particles from a circle. Particles will be positioned within a circle and have initial velocities going along the z vector.
A description of a circle on the ellipsoid. Circle geometry can be rendered with both Primitive and GroundPrimitive.
A description of the outline of a circle on the ellipsoid.
A classification primitive represents a volume enclosing geometry in the Scene to be highlighted.
Whether a classification affects terrain, 3D Tiles or both.
A Plane in Hessian Normal form to be used with ClippingPlaneCollection. Compatible with mathematics functions in Plane
Specifies a set of clipping planes. Clipping planes selectively disable rendering in a region on the outside of the specified list of ClippingPlane objects for a single gltf model, 3D Tileset, or the globe.
A geodesic polygon to be used with ClippingPlaneCollection for selectively hiding regions in a model, a 3D tileset, or the globe.
Specifies a set of clipping polygons. Clipping polygons selectively disable rendering in a region inside or outside the specified list of ClippingPolygon objects for a single glTF model, 3D Tileset, or the globe.
Constants used by Clock.tick to determine behavior when Clock.startTime or Clock.stopTime is reached.
Constants to determine how much time advances with each call to Clock.tick.
A renderable collection of clouds in the 3D scene.
Specifies the type of the cloud that is added to a CloudCollection in CloudCollection.add.
The signature of the event generated by EntityCollection.collectionChanged.
Defines different modes for blending between a target color and a primitive's source color.
Value and type information for per-instance geometry color.
A MaterialProperty that maps to solid color Material uniforms.
A function used to compare two items while sorting a queue.
WebGL component datatypes. Components are intrinsics, which form attributes, which form vertices.
Non-destructively composites multiple EntityCollection instances into a single collection. If a Entity with the same ID exists in multiple collections, it is non-destructively merged into a single new entity instance. If an entity has the same property in multiple collections, the property of the Entity in the last collection of the list it belongs to is used. CompositeEntityCollection can be used almost anywhere that a EntityCollection is used.
A CompositeProperty which is also a MaterialProperty.
A CompositeProperty which is also a PositionProperty.
A Property which is defined by a TimeIntervalCollection, where the data property of each TimeInterval is another Property instance which is evaluated at the provided time.
Describes a compressed texture and contains a compressed texture buffer.
An expression for a style applied to a Cesium3DTileset.
A ParticleEmitter that emits particles within a cone. Particles will be positioned at the tip of the cone and have initial velocities going towards the base.
A PositionProperty whose value does not change in respect to the ReferenceFrame in which is it defined.
A Property whose value does not change with respect to simulation time.
A spline that evaluates to a constant value. Although this follows the Spline interface, it does not maintain an internal array of times since its value never changes.
Options to control the setting up of a WebGL Context.
A description of a polygon composed of arbitrary coplanar positions.
A description of the outline of a polygon composed of arbitrary coplanar positions.
Style options for corners.
Metadata identifying parameters using same correlation modeling and associated correlation parameters.
A description of a corridor. Corridor geometry can be rendered with both Primitive and GroundPrimitive.
A GeometryUpdater for corridors. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes 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 description of a corridor outline.
A function that creates an image.
The credit display is responsible for displaying credits on screen.
Defines functions for 3rd order polynomial functions of one variable with only real coefficients.
The culling volume defined by planes.
A DataSource implementation which can be used to manually manage a group of entities.
A simple TerrainProvider that gets height values from a callback function. It can be used for procedurally generated terrain or as a way to load custom heightmap data without creating a subclass of TerrainProvider.
A user defined GLSL shader used with Model as well as Cesium3DTileset.
An enum describing how the CustomShader will be added to the fragment shader. This determines how the shader interacts with the material.
An enum for controling how CustomShader handles translucency compared with the original primitive.
A description of a cylinder.
A GeometryUpdater for cylinders. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes a cylinder, truncated cone, or cone defined by a length, top radius, and bottom radius. The center position and orientation are determined by the containing Entity.
A description of the outline of a cylinder.
A DataSource which processes CZML.
Function interface for comparing interval data.
Defines the interface for data sources, which turn arbitrary data into a EntityCollection for generic consumption. This object is an interface for documentation purposes and is not intended to be instantiated directly.
Represents desired clock settings for a particular DataSource. These settings may be applied to the Clock when the DataSource is loaded.
A collection of DataSource instances.
Visualizes a collection of DataSource instances.
Visualizes a vertex attribute by displaying it as a color for debugging.
Draws the outline of the camera's view frustum.
Draws the axes of a reference frame defined by a matrix that transforms to world coordinates, i.e., Earth's WGS84 coordinates. The most prominent example is a primitives modelMatrix.
A simple proxy that appends the desired resource as the sole query parameter to the given proxy URL.
Determines the function used to compare two depths for the depth test.
Constructs an exception object that is thrown due to a developer error, e.g., invalid argument, argument out of range, etc. This exception should only be thrown during development; it usually indicates a bug in the calling code. This exception should never be caught; instead the calling code should strive not to generate it.
A light that gets emitted in a single direction from infinitely far away.
An orientation given by a pair of unit vectors
A policy for discarding tile images that contain no data (and so aren't actually images). This policy discards DiscardEmptyTileImagePolicy.EMPTY_IMAGE, which is expected to be used in place of any empty tile images by the image loading code.
A policy for discarding tile images that match a known image containing a "missing" image.
Determines visibility based on the distance to the camera.
Value and type information for per-instance geometry attribute that determines if the geometry instance has a distance display condition.
A function that will be executed when the flight completes.
Atmosphere lighting effects (sky atmosphere, ground atmosphere, fog) can be further modified with dynamic lighting from the sun or other light source that changes over time. This enum determines which light source to use.
Generates an environment map at the given position based on scene's current lighting conditions. From this, it produces multiple levels of specular maps and spherical harmonic coefficients than can be used with ImageBasedLighting for models or tilesets.
Function interface for implementing a custom easing function.
Easing functions for use with TweenCollection. These function are from Tween.js and Robert Penner. See the Tween.js graphs for each function.
A description of an ellipse on an ellipsoid. Ellipse geometry can be rendered with both Primitive and GroundPrimitive.
A GeometryUpdater for ellipses. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes an ellipse defined by a center point and semi-major and semi-minor axes. The ellipse 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 center point is determined by the containing Entity.
A description of the outline of an ellipse on an ellipsoid.
Initializes a geodesic on the ellipsoid connecting the two provided planetodetic points.
A description of an ellipsoid centered at the origin.
A GeometryUpdater for ellipsoids. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describe an ellipsoid or sphere. The center position and orientation are determined by the containing Entity.
A description of the outline of an ellipsoid centered at the origin.
Initializes a rhumb line on the ellipsoid connecting the two provided planetodetic points.
An appearance for geometry on the surface of the ellipsoid like PolygonGeometry and RectangleGeometry, which supports all materials like MaterialAppearance with {@link MaterialAppearance.MaterialSupport.ALL}. However, this appearance requires fewer vertex attributes since the fragment shader can procedurally compute normal, tangent, and bitangent.
A plane tangent to the provided ellipsoid at the provided origin. If origin is not on the surface of the ellipsoid, it's surface projection will be used. If origin is at the center of the ellipsoid, an exception will be thrown.
A very simple TerrainProvider that produces geometry by tessellating an ellipsoidal surface.
Entity instances aggregate multiple forms of visualization into a single high-level object. They can be created manually and added to Viewer.entities or be produced by data sources, such as CzmlDataSource and GeoJsonDataSource.
Defines how screen space objects (billboards, points, labels) are clustered.
An observable collection of Entity instances where each entity has a unique id.
A utility object for tracking an entity with the camera.
A function that is called when an error occurs.
A convenience object that simplifies the common pattern of attaching event listeners to several events, then removing all those listeners at once later, for example, in a destroy method.
Since KML does not support glTF models, this callback is required to specify what URL to use for the model in the KML document. It can also be used to add additional files to the externalFiles object, which is the list of files embedded in the exported KMZ, or otherwise returned with the KML string when exporting.
An expression for a style applied to a Cesium3DTileset.
Constants to determine how an interpolated value is extrapolated when querying outside the bounds of available data.
A set of functions to detect whether the current browser supports various features.
A function that will execute when a flight is cancelled.
A function that will execute when a flight completes.
Optimization option. Used as a callback when Cesium3DTileset.foveatedScreenSpaceError is true to control how much to raise the screen space error for tiles outside the foveated cone, interpolating between Cesium3DTileset.foveatedMinimumScreenSpaceErrorRelaxation and Cesium3DTileset.maximumScreenSpaceError.
Monitors the frame rate (frames per second) in a Scene and raises an event if the frame rate is lower than a threshold. Later, if the frame rate returns to the required level, a separate event is raised. To avoid creating multiple FrameRateMonitors for a single Scene, use FrameRateMonitor.fromScene instead of constructing an instance explicitly.
Describes a frustum at the given the origin and orientation.
A description of the outline of a frustum with the given the origin and orientation.
Browser-independent functions for working with the standard fullscreen API.
Provides geocoding through an external service. This type describes an interface and is not intended to be used.
The type of geocoding to be performed by a GeocoderService.
A simple map projection where longitude and latitude are linearly mapped to X and Y by multiplying them by the Ellipsoid.maximumRadius. This projection is commonly known as geographic, equirectangular, equidistant cylindrical, or plate carrée. When using the WGS84 ellipsoid, it is also known as EPSG:4326.
A tiling scheme for geometry referenced to a simple GeographicProjection where longitude and latitude are directly mapped to X and Y. This projection is commonly known as geographic, equirectangular, equidistant cylindrical, or plate carrée.
A DataSource which processes both GeoJSON and TopoJSON data. simplestyle-spec properties will also be used if they are present.
A geometry representation with attributes forming vertices and optional index data defining primitives. Geometries and an Appearance, which describes the shading, can be assigned to a Primitive for visualization. A Primitive can be created from many heterogeneous - in many cases - geometries for performance.
Values and type information for geometry attributes. A Geometry generally contains one or more attributes. All attributes together form the geometry's vertices.
Attributes, which make up a geometry's vertices. Each property in this object corresponds to a GeometryAttribute containing the attribute's data.
Base class for all geometry creation utility classes that can be passed to GeometryInstance for asynchronous geometry creation.
Geometry instancing allows one Geometry object to be positions in several different locations and colored uniquely. For example, one BoxGeometry can be instanced several times, each with a different modelMatrix to change its position, rotation, and scale.
Values and type information for per-instance geometry attributes.
Content pipeline functions for geometries.
An abstract class for updating geometry entities.
A general purpose visualizer for geometry represented by Primitive instances.
Describes the format in which to request GetFeatureInfo from a Web Map Service (WMS) server.
The globe rendered in the scene, including its terrain (Globe.terrainProvider) and imagery layers (Globe.imageryLayers). Access the globe using Scene.globe.
Properties for controlling globe translucency.
Interface for the function that is called with the loaded gltf object once loaded.
The GPM metadata for a Ground-Space Indirect implementation stored locally (i.e. a tile and/or leaf node).
Terrain data for a single tile from a Google Earth Enterprise server.
Default settings for accessing the Google Maps API.
An API key is only required if you are directly using any Google Maps APIs, such as through createGooglePhotorealistic3DTileset. Follow instructions for managing API keys for the Google Maps Platform at https://developers.google.com/maps/documentation/embed/get-api-key
A DataSource which processes the GPS Exchange Format (GPX).
Represents a Gregorian date in a more precise format than the JavaScript Date object. In addition to submillisecond precision, this object can also represent leap seconds.
An ImageryProvider that draws a wireframe grid on every tile with controllable background and glow. May be useful for custom rendering effects or debugging terrain.
A MaterialProperty that maps to grid Material uniforms.
An abstract class for updating ground geometry entities.
A description of a polyline on terrain or 3D Tiles. Only to be used with GroundPolylinePrimitive.
A GroundPolylinePrimitive represents a polyline draped over the terrain or 3D Tiles in the Scene.
A ground primitive represents geometry draped over terrain or 3D Tiles in the Scene.
Defines a heading angle, pitch angle, and range in a local frame. Heading is the rotation from the local east direction where a positive angle is increasing southward. Pitch is the rotation from the local xy-plane. Positive pitch angles are above the plane. Negative pitch angles are below the plane. Range is the distance from the center of the frame.
A rotation expressed as a heading, pitch, and roll. Heading is the rotation about the negative z axis. Pitch is the rotation about the negative y axis. Roll is the rotation about the positive x axis.
An orientation given by numeric heading, pitch, and roll
The encoding that is used for a heightmap
Terrain data for a single tile where the terrain data is represented as a heightmap. A heightmap is a rectangular array of heights in row-major order from north to south and west to east.
Represents the position relative to the terrain.
An InterpolationAlgorithm for performing Hermite interpolation.
A Hermite spline is a cubic interpolating spline. Points, incoming tangents, outgoing tangents, and times must be defined for each control point. The outgoing tangents are defined for points 0, n - 2 and the incoming tangents are defined for points 1, n - 1. For example, when interpolating a segment of the curve between points[i] and points[i + 1], the tangents at the points will be outTangents[i] and inTangents[i], respectively.
An I3SDataProvider is the main public class for I3S support. The url option should return a scene object. Currently supported I3S versions are 1.6 and 1.7/1.8 (OGC I3S 1.2). I3SFeature and I3SNode classes implement the Object Model for I3S entities, with public interfaces.
This class implements an I3S Feature.
This class implements an I3S Geometry. Each I3SGeometry generates an in memory glTF to be used as content for a Cesium3DTile
This class implements an I3S statistics for Building Scene Layer.
This class implements an I3S sublayer for Building Scene Layer.
This class implements an I3S symbology for I3S Layers.
Properties for managing image-based lighting on tilesets and models. Also manages the necessary resources and textures.
A MaterialProperty that maps to image Material uniforms.
An imagery layer that displays tiled image data from a single imagery provider on a Globe.
An ordered collection of imagery layers.
A function that is called when an error occurs.
Describes a rasterized feature, such as a point, polygon, polyline, etc., in an imagery layer.
A function that is called when the provider has been created
Provides imagery to be displayed on the surface of an ellipsoid. This type describes an interface and is not intended to be instantiated directly.
The format in which ImageryProvider methods return an image may vary by provider, configuration, or server settings. Most common are HTMLImageElement, HTMLCanvasElement, or on supported browsers, ImageBitmap.
Constants for WebGL index datatypes. These corresponds to the type parameter of drawElements.
The interface for interpolation algorithms.
This enumerated type is used in determining where, relative to the frustum, an object is located. The object can either be fully contained within the frustum (INSIDE), partially inside the frustum and partially outside (INTERSECTING), or somewhere entirely outside of the frustum's 6 planes (OUTSIDE).
Contains functions for operating on 2D triangles.
Functions for computing the intersection between geometries such as rays, planes, triangles, and ellipsoids.
Provides geocoding through Cesium ion.
A Resource instance that encapsulates Cesium ion asset access. This object is normally not instantiated directly, use IonResource.fromAssetId.
The types of imagery provided by createWorldImagery.
Represents an astronomical Julian date, which is the number of days since noon on January 1, -4712 (4713 BC). For increased precision, this class stores the whole number part of the date and the seconds part of the date in separate components. In order to be safe for arithmetic and represent leap seconds, the date is always stored in the International Atomic Time standard TimeStandard.TAI.
This enumerated type is for representing keyboard modifiers. These are keys that are held down in addition to other event types.
Representation of
A DataSource which processes Keyhole Markup Language 2.2 (KML).
Contains KML Feature data loaded into the Entity.kml property by KmlDataSource.
Transitions the KmlTour to the next destination. This transition is facilitated using a specified flyToMode over a given number of seconds.
Pauses the KmlTour for a given number of seconds.
A renderable collection of labels. Labels are viewport-aligned text positioned in the 3D scene. Each label can have a different font, color, scale, etc.
Describes a two dimensional label located at the position of the containing Entity.
Describes how to draw a label.
A Visualizer which maps the LabelGraphics instance in Entity.label to a Label.
An InterpolationAlgorithm for performing Lagrange interpolation.
Describes a single leap second, which is constructed from a JulianDate and a numerical offset representing the number of seconds TAI is ahead of the UTC time standard.
A light source. This type describes an interface and is not intended to be instantiated directly. Together, color and intensity produce a high-dynamic-range light color. intensity can also be used individually to dim or brighten the light without changing the hue.
The lighting model to use for lighting a Model.
An InterpolationAlgorithm for performing linear interpolation.
A spline that uses piecewise linear interpolation to create a curve.
Computes a 4x4 transformation matrix from a reference frame centered at the provided origin to the provided ellipsoid's fixed reference frame.
Provides tiled imagery hosted by Mapbox.
Provides tiled imagery hosted by Mapbox.
Defines how geodetic ellipsoid coordinates (Cartographic) project to a flat map like Cesium's 2D and Columbus View modes.
A Material defines surface appearance through a combination of diffuse, specular, normal, emission, and alpha components. These values are specified using a JSON schema called Fabric which gets parsed and assembled into glsl shader code behind-the-scenes. Check out the wiki page for more details on Fabric.
An appearance for arbitrary geometry (as opposed to EllipsoidSurfaceAppearance, for example) that supports shading with materials.
A 2x2 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.
A 3x3 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.
A 4x4 matrix, indexable as a column-major order array. Constructor parameters are in row-major order for code readability.
Function interface for merging interval data.
A function used to compare two items while performing a merge sort.
A metadata class.
A metadata property, as part of a MetadataClass.
An enum of metadata component types.
A metadata enum.
A metadata enum value.
A schema containing classes and enums.
An enum of metadata types. These metadata types are containers containing one or more components of type MetadataComponentType
Determines if and how a glTF animation is looped.
A feature of a Model.
A Visualizer which maps Entity.model to a Model.
Draws the Moon in 3D.
A spline that linearly interpolates over an array of weight values used by morph targets.
Represents a scalar value's lower and upper bound at a near distance and far distance in eye space.
A TileDiscardPolicy specifying that tile images should never be discard.
A event listener function used to style clusters.
A Property that produces TranslationRotationScale data.
Creates an Occluder derived from an object's position and radius, as well as the camera position. The occluder can be used to determine whether or not other objects are visible or hidden behind the visible horizon defined by the occluder and camera position.
Provides geocoding via a OpenCage server.
An imagery provider that provides tiled imagery hosted by OpenStreetMap or another provider of Slippy tiles. The default url connects to OpenStreetMap's volunteer-run servers, so you must conform to their Tile Usage Policy.
Creates an instance of an OrientedBoundingBox. An OrientedBoundingBox of some object is a closed and convex rectangular cuboid. It can provide a tighter bounding volume than BoundingSphere or AxisAlignedBoundingBox in many cases.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
Static interface for Packable types which are interpolated in a different representation than their packed value. These methods and properties are expected to be defined on a constructor function.
A particle emitted by a ParticleSystem.
Represents a burst of Particles from a ParticleSystem at a given time in the systems lifetime.
An object that initializes a Particle from a ParticleSystem.
A ParticleSystem manages the updating and display of a collection of particles.
Describes a polyline defined as the path made by an Entity as it moves over time.
A Visualizer which maps Entity.path to a Polyline.
Provides geocoding via a Pelias server.
An appearance for GeometryInstance instances with color attributes. This allows several geometry instances, each with a different color, to be drawn with the same Primitive as shown in the second example below.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
The viewing frustum is defined by 6 planes. Each plane is represented by a Cartesian4 object, where the x, y, and z components define the unit vector normal to the plane, and the w component is the distance of the plane from the origin/camera position.
Information about metadata that is supposed to be picked
A utility class for generating custom map pins as canvas elements.
The data type of a pixel.
The format of a pixel, i.e., the number of components it has and what they represent.
A plane in Hessian Normal Form defined by
Describes geometry representing a plane centered at the origin, with a unit width and length.
A GeometryUpdater for planes. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes a plane. The center position and orientation are determined by the containing Entity.
Describes geometry representing the outline of a plane centered at the origin, with a unit width and length.
Options for performing point attenuation based on geometric error when rendering point clouds using 3D Tiles.
Describes a graphical point located at the position of the containing Entity.
A renderable collection of points.
A Visualizer which maps Entity.point to a PointPrimitive.
A description of a polygon on the ellipsoid. The polygon is defined by a polygon hierarchy. Polygon geometry can be rendered with both Primitive and GroundPrimitive.
A GeometryUpdater for polygons. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes a polygon defined by an hierarchy of linear rings which make up the outer shape and any nested holes. The polygon 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.
An hierarchy of linear rings which define a polygon and its holes. The holes themselves may also have holes which nest inner polygons.
A description of the outline of a polygon on the ellipsoid. The polygon is defined by a polygon hierarchy.
A MaterialProperty that maps to PolylineArrow Material uniforms.
A renderable collection of polylines.
An appearance for GeometryInstance instances with color attributes and PolylineGeometry or GroundPolylineGeometry. This allows several geometry instances, each with a different color, to be drawn with the same Primitive.
A MaterialProperty that maps to polyline dash Material uniforms.
A description of a polyline modeled as a line strip; the first two positions define a line segment, and each additional position defines a line segment from the previous position. The polyline is capable of displaying with a material.
A GeometryUpdater for polylines. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
A MaterialProperty that maps to polyline glow Material uniforms.
Describes a polyline. The first two positions define a line segment, and each additional position defines a line segment from the previous position. The segments can be linear connected points, great arcs, or clamped to terrain.
An appearance for PolylineGeometry that supports shading with materials.
A MaterialProperty that maps to polyline outline Material uniforms.
A visualizer for polylines represented by Primitive instances.
A description of a polyline with a volume (a 2D shape extruded along a polyline).
A GeometryUpdater for polyline volumes. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes a polyline volume defined as a line strip and corresponding two dimensional shape which is extruded along it. The resulting volume conforms to the curvature of the globe.
A description of a polyline with a volume (a 2D shape extruded along a polyline).
The interface for all Property objects that define a world location as a Cartesian3 with an associated ReferenceFrame. This type defines an interface and cannot be instantiated directly.
A Property whose value is an array whose items are the computed value of other PositionProperty instances.
Runs a post-process stage on either the texture rendered by the scene or the output of a previous post-process stage.
A collection of PostProcessStages and/or PostProcessStageComposites.
A collection of PostProcessStages or other post-process composite stages that execute together logically.
Contains functions for creating common post-process stages.
Determines how input texture to a PostProcessStage is sampled.
A primitive represents geometry in the Scene. The geometry can be from a single GeometryInstance as shown in example 1 below, or from an array of instances, even if the geometry is from different geometry types, e.g., an RectangleGeometry and an EllipsoidGeometry as shown in Code Example 2.
A collection of primitives. This is most often used with Scene.primitives, but PrimitiveCollection is also a primitive itself so collections can be added to collections forming a hierarchy.
The type of a geometric primitive, i.e., points, lines, and triangles.
The function that is called to update the request's priority, which occurs once per frame.
A Property whose value is an array whose items are the computed value of other property instances.
A Property whose value is a key-value mapping of property names to the computed value of other properties.
Defines functions for 2nd order polynomial functions of one variable with only real coefficients.
Terrain data for a single tile where the terrain data is represented as a quantized mesh. A quantized mesh consists of three vertex attributes, longitude, latitude, and height. All attributes are expressed as 16-bit values in the range 0 to 32767. Longitude and latitude are zero at the southwest corner of the tile and 32767 at the northeast corner. Height is zero at the minimum height in the tile and 32767 at the maximum height in the tile.
Defines functions for 4th order polynomial functions of one variable with only real coefficients.
A set of 4-dimensional coordinates used to represent rotation in 3-dimensional space.
A spline that uses spherical linear (slerp) interpolation to create a quaternion curve. The generated curve is in the class C1.
Represents a ray that extends infinitely from the provided origin in the provided direction.
A description of a cartographic rectangle on an ellipsoid centered at the origin. Rectangle geometry can be rendered with both Primitive and GroundPrimitive.
A GeometryUpdater for rectangles. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
Describes graphics for a Rectangle. 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.
A description of the outline of a a cartographic rectangle on an ellipsoid centered at the origin.
Constants for identifying well-known reference frames.
A Property which transparently links to another property on a provided object.
A function that removes a listener.
Stores information for making a request. In general this does not need to be constructed directly.
The function that makes the actual data request.
An event that is raised when a request encounters an error.
The request scheduler is used to track and constrain the number of active requests in order to prioritize incoming requests. The ability to retain control over the number of requests in CesiumJS is important because due to events such as changes in the camera position, a lot of new requests may be generated and a lot of in-flight requests may become redundant. The request scheduler manually constrains the number of requests so that newer requests wait in a shorter queue and don't have to compete for bandwidth with requests that have expired.
State of the request.
An enum identifying the type of request. Used for finer grained logging and priority sorting.
A function that returns the value of the property.
A function that will be called to retry the operation.
Represents a Packable number that always interpolates values towards the shortest angle of rotation. This object is never used directly but is instead passed to the constructor of SampledProperty in order to represent a two-dimensional angle of rotation.
Constructs an exception object that is thrown due to an error that can occur at runtime, e.g., out of memory, could not compile shader, etc. If a function may throw this exception, the calling code should be prepared to catch it.
A SampledProperty which is also a PositionProperty.
A Property whose value is interpolated for a given time from the provided set of samples and specified interpolation algorithm and degree.
The container for all 3D graphical objects and state in a Cesium virtual scene. Generally, a scene is not created directly; instead, it is implicitly created by CesiumWidget.
Functions that do scene-dependent transforms between rendering-related coordinate systems.
Modifies the camera position and orientation based on mouse input to a canvas.
Handles user input events. Custom functions can be added to be executed on when the user enters input.
This enumerated type is for classifying mouse events: down, up, click, double click, move and move while a button is held down.
Constants used to indicated what part of the sensor volume to display.
Specifies whether the object casts or receives shadows from light sources when shadows are enabled.
Value and type information for per-instance geometry attribute that determines if the geometry instance will be shown.
Contains functions for finding the Cartesian coordinates of the sun and the moon in the Earth-centered inertial frame.
A description of a polyline modeled as a line strip; the first two positions define a line segment, and each additional position defines a line segment from the previous position.
Provides a single, top-level imagery tile. The single image is assumed to be in the Geographic projection (i.e. WGS84 / EPSG:4326), and will be rendered using a GeographicTilingScheme.
An atmosphere drawn around the limb of the provided ellipsoid. Based on Display of The Earth Taking Into Account Atmospheric Scattering.
A sky box around the scene to draw stars. The sky box is defined using the True Equator Mean Equinox (TEME) axes.
Variables for a Strictly Positive-Definite Correlation Function.
A ParticleEmitter that emits particles within a sphere. Particles will be positioned randomly within the sphere and have initial velocities emanating from the center of the sphere.
A description of a sphere centered at the origin.
A description of the outline of a sphere.
The direction to display a primitive or ImageryLayer relative to the Scene.splitPosition.
Determines the function used to compare stencil values for the stencil test.
Determines the action taken based on the result of the stencil test.
A spline that is composed of piecewise constants representing a step function.
An enum of storage types for covariance information.
A MaterialProperty that maps to stripe Material uniforms.
Defined the orientation of stripes in StripeMaterialProperty.
An expression for a style applied to a Cesium3DTileset.
A wrapper around a web worker that allows scheduling tasks for a given worker, returning results asynchronously via a promise.
A helper to manage async operations of a terrain provider.
Terrain data for a single tile. This type describes an interface and is not intended to be instantiated directly.
A function that is called when an error occurs.
Provides terrain or other geometry for the surface of an ellipsoid. The surface geometry is organized into a pyramid of tiles according to a TilingScheme. This type describes an interface and is not intended to be instantiated directly.
A function that is called when the provider has been created
Enumerates all possible filters used when magnifying WebGL textures.
Enumerates all possible filters used when minifying WebGL textures.
A simple struct that serves as a value of a sampler2D-valued uniform. This is used with CustomShader and TextureManager
Reports the availability of tiles in a TilingScheme.
An ImageryProvider that draws a box around every rendered tile in the tiling scheme, and draws a label inside it indicating the X, Y, Level coordinates of the tile. This is mostly useful for debugging terrain and imagery rendering problems.
A policy for discarding tile images according to some criteria. This type describes an interface and is not intended to be instantiated directly.
Provides details about an error that occurred in an ImageryProvider or a TerrainProvider.
A tiling scheme for geometry or imagery on the surface of an ellipsoid. At level-of-detail zero, the coarsest, least-detailed level, the number of tiles is configurable. At level of detail one, each of the level zero tiles has four children, two in each direction. At level of detail two, each of the level one tiles has four children, two in each direction. This continues for as many levels as are present in the geometry or imagery source.
Provides functionality for ImageryProviders that have time dynamic imagery
Provides playback of time-dynamic point cloud data.
An interval defined by a start and a stop time; optionally including those times as part of the interval. Arbitrary data can optionally be associated with each instance for used with TimeIntervalCollection.
A non-overlapping collection of TimeInterval instances sorted by start time.
A TimeIntervalCollectionProperty which is also a PositionProperty.
A Property which is defined by a TimeIntervalCollection, where the data property of each TimeInterval represents the value at time.
Provides the type of time standards which JulianDate can take as input.
A tonemapping algorithm when rendering with high dynamic range.
Contains functions for transforming positions to various reference frames.
An affine transformation defined by a translation, rotation, and scale.
Uses the Tridiagonal Matrix Algorithm, also known as the Thomas Algorithm, to solve a system of linear equations where the coefficient matrix is a tridiagonal matrix.
A singleton that contains all of the servers that are trusted. Credentials will be sent with any requests to these servers.
An object describing a uniform, its type, and an initial value
An enum of the basic GLSL uniform types. These can be used with CustomShader to declare user-defined uniforms.
A function used to modify attributes of the particle at each time step. This can include force modifications, color, sizing, etc.
Function
Provides imagery by requesting tiles using a specified URL template.
An enum for the GLSL varying types. These can be used for declaring varyings in CustomShader
A Property which evaluates to a Quaternion rotation based on the velocity of the provided PositionProperty.
A Property which evaluates to a Cartesian3 vector based on the velocity of the provided PositionProperty.
A vertex format defines what attributes make up a vertex. A VertexFormat can be provided to a Geometry to request that certain properties be computed, e.g., just position, position and normal, etc.
Synchronizes a video element with a simulation clock.
A viewport aligned quad.
This enumerated type is used in determining to what extent an object, the occludee, is visible during horizon culling. An occluder may fully block an occludee, in which case it has no visibility, may partially block an occludee from view, or may not block it at all, leading to full visibility.
Defines the interface for visualizers. Visualizers are plug-ins to DataSourceDisplay that render data associated with DataSource instances. This object is an interface for documentation purposes and is not intended to be instantiated directly.
A function which creates an array of visualizers used for visualization.
A cell from a VoxelPrimitive.
A primitive that renders voxel data from a VoxelProvider.
Provides voxel data. Intended to be used with VoxelPrimitive. This type describes an interface and is not intended to be instantiated directly.
An enum of voxel shapes. The shape controls how the voxel grid is mapped to 3D space.
A description of a wall, which is similar to a KML line string. A wall is defined by a series of points, which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
A GeometryUpdater for walls. Clients do not normally create this class directly, but instead rely on DataSourceDisplay.
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 description of a wall outline. A wall is defined by a series of points, which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
Enum containing WebGL Constant values by name. for use without an active WebGL context, or in cases where certain constants are unavailable using the WebGL context (For example, in Safari 9).
WebGL options to be passed on to HTMLCanvasElement.getContext(). See WebGLContextAttributes but note the modified defaults for 'alpha', 'stencil', and 'powerPreference'
Provides tiled imagery hosted by a Web Map Service (WMS) server.
Provides tiled imagery served by WMTS 1.0.0 compliant servers. This provider supports HTTP KVP-encoded and RESTful GetTile requests, but does not yet support the SOAP encoding.
The map projection used by Google Maps, Bing Maps, and most of ArcGIS Online, EPSG:3857. This projection use longitude and latitude expressed with the WGS84 and transforms them to Mercator using the spherical (rather than ellipsoidal) equations.
A tiling scheme for geometry referenced to a WebMercatorProjection, EPSG:3857. This is the tiling scheme used by Google Maps, Microsoft Bing Maps, and most of ESRI ArcGIS Online.
Winding order defines the order of vertices for a triangle to be considered front-facing.
Functions
Computes the barycentric coordinates for a point with respect to a triangle.
Finds an item in a sorted array.
Given a relative URL under the Cesium base URL, returns an absolute URL.
Merges two objects, copying their properties onto a new combined object. When two objects have the same property, the value of the property on the first object is used. If either object is undefined, it will be treated as an empty object.
Compute the rectangle that describes the part of the drawing buffer that is relevant for picking.
Creates an AnchorPointDirect from the given JSON representation
Creates an AnchorPointIndirect from the given JSON representation
Creates a CorrelationGroup from the given JSON representation
Creates a Matrix3 that describes a covariance matrix (which is symmetric) from the array containing the upper triangle, in column-major order.
Creates a Material that combines multiple layers of color/gradient bands and maps them to terrain heights.
Creates a Cesium3DTileset instance for the Google Photorealistic 3D Tiles tileset.
Creates a Globally unique identifier (GUID) string. A GUID is 128 bits long, and can guarantee uniqueness across space and time.
Creates a Cesium3DTileset instance for the Cesium OSM Buildings tileset.
Creates a Primitive to visualize well-known vector vertex attributes: normal, tangent, and bitangent. Normal is red; tangent is green; and bitangent is blue. If an attribute is not present, it is not drawn.
Creates a CesiumTerrainProvider instance for the Cesium World Bathymetry.
Creates an IonImageryProvider instance for ion's default global base imagery layer, currently Bing Maps.
Creates a CesiumTerrainProvider instance for the Cesium World Terrain.
Destroys an object. Each of the object's functions, including functions in its prototype, is replaced with a function that throws a DeveloperError, except for the object's isDestroyed function, which is set to a function that returns true. The object's properties are removed with delete.
Exports an EntityCollection as a KML document. Only Point, Billboard, Model, Path, Polygon, Polyline geometries will be exported. Note that there is not a 1 to 1 mapping of Entity properties to KML Feature properties. For example, entity properties that are time dynamic but cannot be dynamic in KML are exported with their values at options.time or the beginning of the EntityCollection's time interval if not specified. For time-dynamic properties that are supported in KML, we use the samples if it is a SampledProperty otherwise we sample the value using the options.sampleDuration. Point, Billboard, Model and Path geometries with time-dynamic positions will be exported as gx:Track Features. Not all Materials are representable in KML, so for more advanced Materials just the primary color is used. Canvas objects are exported as PNG images.
Formats an error object into a String. If available, uses name, message, and stack properties, otherwise, falls back on toString().
Given a relative Uri and a base Uri, returns the absolute Uri of the relative Uri.
Given a URI, returns the base path of the URI.
Given a URI, returns the extension of the URI.
Given a URI, returns the last segment of the URI, removing any path or query information.
Returns the type that the given class property has in a GLSL shader.
Extract a pixel array from a loaded image. Draws the image into a canvas so it can read the pixels back.
Gets a timestamp that can be used in measuring the time between events. Timestamps are expressed in milliseconds, but it is not specified what the milliseconds are measured from. This function uses performance.now() if it is available, or Date.now() otherwise.
Determines if a given date is a leap year.
Loads the gltf object
A stable merge sort.
Converts an object representing a set of name/value pairs into a query string, with names and values encoded properly for use in a URL. Values that are arrays will produce multiple values with the same name.
Determine how translucent surfaces will be handled.
Determines if a point is inside a triangle.
Parses a query string into an object, where the keys and values of the object are the name/value pairs from the query string, decoded. If a name appears multiple times, the value in the object will be an array of values.
Removes an extension from gltf.extensions, gltf.extensionsUsed, gltf.extensionsRequired, and any other objects in the glTF if it is present.
Initiates a terrain height query for an array of Cartographic positions by requesting tiles from a terrain provider, sampling, and interpolating. The interpolation matches the triangles used to render the terrain at the specified level. The query happens asynchronously, so this function returns a promise that is resolved when the query completes. Each point height is modified in place. If a height can not be determined because no terrain data is available for the specified level at that location, or another error occurs, the height is set to undefined. As is typical of the Cartographic type, the supplied height is a height above the reference ellipsoid (such as Ellipsoid.WGS84) rather than an altitude above mean sea level. In other words, it will not necessarily be 0.0 if sampled in the ocean. This function needs the terrain level of detail as input, if you need to get the altitude of the terrain as precisely as possible (i.e. with maximum level of detail) use sampleTerrainMostDetailed.
Initiates a sampleTerrain() request at the maximum available tile level for a terrain dataset.
Converts the value from sRGB color space to linear color space.
Represents a point in stereographic coordinates, which can be obtained by projecting a cartesian coordinate from one pole onto a tangent plane at the other pole. The stereographic projection faithfully represents the relative directions of all great circles passing through its center point. To faithfully represents angles everywhere, this is a conformal projection, which means points are projected onto an arbrary sphere.
Subdivides an array into a number of smaller, equal sized arrays.
Writes the given text into a new canvas. The canvas will be sized to fit the text. If text is blank, returns undefined.