PolygonGraphics

new Cesium.PolygonGraphics(options)
DataSources/PolygonGraphics.js 49

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.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
hierarchy Property optional A Property specifying the PolygonHierarchy.
height Property 0 optional A numeric Property specifying the altitude of the polygon relative to the ellipsoid surface.
extrudedHeight Property optional A numeric Property specifying the altitude of the polygon's extruded face relative to the ellipsoid surface.
show Property true optional A boolean Property specifying the visibility of the polygon.
fill Property true optional A boolean Property specifying whether the polygon is filled with the provided material.
material MaterialProperty Color.WHITE optional A Property specifying the material used to fill the polygon.
outline Property false optional A boolean Property specifying whether the polygon is outlined.
outlineColor Property Color.BLACK optional A Property specifying the Color of the outline.
outlineWidth Property 1.0 optional A numeric Property specifying the width of the outline.
stRotation Property 0.0 optional A numeric property specifying the rotation of the polygon texture counter-clockwise from north.
granularity Property Cesium.Math.RADIANS_PER_DEGREE optional A numeric Property specifying the angular distance between each latitude and longitude point.
perPositionHeight Property false optional A boolean specifying whether or not the the height of each position is used.
closeTop Boolean true optional When false, leaves off the top of an extruded polygon open.
closeBottom Boolean true optional When false, leaves off the bottom of an extruded polygon open.
shadows Property ShadowMode.DISABLED optional An enum Property specifying whether the polygon casts or receives shadows from each light source.
distanceDisplayCondition Property optional A Property specifying at what distance from the camera that this polygon will be displayed.
Demo:
See:

Members

closeBottom : Property
DataSources/PolygonGraphics.js 210

Gets or sets a boolean specifying whether or not the bottom of an extruded polygon is included.

closeTop : Property
DataSources/PolygonGraphics.js 203

Gets or sets a boolean specifying whether or not the top of an extruded polygon is included.

readonlydefinitionChanged : Event
DataSources/PolygonGraphics.js 95

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

extrudedHeight : Property
DataSources/PolygonGraphics.js 139

Gets or sets the numeric Property specifying the altitude of the polygon extrusion. If PolygonGraphics#perPositionHeight is false, the volume starts at PolygonGraphics#height and ends at this altitude. If PolygonGraphics#perPositionHeight is true, the volume starts at the height of each PolygonGraphics#hierarchy position and ends at this altitude.

fill : Property
DataSources/PolygonGraphics.js 163

Gets or sets the boolean Property specifying whether the polygon is filled with the provided material.
Default Value: true

granularity : Property
DataSources/PolygonGraphics.js 147

Gets or sets the numeric Property specifying the angular distance between points on the polygon.
Default Value: {CesiumMath.RADIANS_PER_DEGREE}

height : Property
DataSources/PolygonGraphics.js 130

Gets or sets the numeric Property specifying the constant altitude of the polygon.
Default Value: 0.0

hierarchy : Property
DataSources/PolygonGraphics.js 122

Gets or sets the Property specifying the PolygonHierarchy.

material : MaterialProperty
DataSources/PolygonGraphics.js 115

Gets or sets the Property specifying the material used to fill the polygon.
Default Value: Color.WHITE

outline : Property
DataSources/PolygonGraphics.js 171

Gets or sets the Property specifying whether the polygon is outlined.
Default Value: false

outlineColor : Property
DataSources/PolygonGraphics.js 179

Gets or sets the Property specifying the Color of the outline.
Default Value: Color.BLACK

outlineWidth : Property
DataSources/PolygonGraphics.js 187

Gets or sets the numeric Property specifying the width of the outline.
Default Value: 1.0

perPositionHeight : Property
DataSources/PolygonGraphics.js 196

Gets or sets the boolean specifying whether or not the the height of each position is used. If true, the shape will have non-uniform altitude defined by the height of each PolygonGraphics#hierarchy position. If false, the shape will have a constant altitude as specified by PolygonGraphics#height.

shadows : Property
DataSources/PolygonGraphics.js 219

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

show : Property
DataSources/PolygonGraphics.js 107

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

stRotation : Property
DataSources/PolygonGraphics.js 155

Gets or sets the numeric property specifying the rotation of the polygon texture counter-clockwise from north.
Default Value: 0

Methods

clone(result) → PolygonGraphics
DataSources/PolygonGraphics.js 235

Duplicates this instance.
Name Type Description
result PolygonGraphics 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/PolygonGraphics.js 264

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