PolylineGraphics

new Cesium.PolylineGraphics(options)
DataSources/PolylineGraphics.js 46

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.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
show Property true optional A boolean Property specifying the visibility of the polyline.
positions Property optional A Property specifying the array of Cartesian3 positions that define the line strip.
width Property 1.0 optional A numeric Property specifying the width in pixels.
granularity Property Cesium.Math.RADIANS_PER_DEGREE optional A numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE.
material MaterialProperty Color.WHITE optional A Property specifying the material used to draw the polyline.
depthFailMaterial MaterialProperty optional A property specifying the material used to draw the polyline when it is below the terrain.
arcType ArcType ArcType.GEODESIC optional The type of line the polyline segments must follow.
clampToGround Property false optional A boolean Property specifying whether the Polyline should be clamped to the ground.
shadows Property ShadowMode.DISABLED optional An enum Property specifying whether the polyline casts or receives shadows from each light source.
distanceDisplayCondition Property optional A Property specifying at what distance from the camera that this polyline will be displayed.
classificationType Property ClassificationType.BOTH optional An enum Property specifying whether this polyline will classify terrain, 3D Tiles, or both when on the ground.
zIndex Property 0 optional A Property specifying the zIndex used for ordering ground geometry. Only has an effect if `clampToGround` is true and polylines on terrain is supported.
Demo:
See:

Members

arcType : Property
DataSources/PolylineGraphics.js 148

Gets or sets the ArcType Property specifying whether the line segments should be great arcs, rhumb lines or linearly connected.
Default Value: ArcType.GEODESIC

clampToGround : Property
DataSources/PolylineGraphics.js 157

Gets or sets the boolean Property specifying whether the polyline should be clamped to the ground.
Default Value: false

classificationType : Property
DataSources/PolylineGraphics.js 181

Gets or sets the ClassificationType Property specifying whether this polyline will classify terrain, 3D Tiles, or both when on the ground.
Default Value: ClassificationType.BOTH

readonlydefinitionChanged : Event
DataSources/PolylineGraphics.js 84

Gets the event that is raised whenever a property or sub-property is changed or modified.

depthFailMaterial : MaterialProperty
DataSources/PolylineGraphics.js 140

Gets or sets the Property specifying the material used to draw the polyline when it fails the depth test.

Requires the EXT_frag_depth WebGL extension to render properly. If the extension is not supported, there may be artifacts.

Default Value: undefined

distanceDisplayCondition : Property
DataSources/PolylineGraphics.js 173

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this polyline will be displayed.

granularity : Property
DataSources/PolylineGraphics.js 120

Gets or sets the numeric Property specifying the angular distance between each latitude and longitude if arcType is not ArcType.NONE and clampToGround is false.
Default Value: Cesium.Math.RADIANS_PER_DEGREE

material : MaterialProperty
DataSources/PolylineGraphics.js 128

Gets or sets the Property specifying the material used to draw the polyline.
Default Value: Color.WHITE

positions : Property
DataSources/PolylineGraphics.js 104

Gets or sets the Property specifying the array of Cartesian3 positions that define the line strip.

shadows : Property
DataSources/PolylineGraphics.js 166

Get or sets the enum Property specifying whether the polyline casts or receives shadows from each light source.
Default Value: ShadowMode.DISABLED

show : Property
DataSources/PolylineGraphics.js 96

Gets or sets the boolean Property specifying the visibility of the polyline.
Default Value: true

width : Property
DataSources/PolylineGraphics.js 112

Gets or sets the numeric Property specifying the width in pixels.
Default Value: 1.0

zIndex : ConstantProperty
DataSources/PolylineGraphics.js 189

Gets or sets the zIndex Property specifying the ordering of the polyline. Only has an effect if `clampToGround` is true and polylines on terrain is supported.
Default Value: 0

Methods

clone(result) → PolylineGraphics
DataSources/PolylineGraphics.js 198

Duplicates this instance.
Name Type Description
result PolylineGraphics optional The object onto which to store the result.
Returns:
The modified result parameter or a new instance if one was not provided.

merge(source)
DataSources/PolylineGraphics.js 223

Assigns each unassigned property on this object to the value of the same property on the provided source object.
Name Type Description
source PolylineGraphics The object to be merged into this object.