Global

Members

Properties:

Name	Type	Description
SATELLITE	number
OCEANS	number
HILLSHADE	number

See:

• ArcGisMapServerImageryProvider

Properties:

Name	Type	Description
NONE	number	Straight line that does not conform to the surface of the ellipsoid.
GEODESIC	number	Follow geodesic path.
RHUMB	number	Follow rhumb or loxodrome path.

Properties:

Name	Type	Description
X	number	Denotes the x-axis.
Y	number	Denotes the y-axis.
Z	number	Denotes the z-axis.

Properties:

Name	Type	Description
AERIAL	string	Aerial imagery.
AERIAL_WITH_LABELS	string	Aerial imagery with a road overlay.
AERIAL_WITH_LABELS_ON_DEMAND	string	Aerial imagery with a road overlay.
ROAD	string	Roads without additional imagery.
ROAD_ON_DEMAND	string	Roads without additional imagery.
CANVAS_DARK	string	A dark version of the road maps.
CANVAS_LIGHT	string	A lighter version of the road maps.
CANVAS_GRAY	string	A grayscale version of the road maps.
ORDNANCE_SURVEY	string	Ordnance Survey imagery. This imagery is visible only for the London, UK area.
COLLINS_BART	string	Collins Bart imagery.

See:

• BingMapsImageryProvider

Properties:

Name	Type	Description
ADD	number	Pixel values are added componentwise. This is used in additive blending for translucency.
SUBTRACT	number	Pixel values are subtracted componentwise (source - destination). This is used in alpha blending for translucency.
REVERSE_SUBTRACT	number	Pixel values are subtracted componentwise (destination - source).
MIN	number	Pixel values are given to the minimum function (min(source, destination)). This equation operates on each pixel color component.
MAX	number	Pixel values are given to the maximum function (max(source, destination)). This equation operates on each pixel color component.

Properties:

Name	Type	Description
ZERO	number	The blend factor is zero.
ONE	number	The blend factor is one.
SOURCE_COLOR	number	The blend factor is the source color.
ONE_MINUS_SOURCE_COLOR	number	The blend factor is one minus the source color.
DESTINATION_COLOR	number	The blend factor is the destination color.
ONE_MINUS_DESTINATION_COLOR	number	The blend factor is one minus the destination color.
SOURCE_ALPHA	number	The blend factor is the source alpha.
ONE_MINUS_SOURCE_ALPHA	number	The blend factor is one minus the source alpha.
DESTINATION_ALPHA	number	The blend factor is the destination alpha.
ONE_MINUS_DESTINATION_ALPHA	number	The blend factor is one minus the destination alpha.
CONSTANT_COLOR	number	The blend factor is the constant color.
ONE_MINUS_CONSTANT_COLOR	number	The blend factor is one minus the constant color.
CONSTANT_ALPHA	number	The blend factor is the constant alpha.
ONE_MINUS_CONSTANT_ALPHA	number	The blend factor is one minus the constant alpha.
SOURCE_ALPHA_SATURATE	number	The blend factor is the saturated source alpha.

Properties:

Name	Type	Description
OPAQUE	number	The billboards, points, or labels in the collection are completely opaque.
TRANSLUCENT	number	The billboards, points, or labels in the collection are completely translucent.
OPAQUE_AND_TRANSLUCENT	number	The billboards, points, or labels in the collection are both opaque and translucent.

Properties:

Name	Type	Description
LEFT_DRAG	number	A left mouse button press followed by moving the mouse and releasing the button.
RIGHT_DRAG	number	A right mouse button press followed by moving the mouse and releasing the button.
MIDDLE_DRAG	number	A middle mouse button press followed by moving the mouse and releasing the button.
WHEEL	number	Scrolling the middle mouse button.
PINCH	number	A two-finger touch on a touch surface.

"techniques": {
  "technique0": {
    "parameters": {
      "diffuse": {
        "semantic": "_3DTILESDIFFUSE",
        "type": 35666
      }
    }
  }
}

Properties:

Name	Type	Description
HIGHLIGHT	number	Multiplies the source color by the feature color.
REPLACE	number	Replaces the source color with the feature color.
MIX	number	Blends the source color and feature color together.

Properties:

Name	Type	Description
TERRAIN	number	Only terrain will be classified.
CESIUM_3D_TILE	number	Only 3D Tiles will be classified.
BOTH	number	Both terrain and 3D Tiles will be classified.

Properties:

Name	Type	Description
UNBOUNDED	number	Clock#tick will always advances the clock in its current direction.
CLAMPED	number	When Clock#startTime or Clock#stopTime is reached, Clock#tick will not advance Clock#currentTime any further.
LOOP_STOP	number	When Clock#stopTime is reached, Clock#tick will advance Clock#currentTime to the opposite end of the interval. When time is moving backwards, Clock#tick will not advance past Clock#startTime

See:

• Clock
• ClockStep

Properties:

Name	Type	Description
TICK_DEPENDENT	number	Clock#tick advances the current time by a fixed step, which is the number of seconds specified by Clock#multiplier.
SYSTEM_CLOCK_MULTIPLIER	number	Clock#tick advances the current time by the amount of system time elapsed since the previous call multiplied by Clock#multiplier.
SYSTEM_CLOCK	number	Clock#tick sets the clock to the current system time; ignoring all other settings.

See:

• Clock
• ClockRange

Properties:

Name	Type	Description
CUMULUS	number	Cumulus cloud.

Properties:

Name	Type	Description
HIGHLIGHT	number
REPLACE	number
MIX	number

See:

• Model.colorBlendMode

Properties:

Name	Type	Description
BYTE	number	8-bit signed byte corresponding to gl.BYTE and the type of an element in Int8Array.
UNSIGNED_BYTE	number	8-bit unsigned byte corresponding to UNSIGNED_BYTE and the type of an element in Uint8Array.
SHORT	number	16-bit signed short corresponding to SHORT and the type of an element in Int16Array.
UNSIGNED_SHORT	number	16-bit unsigned short corresponding to UNSIGNED_SHORT and the type of an element in Uint16Array.
INT	number	32-bit signed int corresponding to INT and the type of an element in Int32Array.
UNSIGNED_INT	number	32-bit unsigned int corresponding to UNSIGNED_INT and the type of an element in Uint32Array.
FLOAT	number	32-bit floating-point corresponding to FLOAT and the type of an element in Float32Array.
DOUBLE	number	64-bit floating-point corresponding to gl.DOUBLE (in Desktop OpenGL; this is not supported in WebGL, and is emulated in Cesium via GeometryPipeline.encodeAttribute) and the type of an element in Float64Array.

Properties:

Name	Type	Description
ROUNDED	number	Corner has a smooth edge.
MITERED	number	Corner point is the intersection of adjacent edges.
BEVELED	number	Corner is clipped.

Demo:

• The Corridor Demo demonstrates the three corner types, as used by CorridorGraphics.

Properties:

Name	Type	Description
FRONT	number	Front-facing triangles are culled.
BACK	number	Back-facing triangles are culled.
FRONT_AND_BACK	number	Both front-facing and back-facing triangles are culled.

Properties:

Name	Type	Description
MODIFY_MATERIAL	string	The custom shader will be used to modify the results of the material stage before lighting is applied.
REPLACE_MATERIAL	string	The custom shader will be used instead of the material stage. This is a hint to optimize out the material processing code.

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

Properties:

Name	Type	Description
INHERIT	number	Inherit translucency settings from the primitive's material. If the primitive used a translucent material, the custom shader will also be considered translucent. If the primitive used an opaque material, the custom shader will be considered opaque.
OPAQUE	number	Force the primitive to render the primitive as opaque, ignoring any material settings.
TRANSLUCENT	number	Force the primitive to render the primitive as translucent, ignoring any material settings.

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

Properties:

Name	Type	Description
NEVER	number	The depth test never passes.
LESS	number	The depth test passes if the incoming depth is less than the stored depth.
EQUAL	number	The depth test passes if the incoming depth is equal to the stored depth.
LESS_OR_EQUAL	number	The depth test passes if the incoming depth is less than or equal to the stored depth.
GREATER	number	The depth test passes if the incoming depth is greater than the stored depth.
NOT_EQUAL	number	The depth test passes if the incoming depth is not equal to the stored depth.
GREATER_OR_EQUAL	number	The depth test passes if the incoming depth is greater than or equal to the stored depth.
ALWAYS	number	The depth test always passes.

Properties:

Name	Type	Description
NONE	number	No extrapolation occurs.
HOLD	number	The first or last value is used when outside the range of sample data.
EXTRAPOLATE	number	The value is extrapolated.

See:

• SampledProperty

Properties:

Name	Type	Description
SEARCH	number	Perform a search where the input is considered complete.
AUTOCOMPLETE	number	Perform an auto-complete using partial input, typically reserved for providing possible results as a user is typing.

See:

• Geocoder

Properties:

Name	Type	Description
NONE	number	No encoding
LERC	number	LERC encoding

Properties:

Name	Type	Description
NONE	number	The position is absolute.
CLAMP_TO_GROUND	number	The position is clamped to the terrain.
RELATIVE_TO_GROUND	number	The position height is the height above the terrain.

The horizontal location of an origin relative to an object, e.g., a Billboard or Label. For example, setting the horizontal origin to LEFT or RIGHT will display a billboard to the left or right (in screen space) of the anchor position.

Properties:

Name	Type	Description
CENTER	number	The origin is at the horizontal center of the object.
LEFT	number	The origin is on the left side of the object.
RIGHT	number	The origin is on the right side of the object.

See:

• Billboard#horizontalOrigin
• Label#horizontalOrigin

Properties:

Name	Type	Description
UNSIGNED_BYTE	number	8-bit unsigned byte corresponding to UNSIGNED_BYTE and the type of an element in Uint8Array.
UNSIGNED_SHORT	number	16-bit unsigned short corresponding to UNSIGNED_SHORT and the type of an element in Uint16Array.
UNSIGNED_INT	number	32-bit unsigned int corresponding to UNSIGNED_INT and the type of an element in Uint32Array.

Properties:

Name	Type	Description
OUTSIDE	number	Represents that an object is not contained within the frustum.
INTERSECTING	number	Represents that an object intersects one of the frustum's planes.
INSIDE	number	Represents that an object is fully within the frustum.

Properties:

Name	Type	Description
AERIAL	number	Aerial imagery.
AERIAL_WITH_LABELS	number	Aerial imagery with a road overlay.
ROAD	number	Roads without additional imagery.

Properties:

Name	Type	Description
SHIFT	number	Represents the shift key being held down.
CTRL	number	Represents the control key being held down.
ALT	number	Represents the alt key being held down.

Properties:

Name	Type	Description
FILL	number	Fill the text of the label, but do not outline.
OUTLINE	number	Outline the text of the label, but do not fill.
FILL_AND_OUTLINE	number	Fill and outline the text of the label.

See:

• Label#style

Properties:

Name	Type	Description
UNLIT	number	Use unlit shading, i.e. skip lighting calculations. The model's diffuse color (assumed to be linear RGB, not sRGB) is used directly when computing out_FragColor. The alpha mode is still applied.
PBR	number	Use physically-based rendering lighting calculations. This includes both PBR metallic roughness and PBR specular glossiness. Image-based lighting is also applied when possible.

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

Properties:

Name	Type	Description
ROTATE	number	The 2D map can be rotated about the z axis.
INFINITE_SCROLL	number	The 2D map can be scrolled infinitely in the horizontal direction.

Properties:

Name	Type	Description
INT8	string	An 8-bit signed integer
UINT8	string	An 8-bit unsigned integer
INT16	string	A 16-bit signed integer
UINT16	string	A 16-bit unsigned integer
INT32	string	A 32-bit signed integer
UINT32	string	A 32-bit unsigned integer
INT64	string	A 64-bit signed integer. This type requires BigInt support.
UINT64	string	A 64-bit signed integer. This type requires BigInt support
FLOAT32	string	A 32-bit (single precision) floating point number
FLOAT64	string	A 64-bit (double precision) floating point number

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

Properties:

Name	Type	Description
SCALAR	string	A single component
VEC2	string	A vector with two components
VEC3	string	A vector with three components
VEC4	string	A vector with four components
MAT2	string	A 2x2 matrix, stored in column-major format.
MAT3	string	A 3x3 matrix, stored in column-major format.
MAT4	string	A 4x4 matrix, stored in column-major format.
BOOLEAN	string	A boolean (true/false) value
STRING	string	A UTF-8 encoded string value
ENUM	string	An enumerated value. This type is used in conjunction with a MetadataEnum to describe the valid values.

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

Properties:

Name	Type	Description
NONE	number	Play the animation once; do not loop it.
REPEAT	number	Loop the animation playing it from the start immediately after it stops.
MIRRORED_REPEAT	number	Loop the animation. First, playing it forward, then in reverse, then forward, and so on.

See:

• ModelAnimationCollection#add

Properties:

Name	Type	Description
UNSIGNED_BYTE	number
UNSIGNED_SHORT	number
UNSIGNED_INT	number
FLOAT	number
HALF_FLOAT	number
UNSIGNED_INT_24_8	number
UNSIGNED_SHORT_4_4_4_4	number
UNSIGNED_SHORT_5_5_5_1	number
UNSIGNED_SHORT_5_6_5	number

See:

• PostProcessStage

Properties:

Name	Type	Description
DEPTH_COMPONENT	number	A pixel format containing a depth value.
DEPTH_STENCIL	number	A pixel format containing a depth and stencil value, most often used with PixelDatatype.UNSIGNED_INT_24_8.
ALPHA	number	A pixel format containing an alpha channel.
RED	number	A pixel format containing a red channel
RG	number	A pixel format containing red and green channels.
RGB	number	A pixel format containing red, green, and blue channels.
RGBA	number	A pixel format containing red, green, blue, and alpha channels.
LUMINANCE	number	A pixel format containing a luminance (intensity) channel.
LUMINANCE_ALPHA	number	A pixel format containing luminance (intensity) and alpha channels.
RGB_DXT1	number	A pixel format containing red, green, and blue channels that is DXT1 compressed.
RGBA_DXT1	number	A pixel format containing red, green, blue, and alpha channels that is DXT1 compressed.
RGBA_DXT3	number	A pixel format containing red, green, blue, and alpha channels that is DXT3 compressed.
RGBA_DXT5	number	A pixel format containing red, green, blue, and alpha channels that is DXT5 compressed.
RGB_PVRTC_4BPPV1	number	A pixel format containing red, green, and blue channels that is PVR 4bpp compressed.
RGB_PVRTC_2BPPV1	number	A pixel format containing red, green, and blue channels that is PVR 2bpp compressed.
RGBA_PVRTC_4BPPV1	number	A pixel format containing red, green, blue, and alpha channels that is PVR 4bpp compressed.
RGBA_PVRTC_2BPPV1	number	A pixel format containing red, green, blue, and alpha channels that is PVR 2bpp compressed.
RGBA_ASTC	number	A pixel format containing red, green, blue, and alpha channels that is ASTC compressed.
RGB_ETC1	number	A pixel format containing red, green, and blue channels that is ETC1 compressed.
RGB8_ETC2	number	A pixel format containing red, green, and blue channels that is ETC2 compressed.
RGBA8_ETC2_EAC	number	A pixel format containing red, green, blue, and alpha channels that is ETC2 compressed.
RGBA_BC7	number	A pixel format containing red, green, blue, and alpha channels that is BC7 compressed.

Properties:

Name	Type	Description
NEAREST	number	Samples the texture by returning the closest texel.
LINEAR	number	Samples the texture through bi-linear interpolation of the four nearest texels.

Properties:

Name	Type	Description
POINTS	number	Points primitive where each vertex (or index) is a separate point.
LINES	number	Lines primitive where each two vertices (or indices) is a line segment. Line segments are not necessarily connected.
LINE_LOOP	number	Line loop primitive where each vertex (or index) after the first connects a line to the previous vertex, and the last vertex implicitly connects to the first.
LINE_STRIP	number	Line strip primitive where each vertex (or index) after the first connects a line to the previous vertex.
TRIANGLES	number	Triangles primitive where each three vertices (or indices) is a triangle. Triangles do not necessarily share edges.
TRIANGLE_STRIP	number	Triangle strip primitive where each vertex (or index) after the first two connect to the previous two vertices forming a triangle. For example, this can be used to model a wall.
TRIANGLE_FAN	number	Triangle fan primitive where each vertex (or index) after the first two connect to the previous vertex and the first vertex forming a triangle. For example, this can be used to model a cone or circle.

Properties:

Name	Type	Description
FIXED	number	The fixed frame.
INERTIAL	number	The inertial frame.

Properties:

Name	Type	Description
UNISSUED	number	Initial unissued state.
ISSUED	number	Issued but not yet active. Will become active when open slots are available.
ACTIVE	number	Actual http request has been sent.
RECEIVED	number	Request completed successfully.
CANCELLED	number	Request was cancelled, either explicitly or automatically because of low priority.
FAILED	number	Request failed.

Properties:

Name	Type	Description
TERRAIN	number	Terrain request.
IMAGERY	number	Imagery request.
TILES3D	number	3D Tiles request.
OTHER	number	Other request.

Properties:

Name	Type	Description
MORPHING	number	Morphing between mode, e.g., 3D to 2D.
COLUMBUS_VIEW	number	Columbus View mode. A 2.5D perspective view where the map is laid out flat and objects with non-zero height are drawn above it.
SCENE2D	number	2D mode. The map is viewed top-down with an orthographic projection.
SCENE3D	number	3D mode. A traditional 3D perspective view of the globe.

See:

• Scene#mode

Properties:

Name	Type	Description
LEFT_DOWN	number	Represents a mouse left button down event.
LEFT_UP	number	Represents a mouse left button up event.
LEFT_CLICK	number	Represents a mouse left click event.
LEFT_DOUBLE_CLICK	number	Represents a mouse left double click event.
RIGHT_DOWN	number	Represents a mouse left button down event.
RIGHT_UP	number	Represents a mouse right button up event.
RIGHT_CLICK	number	Represents a mouse right click event.
MIDDLE_DOWN	number	Represents a mouse middle button down event.
MIDDLE_UP	number	Represents a mouse middle button up event.
MIDDLE_CLICK	number	Represents a mouse middle click event.
MOUSE_MOVE	number	Represents a mouse move event.
WHEEL	number	Represents a mouse wheel event.
PINCH_START	number	Represents the start of a two-finger event on a touch surface.
PINCH_END	number	Represents the end of a two-finger event on a touch surface.
PINCH_MOVE	number	Represents a change of a two-finger event on a touch surface.

Properties:

Name	Type	Description
DISABLED	number	The object does not cast or receive shadows.
ENABLED	number	The object casts and receives shadows.
CAST_ONLY	number	The object casts shadows only.
RECEIVE_ONLY	number	The object receives shadows only.

Properties:

Name	Type	Description
LEFT	number	Display the primitive or ImageryLayer to the left of the Scene#splitPosition.
NONE	number	Always display the primitive or ImageryLayer.
RIGHT	number	Display the primitive or ImageryLayer to the right of the Scene#splitPosition.

See:

• ImageryLayer#splitDirection
• Cesium3DTileset#splitDirection

Properties:

Name	Type	Description
NEVER	number	The stencil test never passes.
LESS	number	The stencil test passes when the masked reference value is less than the masked stencil value.
EQUAL	number	The stencil test passes when the masked reference value is equal to the masked stencil value.
LESS_OR_EQUAL	number	The stencil test passes when the masked reference value is less than or equal to the masked stencil value.
GREATER	number	The stencil test passes when the masked reference value is greater than the masked stencil value.
NOT_EQUAL	number	The stencil test passes when the masked reference value is not equal to the masked stencil value.
GREATER_OR_EQUAL	number	The stencil test passes when the masked reference value is greater than or equal to the masked stencil value.
ALWAYS	number	The stencil test always passes.

Properties:

Name	Type	Description
ZERO	number	Sets the stencil buffer value to zero.
KEEP	number	Does not change the stencil buffer.
REPLACE	number	Replaces the stencil buffer value with the reference value.
INCREMENT	number	Increments the stencil buffer value, clamping to unsigned byte.
DECREMENT	number	Decrements the stencil buffer value, clamping to zero.
INVERT	number	Bitwise inverts the existing stencil buffer value.
INCREMENT_WRAP	number	Increments the stencil buffer value, wrapping to zero when exceeding the unsigned byte range.
DECREMENT_WRAP	number	Decrements the stencil buffer value, wrapping to the maximum unsigned byte instead of going below zero.

Properties:

Name	Type	Description
HORIZONTAL	number	Horizontal orientation.
VERTICAL	number	Vertical orientation.

Properties:

Name	Type	Description
NEAREST	number	Samples the texture by returning the closest pixel.
LINEAR	number	Samples the texture through bi-linear interpolation of the four nearest pixels. This produces smoother results than NEAREST filtering.

See:

• TextureMinificationFilter

Properties:

Name	Type	Description
NEAREST	number	Samples the texture by returning the closest pixel.
LINEAR	number	Samples the texture through bi-linear interpolation of the four nearest pixels. This produces smoother results than NEAREST filtering.
NEAREST_MIPMAP_NEAREST	number	Selects the nearest mip level and applies nearest sampling within that level. Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.
LINEAR_MIPMAP_NEAREST	number	Selects the nearest mip level and applies linear sampling within that level. Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.
NEAREST_MIPMAP_LINEAR	number	Read texture values with nearest sampling from two adjacent mip levels and linearly interpolate the results. This option provides a good balance of visual quality and speed when sampling from a mipmapped texture. Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.
LINEAR_MIPMAP_LINEAR	number	Read texture values with linear sampling from two adjacent mip levels and linearly interpolate the results. This option provides a good balance of visual quality and speed when sampling from a mipmapped texture. Requires that the texture has a mipmap. The mip level is chosen by the view angle and screen-space size of the texture.

See:

• TextureMagnificationFilter

Properties:

Name	Type	Description
UTC	number	Represents the coordinated Universal Time (UTC) time standard. UTC is related to TAI according to the relationship UTC = TAI - deltaT where deltaT is the number of leap seconds which have been introduced as of the time in TAI.
TAI	number	Represents the International Atomic Time (TAI) time standard. TAI is the principal time standard to which the other time standards are related.

See:

• JulianDate

Properties:

Name	Type	Description
FLOAT	string	A single floating point value.
VEC2	string	A vector of 2 floating point values.
VEC3	string	A vector of 3 floating point values.
VEC4	string	A vector of 4 floating point values.
INT	string	A single integer value
INT_VEC2	string	A vector of 2 integer values.
INT_VEC3	string	A vector of 3 integer values.
INT_VEC4	string	A vector of 4 integer values.
BOOL	string	A single boolean value.
BOOL_VEC2	string	A vector of 2 boolean values.
BOOL_VEC3	string	A vector of 3 boolean values.
BOOL_VEC4	string	A vector of 4 boolean values.
MAT2	string	A 2x2 matrix of floating point values.
MAT3	string	A 3x3 matrix of floating point values.
MAT4	string	A 3x3 matrix of floating point values.
SAMPLER_2D	string	A 2D sampled texture.
SAMPLER_CUBE	string

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

Properties:

Name	Type	Description
FLOAT	string	A single floating point value.
VEC2	string	A vector of 2 floating point values.
VEC3	string	A vector of 3 floating point values.
VEC4	string	A vector of 4 floating point values.
MAT2	string	A 2x2 matrix of floating point values.
MAT3	string	A 3x3 matrix of floating point values.
MAT4	string	A 3x3 matrix of floating point values.

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.

The vertical location of an origin relative to an object, e.g., a Billboard or Label. For example, setting the vertical origin to TOP or BOTTOM will display a billboard above or below (in screen space) the anchor position.

Properties:

Name	Type	Description
CENTER	number	The origin is at the vertical center between BASELINE and TOP.
BOTTOM	number	The origin is at the bottom of the object.
BASELINE	number	If the object contains text, the origin is at the baseline of the text, else the origin is at the bottom of the object.
TOP	number	The origin is at the top of the object.

See:

• Billboard#verticalOrigin
• Label#verticalOrigin

Properties:

Name	Type	Description
NONE	number	Represents that no part of an object is visible.
PARTIAL	number	Represents that part, but not all, of an object is visible
FULL	number	Represents that an object is visible in its entirety.

Properties:

Name	Type	Description
BOX	string	A box shape.
ELLIPSOID	string	An ellipsoid shape.
CYLINDER	string	A cylinder shape.

Experimental

This feature is not final and is subject to change without Cesium's standard deprecation policy.

Properties:

Name	Type	Description
DEPTH_BUFFER_BIT	number
STENCIL_BUFFER_BIT	number
COLOR_BUFFER_BIT	number
POINTS	number
LINES	number
LINE_LOOP	number
LINE_STRIP	number
TRIANGLES	number
TRIANGLE_STRIP	number
TRIANGLE_FAN	number
ZERO	number
ONE	number
SRC_COLOR	number
ONE_MINUS_SRC_COLOR	number
SRC_ALPHA	number
ONE_MINUS_SRC_ALPHA	number
DST_ALPHA	number
ONE_MINUS_DST_ALPHA	number
DST_COLOR	number
ONE_MINUS_DST_COLOR	number
SRC_ALPHA_SATURATE	number
FUNC_ADD	number
BLEND_EQUATION	number
BLEND_EQUATION_RGB	number
BLEND_EQUATION_ALPHA	number
FUNC_SUBTRACT	number
FUNC_REVERSE_SUBTRACT	number
BLEND_DST_RGB	number
BLEND_SRC_RGB	number
BLEND_DST_ALPHA	number
BLEND_SRC_ALPHA	number
CONSTANT_COLOR	number
ONE_MINUS_CONSTANT_COLOR	number
CONSTANT_ALPHA	number
ONE_MINUS_CONSTANT_ALPHA	number
BLEND_COLOR	number
ARRAY_BUFFER	number
ELEMENT_ARRAY_BUFFER	number
ARRAY_BUFFER_BINDING	number
ELEMENT_ARRAY_BUFFER_BINDING	number
STREAM_DRAW	number
STATIC_DRAW	number
DYNAMIC_DRAW	number
BUFFER_SIZE	number
BUFFER_USAGE	number
CURRENT_VERTEX_ATTRIB	number
FRONT	number
BACK	number
FRONT_AND_BACK	number
CULL_FACE	number
BLEND	number
DITHER	number
STENCIL_TEST	number
DEPTH_TEST	number
SCISSOR_TEST	number
POLYGON_OFFSET_FILL	number
SAMPLE_ALPHA_TO_COVERAGE	number
SAMPLE_COVERAGE	number
NO_ERROR	number
INVALID_ENUM	number
INVALID_VALUE	number
INVALID_OPERATION	number
OUT_OF_MEMORY	number
CW	number
CCW	number
LINE_WIDTH	number
ALIASED_POINT_SIZE_RANGE	number
ALIASED_LINE_WIDTH_RANGE	number
CULL_FACE_MODE	number
FRONT_FACE	number
DEPTH_RANGE	number
DEPTH_WRITEMASK	number
DEPTH_CLEAR_VALUE	number
DEPTH_FUNC	number
STENCIL_CLEAR_VALUE	number
STENCIL_FUNC	number
STENCIL_FAIL	number
STENCIL_PASS_DEPTH_FAIL	number
STENCIL_PASS_DEPTH_PASS	number
STENCIL_REF	number
STENCIL_VALUE_MASK	number
STENCIL_WRITEMASK	number
STENCIL_BACK_FUNC	number
STENCIL_BACK_FAIL	number
STENCIL_BACK_PASS_DEPTH_FAIL	number
STENCIL_BACK_PASS_DEPTH_PASS	number
STENCIL_BACK_REF	number
STENCIL_BACK_VALUE_MASK	number
STENCIL_BACK_WRITEMASK	number
VIEWPORT	number
SCISSOR_BOX	number
COLOR_CLEAR_VALUE	number
COLOR_WRITEMASK	number
UNPACK_ALIGNMENT	number
PACK_ALIGNMENT	number
MAX_TEXTURE_SIZE	number
MAX_VIEWPORT_DIMS	number
SUBPIXEL_BITS	number
RED_BITS	number
GREEN_BITS	number
BLUE_BITS	number
ALPHA_BITS	number
DEPTH_BITS	number
STENCIL_BITS	number
POLYGON_OFFSET_UNITS	number
POLYGON_OFFSET_FACTOR	number
TEXTURE_BINDING_2D	number
SAMPLE_BUFFERS	number
SAMPLES	number
SAMPLE_COVERAGE_VALUE	number
SAMPLE_COVERAGE_INVERT	number
COMPRESSED_TEXTURE_FORMATS	number
DONT_CARE	number
FASTEST	number
NICEST	number
GENERATE_MIPMAP_HINT	number
BYTE	number
UNSIGNED_BYTE	number
SHORT	number
UNSIGNED_SHORT	number
INT	number
UNSIGNED_INT	number
FLOAT	number
DEPTH_COMPONENT	number
ALPHA	number
RGB	number
RGBA	number
LUMINANCE	number
LUMINANCE_ALPHA	number
UNSIGNED_SHORT_4_4_4_4	number
UNSIGNED_SHORT_5_5_5_1	number
UNSIGNED_SHORT_5_6_5	number
FRAGMENT_SHADER	number
VERTEX_SHADER	number
MAX_VERTEX_ATTRIBS	number
MAX_VERTEX_UNIFORM_VECTORS	number
MAX_VARYING_VECTORS	number
MAX_COMBINED_TEXTURE_IMAGE_UNITS	number
MAX_VERTEX_TEXTURE_IMAGE_UNITS	number
MAX_TEXTURE_IMAGE_UNITS	number
MAX_FRAGMENT_UNIFORM_VECTORS	number
SHADER_TYPE	number
DELETE_STATUS	number
LINK_STATUS	number
VALIDATE_STATUS	number
ATTACHED_SHADERS	number
ACTIVE_UNIFORMS	number
ACTIVE_ATTRIBUTES	number
SHADING_LANGUAGE_VERSION	number
CURRENT_PROGRAM	number
NEVER	number
LESS	number
EQUAL	number
LEQUAL	number
GREATER	number
NOTEQUAL	number
GEQUAL	number
ALWAYS	number
KEEP	number
REPLACE	number
INCR	number
DECR	number
INVERT	number
INCR_WRAP	number
DECR_WRAP	number
VENDOR	number
RENDERER	number
VERSION	number
NEAREST	number
LINEAR	number
NEAREST_MIPMAP_NEAREST	number
LINEAR_MIPMAP_NEAREST	number
NEAREST_MIPMAP_LINEAR	number
LINEAR_MIPMAP_LINEAR	number
TEXTURE_MAG_FILTER	number
TEXTURE_MIN_FILTER	number
TEXTURE_WRAP_S	number
TEXTURE_WRAP_T	number
TEXTURE_2D	number
TEXTURE	number
TEXTURE_CUBE_MAP	number
TEXTURE_BINDING_CUBE_MAP	number
TEXTURE_CUBE_MAP_POSITIVE_X	number
TEXTURE_CUBE_MAP_NEGATIVE_X	number
TEXTURE_CUBE_MAP_POSITIVE_Y	number
TEXTURE_CUBE_MAP_NEGATIVE_Y	number
TEXTURE_CUBE_MAP_POSITIVE_Z	number
TEXTURE_CUBE_MAP_NEGATIVE_Z	number
MAX_CUBE_MAP_TEXTURE_SIZE	number
TEXTURE0	number
TEXTURE1	number
TEXTURE2	number
TEXTURE3	number
TEXTURE4	number
TEXTURE5	number
TEXTURE6	number
TEXTURE7	number
TEXTURE8	number
TEXTURE9	number
TEXTURE10	number
TEXTURE11	number
TEXTURE12	number
TEXTURE13	number
TEXTURE14	number
TEXTURE15	number
TEXTURE16	number
TEXTURE17	number
TEXTURE18	number
TEXTURE19	number
TEXTURE20	number
TEXTURE21	number
TEXTURE22	number
TEXTURE23	number
TEXTURE24	number
TEXTURE25	number
TEXTURE26	number
TEXTURE27	number
TEXTURE28	number
TEXTURE29	number
TEXTURE30	number
TEXTURE31	number
ACTIVE_TEXTURE	number
REPEAT	number
CLAMP_TO_EDGE	number
MIRRORED_REPEAT	number
FLOAT_VEC2	number
FLOAT_VEC3	number
FLOAT_VEC4	number
INT_VEC2	number
INT_VEC3	number
INT_VEC4	number
BOOL	number
BOOL_VEC2	number
BOOL_VEC3	number
BOOL_VEC4	number
FLOAT_MAT2	number
FLOAT_MAT3	number
FLOAT_MAT4	number
SAMPLER_2D	number
SAMPLER_CUBE	number
VERTEX_ATTRIB_ARRAY_ENABLED	number
VERTEX_ATTRIB_ARRAY_SIZE	number
VERTEX_ATTRIB_ARRAY_STRIDE	number
VERTEX_ATTRIB_ARRAY_TYPE	number
VERTEX_ATTRIB_ARRAY_NORMALIZED	number
VERTEX_ATTRIB_ARRAY_POINTER	number
VERTEX_ATTRIB_ARRAY_BUFFER_BINDING	number
IMPLEMENTATION_COLOR_READ_TYPE	number
IMPLEMENTATION_COLOR_READ_FORMAT	number
COMPILE_STATUS	number
LOW_FLOAT	number
MEDIUM_FLOAT	number
HIGH_FLOAT	number
LOW_INT	number
MEDIUM_INT	number
HIGH_INT	number
FRAMEBUFFER	number
RENDERBUFFER	number
RGBA4	number
RGB5_A1	number
RGB565	number
DEPTH_COMPONENT16	number
STENCIL_INDEX	number
STENCIL_INDEX8	number
DEPTH_STENCIL	number
RENDERBUFFER_WIDTH	number
RENDERBUFFER_HEIGHT	number
RENDERBUFFER_INTERNAL_FORMAT	number
RENDERBUFFER_RED_SIZE	number
RENDERBUFFER_GREEN_SIZE	number
RENDERBUFFER_BLUE_SIZE	number
RENDERBUFFER_ALPHA_SIZE	number
RENDERBUFFER_DEPTH_SIZE	number
RENDERBUFFER_STENCIL_SIZE	number
FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE	number
FRAMEBUFFER_ATTACHMENT_OBJECT_NAME	number
FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL	number
FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE	number
COLOR_ATTACHMENT0	number
DEPTH_ATTACHMENT	number
STENCIL_ATTACHMENT	number
DEPTH_STENCIL_ATTACHMENT	number
NONE	number
FRAMEBUFFER_COMPLETE	number
FRAMEBUFFER_INCOMPLETE_ATTACHMENT	number
FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT	number
FRAMEBUFFER_INCOMPLETE_DIMENSIONS	number
FRAMEBUFFER_UNSUPPORTED	number
FRAMEBUFFER_BINDING	number
RENDERBUFFER_BINDING	number
MAX_RENDERBUFFER_SIZE	number
INVALID_FRAMEBUFFER_OPERATION	number
UNPACK_FLIP_Y_WEBGL	number
UNPACK_PREMULTIPLY_ALPHA_WEBGL	number
CONTEXT_LOST_WEBGL	number
UNPACK_COLORSPACE_CONVERSION_WEBGL	number
BROWSER_DEFAULT_WEBGL	number
COMPRESSED_RGB_S3TC_DXT1_EXT	number
COMPRESSED_RGBA_S3TC_DXT1_EXT	number
COMPRESSED_RGBA_S3TC_DXT3_EXT	number
COMPRESSED_RGBA_S3TC_DXT5_EXT	number
COMPRESSED_RGB_PVRTC_4BPPV1_IMG	number
COMPRESSED_RGB_PVRTC_2BPPV1_IMG	number
COMPRESSED_RGBA_PVRTC_4BPPV1_IMG	number
COMPRESSED_RGBA_PVRTC_2BPPV1_IMG	number
COMPRESSED_RGBA_ASTC_4x4_WEBGL	number
COMPRESSED_RGB_ETC1_WEBGL	number
COMPRESSED_RGBA_BPTC_UNORM	number
HALF_FLOAT_OES	number
DOUBLE	number
READ_BUFFER	number
UNPACK_ROW_LENGTH	number
UNPACK_SKIP_ROWS	number
UNPACK_SKIP_PIXELS	number
PACK_ROW_LENGTH	number
PACK_SKIP_ROWS	number
PACK_SKIP_PIXELS	number
COLOR	number
DEPTH	number
STENCIL	number
RED	number
RGB8	number
RGBA8	number
RGB10_A2	number
TEXTURE_BINDING_3D	number
UNPACK_SKIP_IMAGES	number
UNPACK_IMAGE_HEIGHT	number
TEXTURE_3D	number
TEXTURE_WRAP_R	number
MAX_3D_TEXTURE_SIZE	number
UNSIGNED_INT_2_10_10_10_REV	number
MAX_ELEMENTS_VERTICES	number
MAX_ELEMENTS_INDICES	number
TEXTURE_MIN_LOD	number
TEXTURE_MAX_LOD	number
TEXTURE_BASE_LEVEL	number
TEXTURE_MAX_LEVEL	number
MIN	number
MAX	number
DEPTH_COMPONENT24	number
MAX_TEXTURE_LOD_BIAS	number
TEXTURE_COMPARE_MODE	number
TEXTURE_COMPARE_FUNC	number
CURRENT_QUERY	number
QUERY_RESULT	number
QUERY_RESULT_AVAILABLE	number
STREAM_READ	number
STREAM_COPY	number
STATIC_READ	number
STATIC_COPY	number
DYNAMIC_READ	number
DYNAMIC_COPY	number
MAX_DRAW_BUFFERS	number
DRAW_BUFFER0	number
DRAW_BUFFER1	number
DRAW_BUFFER2	number
DRAW_BUFFER3	number
DRAW_BUFFER4	number
DRAW_BUFFER5	number
DRAW_BUFFER6	number
DRAW_BUFFER7	number
DRAW_BUFFER8	number
DRAW_BUFFER9	number
DRAW_BUFFER10	number
DRAW_BUFFER11	number
DRAW_BUFFER12	number
DRAW_BUFFER13	number
DRAW_BUFFER14	number
DRAW_BUFFER15	number
MAX_FRAGMENT_UNIFORM_COMPONENTS	number
MAX_VERTEX_UNIFORM_COMPONENTS	number
SAMPLER_3D	number
SAMPLER_2D_SHADOW	number
FRAGMENT_SHADER_DERIVATIVE_HINT	number
PIXEL_PACK_BUFFER	number
PIXEL_UNPACK_BUFFER	number
PIXEL_PACK_BUFFER_BINDING	number
PIXEL_UNPACK_BUFFER_BINDING	number
FLOAT_MAT2x3	number
FLOAT_MAT2x4	number
FLOAT_MAT3x2	number
FLOAT_MAT3x4	number
FLOAT_MAT4x2	number
FLOAT_MAT4x3	number
SRGB	number
SRGB8	number
SRGB8_ALPHA8	number
COMPARE_REF_TO_TEXTURE	number
RGBA32F	number
RGB32F	number
RGBA16F	number
RGB16F	number
VERTEX_ATTRIB_ARRAY_INTEGER	number
MAX_ARRAY_TEXTURE_LAYERS	number
MIN_PROGRAM_TEXEL_OFFSET	number
MAX_PROGRAM_TEXEL_OFFSET	number
MAX_VARYING_COMPONENTS	number
TEXTURE_2D_ARRAY	number
TEXTURE_BINDING_2D_ARRAY	number
R11F_G11F_B10F	number
UNSIGNED_INT_10F_11F_11F_REV	number
RGB9_E5	number
UNSIGNED_INT_5_9_9_9_REV	number
TRANSFORM_FEEDBACK_BUFFER_MODE	number
MAX_TRANSFORM_FEEDBACK_SEPARATE_COMPONENTS	number
TRANSFORM_FEEDBACK_VARYINGS	number
TRANSFORM_FEEDBACK_BUFFER_START	number
TRANSFORM_FEEDBACK_BUFFER_SIZE	number
TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN	number
RASTERIZER_DISCARD	number
MAX_TRANSFORM_FEEDBACK_INTERLEAVED_COMPONENTS	number
MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS	number
INTERLEAVED_ATTRIBS	number
SEPARATE_ATTRIBS	number
TRANSFORM_FEEDBACK_BUFFER	number
TRANSFORM_FEEDBACK_BUFFER_BINDING	number
RGBA32UI	number
RGB32UI	number
RGBA16UI	number
RGB16UI	number
RGBA8UI	number
RGB8UI	number
RGBA32I	number
RGB32I	number
RGBA16I	number
RGB16I	number
RGBA8I	number
RGB8I	number
RED_INTEGER	number
RGB_INTEGER	number
RGBA_INTEGER	number
SAMPLER_2D_ARRAY	number
SAMPLER_2D_ARRAY_SHADOW	number
SAMPLER_CUBE_SHADOW	number
UNSIGNED_INT_VEC2	number
UNSIGNED_INT_VEC3	number
UNSIGNED_INT_VEC4	number
INT_SAMPLER_2D	number
INT_SAMPLER_3D	number
INT_SAMPLER_CUBE	number
INT_SAMPLER_2D_ARRAY	number
UNSIGNED_INT_SAMPLER_2D	number
UNSIGNED_INT_SAMPLER_3D	number
UNSIGNED_INT_SAMPLER_CUBE	number
UNSIGNED_INT_SAMPLER_2D_ARRAY	number
DEPTH_COMPONENT32F	number
DEPTH32F_STENCIL8	number
FLOAT_32_UNSIGNED_INT_24_8_REV	number
FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING	number
FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPE	number
FRAMEBUFFER_ATTACHMENT_RED_SIZE	number
FRAMEBUFFER_ATTACHMENT_GREEN_SIZE	number
FRAMEBUFFER_ATTACHMENT_BLUE_SIZE	number
FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE	number
FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE	number
FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE	number
FRAMEBUFFER_DEFAULT	number
UNSIGNED_INT_24_8	number
DEPTH24_STENCIL8	number
UNSIGNED_NORMALIZED	number
DRAW_FRAMEBUFFER_BINDING	number
READ_FRAMEBUFFER	number
DRAW_FRAMEBUFFER	number
READ_FRAMEBUFFER_BINDING	number
RENDERBUFFER_SAMPLES	number
FRAMEBUFFER_ATTACHMENT_TEXTURE_LAYER	number
MAX_COLOR_ATTACHMENTS	number
COLOR_ATTACHMENT1	number
COLOR_ATTACHMENT2	number
COLOR_ATTACHMENT3	number
COLOR_ATTACHMENT4	number
COLOR_ATTACHMENT5	number
COLOR_ATTACHMENT6	number
COLOR_ATTACHMENT7	number
COLOR_ATTACHMENT8	number
COLOR_ATTACHMENT9	number
COLOR_ATTACHMENT10	number
COLOR_ATTACHMENT11	number
COLOR_ATTACHMENT12	number
COLOR_ATTACHMENT13	number
COLOR_ATTACHMENT14	number
COLOR_ATTACHMENT15	number
FRAMEBUFFER_INCOMPLETE_MULTISAMPLE	number
MAX_SAMPLES	number
HALF_FLOAT	number
RG	number
RG_INTEGER	number
R8	number
RG8	number
R16F	number
R32F	number
RG16F	number
RG32F	number
R8I	number
R8UI	number
R16I	number
R16UI	number
R32I	number
R32UI	number
RG8I	number
RG8UI	number
RG16I	number
RG16UI	number
RG32I	number
RG32UI	number
VERTEX_ARRAY_BINDING	number
R8_SNORM	number
RG8_SNORM	number
RGB8_SNORM	number
RGBA8_SNORM	number
SIGNED_NORMALIZED	number
COPY_READ_BUFFER	number
COPY_WRITE_BUFFER	number
COPY_READ_BUFFER_BINDING	number
COPY_WRITE_BUFFER_BINDING	number
UNIFORM_BUFFER	number
UNIFORM_BUFFER_BINDING	number
UNIFORM_BUFFER_START	number
UNIFORM_BUFFER_SIZE	number
MAX_VERTEX_UNIFORM_BLOCKS	number
MAX_FRAGMENT_UNIFORM_BLOCKS	number
MAX_COMBINED_UNIFORM_BLOCKS	number
MAX_UNIFORM_BUFFER_BINDINGS	number
MAX_UNIFORM_BLOCK_SIZE	number
MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS	number
MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS	number
UNIFORM_BUFFER_OFFSET_ALIGNMENT	number
ACTIVE_UNIFORM_BLOCKS	number
UNIFORM_TYPE	number
UNIFORM_SIZE	number
UNIFORM_BLOCK_INDEX	number
UNIFORM_OFFSET	number
UNIFORM_ARRAY_STRIDE	number
UNIFORM_MATRIX_STRIDE	number
UNIFORM_IS_ROW_MAJOR	number
UNIFORM_BLOCK_BINDING	number
UNIFORM_BLOCK_DATA_SIZE	number
UNIFORM_BLOCK_ACTIVE_UNIFORMS	number
UNIFORM_BLOCK_ACTIVE_UNIFORM_INDICES	number
UNIFORM_BLOCK_REFERENCED_BY_VERTEX_SHADER	number
UNIFORM_BLOCK_REFERENCED_BY_FRAGMENT_SHADER	number
INVALID_INDEX	number
MAX_VERTEX_OUTPUT_COMPONENTS	number
MAX_FRAGMENT_INPUT_COMPONENTS	number
MAX_SERVER_WAIT_TIMEOUT	number
OBJECT_TYPE	number
SYNC_CONDITION	number
SYNC_STATUS	number
SYNC_FLAGS	number
SYNC_FENCE	number
SYNC_GPU_COMMANDS_COMPLETE	number
UNSIGNALED	number
SIGNALED	number
ALREADY_SIGNALED	number
TIMEOUT_EXPIRED	number
CONDITION_SATISFIED	number
WAIT_FAILED	number
SYNC_FLUSH_COMMANDS_BIT	number
VERTEX_ATTRIB_ARRAY_DIVISOR	number
ANY_SAMPLES_PASSED	number
ANY_SAMPLES_PASSED_CONSERVATIVE	number
SAMPLER_BINDING	number
RGB10_A2UI	number
INT_2_10_10_10_REV	number
TRANSFORM_FEEDBACK	number
TRANSFORM_FEEDBACK_PAUSED	number
TRANSFORM_FEEDBACK_ACTIVE	number
TRANSFORM_FEEDBACK_BINDING	number
COMPRESSED_R11_EAC	number
COMPRESSED_SIGNED_R11_EAC	number
COMPRESSED_RG11_EAC	number
COMPRESSED_SIGNED_RG11_EAC	number
COMPRESSED_RGB8_ETC2	number
COMPRESSED_SRGB8_ETC2	number
COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2	number
COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2	number
COMPRESSED_RGBA8_ETC2_EAC	number
COMPRESSED_SRGB8_ALPHA8_ETC2_EAC	number
TEXTURE_IMMUTABLE_FORMAT	number
MAX_ELEMENT_INDEX	number
TEXTURE_IMMUTABLE_LEVELS	number
MAX_TEXTURE_MAX_ANISOTROPY_EXT	number

Properties:

Name	Type	Description
CLOCKWISE	number	Vertices are in clockwise order.
COUNTER_CLOCKWISE	number	Vertices are in counter-clockwise order.

Methods

Returns:

Example:

// Returns Cartesian3.UNIT_X
const p = new Cesium.Cartesian3(-1.0, 0.0, 0.0);
const b = Cesium.barycentricCoordinates(p,
  new Cesium.Cartesian3(-1.0, 0.0, 0.0),
  new Cesium.Cartesian3( 1.0, 0.0, 0.0),
  new Cesium.Cartesian3( 0.0, 1.0, 1.0));

Returns:

Example:

// Create a comparator function to search through an array of numbers.
function comparator(a, b) {
    return a - b;
};
const numbers = [0, 2, 4, 6, 8];
const index = Cesium.binarySearch(numbers, 6, comparator); // 3

Returns:

Example:

const viewer = new Cesium.Viewer("cesiumContainer", {
  baseLayer: Cesium.ImageryLayer.fromProviderAsync(
    Cesium.TileMapServiceImageryProvider.fromUrl(
      Cesium.buildModuleUrl("Assets/Textures/NaturalEarthII"),
    )),
  baseLayerPicker: false,
});

Returns:

Returns:

Example:

const object1 = {
    propOne : 1,
    propTwo : {
        value1 : 10
    }
}
const object2 = {
    propTwo : 2
}
const final = Cesium.combine(object1, object2);

// final === {
//     propOne : 1,
//     propTwo : {
//         value1 : 10
//     }
// }

Returns:

Example:

scene.globe.material = Cesium.createElevationBandMaterial({
    scene : scene,
    layers : [{
        entries : [{
            height : 4200.0,
            color : new Cesium.Color(0.0, 0.0, 0.0, 1.0)
        }, {
            height : 8848.0,
            color : new Cesium.Color(1.0, 1.0, 1.0, 1.0)
        }],
        extendDownwards : true,
        extendUpwards : true,
    }, {
        entries : [{
            height : 7000.0,
            color : new Cesium.Color(1.0, 0.0, 0.0, 0.5)
        }, {
            height : 7100.0,
            color : new Cesium.Color(1.0, 0.0, 0.0, 0.5)
        }]
    }]
});

Demo:

• Cesium Sandcastle Elevation Band Demo

Returns:

Example:

Cesium.GoogleMaps.defaultApiKey = "your-api-key";

const viewer = new Cesium.Viewer("cesiumContainer");

try {
  const tileset = await Cesium.createGooglePhotorealistic3DTileset();
  viewer.scene.primitives.add(tileset));
} catch (error) {
  console.log(`Error creating tileset: ${error}`);
}

See:

• GoogleMaps

Returns:

Example:

this.guid = Cesium.createGuid();

See:

• RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace

Returns:

Deprecated: true

Examples:

// Create Cesium OSM Buildings with default styling
const viewer = new Cesium.Viewer('cesiumContainer');
viewer.scene.primitives.add(Cesium.createOsmBuildings());

// Create Cesium OSM Buildings with a custom style highlighting
// schools and hospitals.
viewer.scene.primitives.add(Cesium.createOsmBuildings({
  style: new Cesium.Cesium3DTileStyle({
    color: {
      conditions: [
        ["${feature['building']} === 'hospital'", "color('#0000FF')"],
        ["${feature['building']} === 'school'", "color('#00FF00')"],
        [true, "color('#ffffff')"]
      ]
    }
  })
}));

See:

• Ion

Returns:

Examples:

// Create Cesium OSM Buildings with default styling
const viewer = new Cesium.Viewer("cesiumContainer");
try {
  const tileset = await Cesium.createOsmBuildingsAsync();
  viewer.scene.primitives.add(tileset));
} catch (error) {
  console.log(`Error creating tileset: ${error}`);
}

// Create Cesium OSM Buildings with a custom style highlighting
// schools and hospitals.
const viewer = new Cesium.Viewer("cesiumContainer");
try {
  const tileset = await Cesium.createOsmBuildingsAsync({
    style: new Cesium.Cesium3DTileStyle({
      color: {
        conditions: [
          ["${feature['building']} === 'hospital'", "color('#0000FF')"],
          ["${feature['building']} === 'school'", "color('#00FF00')"],
          [true, "color('#ffffff')"]
        ]
      }
    })
  });
  viewer.scene.primitives.add(tileset));
} catch (error) {
  console.log(`Error creating tileset: ${error}`);
}

See:

• Ion

Returns:

Example:

scene.primitives.add(Cesium.createTangentSpaceDebugPrimitive({
   geometry : instance.geometry,
   length : 100000.0,
   modelMatrix : instance.modelMatrix
}));

Returns:

Deprecated: true

Examples:

// Create Cesium World Imagery with default settings
const viewer = new Cesium.Viewer('cesiumContainer', {
    imageryProvider : Cesium.createWorldImagery();
});

// Create Cesium World Imagery with a different style
const viewer = new Cesium.Viewer('cesiumContainer', {
    imageryProvider : Cesium.createWorldImagery({
        style: Cesium.IonWorldImageryStyle.AERIAL_WITH_LABELS
    })
});

See:

• Ion

Returns:

Examples:

// Create a Cesium World Imagery base layer with default settings
try {
  const imageryProvider = await Cesium.createWorldImageryAsync();
} catch (error) {
  console.log(`There was an error creating world imagery: ${error}`);
}

// Create Cesium World Imagery with different style
try {
  const imageryProvider = await Cesium.createWorldImageryAsync({
        style: Cesium.IonWorldImageryStyle.AERIAL_WITH_LABELS
  });
} catch (error) {
  console.log(`There was an error creating world imagery: ${error}`);
}

See:

• Ion

Returns:

Deprecated: true

Examples:

// Create Cesium World Terrain with default settings
const viewer = new Cesium.Viewer('cesiumContainer', {
    terrainProvider : Cesium.createWorldTerrain();
});

// Create Cesium World Terrain with water and normals.
const viewer1 = new Cesium.Viewer('cesiumContainer', {
    terrainProvider : Cesium.createWorldTerrain({
        requestWaterMask : true,
        requestVertexNormals : true
    });
});

See:

• Ion

Returns:

Examples:

// Create Cesium World Terrain with default settings
try {
  const viewer = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.createWorldTerrainAsync();
  });
} catch (error) {
  console.log(error);
}

// Create Cesium World Terrain with water and normals.
try {
  const viewer1 = new Cesium.Viewer("cesiumContainer", {
    terrainProvider: await Cesium.createWorldTerrainAsync({
      requestWaterMask: true,
      requestVertexNormals: true
    });
  });
} catch (error) {
  console.log(error);
}

See:

• Ion

Returns:

Example:

param = Cesium.defaultValue(param, 'default');

Returns:

Example:

if (Cesium.defined(positions)) {
     doSomething();
} else {
     doSomethingElse();
}

Example:

// How a texture would destroy itself.
this.destroy = function () {
    _gl.deleteTexture(_texture);
    return Cesium.destroyObject(this);
};

See:

• DeveloperError

Returns:

Example:

Cesium.exportKml({
     entities: entityCollection
 })
  .then(function(result) {
    // The XML string is in result.kml

    const externalFiles = result.externalFiles
    for(const file in externalFiles) {
      // file is the name of the file used in the KML document as the href
      // externalFiles[file] is a blob with the contents of the file
    }
  });

Demo:

• Cesium Sandcastle KML Export Demo

Returns:

Returns:

Example:

//absolute Uri will be "https://test.com/awesome.png";
const absoluteUri = Cesium.getAbsoluteUri('awesome.png', 'https://test.com');

Returns:

Example:

// basePath will be "/Gallery/";
const basePath = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false');

// basePath will be "/Gallery/?value=true&example=false";
const basePath = Cesium.getBaseUri('/Gallery/simple.czml?value=true&example=false', true);

Returns:

Example:

//extension will be "czml";
const extension = Cesium.getExtensionFromUri('/Gallery/simple.czml?value=true&example=false');

Returns:

Example:

//fileName will be"simple.czml";
const fileName = Cesium.getFilenameFromUri('/Gallery/simple.czml?value=true&example=false');

Returns:

Returns:

Returns:

Example:

const leapYear = Cesium.isLeapYear(2000); // true

Example:

// Assume array contains BoundingSpheres in world coordinates.
// Sort them in ascending order of distance from the camera.
const position = camera.positionWC;
Cesium.mergeSort(array, function(a, b, position) {
    return Cesium.BoundingSphere.distanceSquaredTo(b, position) - Cesium.BoundingSphere.distanceSquaredTo(a, position);
}, position);

Returns:

Example:

const str = Cesium.objectToQuery({
    key1 : 'some value',
    key2 : 'a/b',
    key3 : ['x', 'y']
});

See:

• queryToObject // str will be: // 'key1=some%20value&key2=a%2Fb&key3=x&key3=y'

Returns:

Example:

// Returns true
const p = new Cesium.Cartesian2(0.25, 0.25);
const b = Cesium.pointInsideTriangle(p,
  new Cesium.Cartesian2(0.0, 0.0),
  new Cesium.Cartesian2(1.0, 0.0),
  new Cesium.Cartesian2(0.0, 1.0));

Returns: