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:
|
Demo:
See:
Members
arcType : Property
Gets or sets the
ArcType
Property specifying the type of lines the polygon edges use.
-
Default Value:
ArcType.GEODESIC
classificationType : Property
Gets or sets the
ClassificationType
Property specifying whether this polygon will classify terrain, 3D Tiles, or both when on the ground.
-
Default Value:
ClassificationType.BOTH
closeBottom : Property
Gets or sets a boolean specifying whether or not the bottom of an extruded polygon is included.
closeTop : Property
Gets or sets a boolean specifying whether or not the top of an extruded polygon is included.
readonlydefinitionChanged : Event
Gets the event that is raised whenever a property or sub-property is changed or modified.
distanceDisplayCondition : Property
Gets or sets the
DistanceDisplayCondition
Property specifying at what distance from the camera that this polygon will be displayed.
extrudedHeight : Property
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.
extrudedHeightReference : Property
Gets or sets the Property specifying the extruded
HeightReference
.
-
Default Value:
HeightReference.NONE
Gets or sets the boolean Property specifying whether the polygon is filled with the provided material.
-
Default Value:
true
granularity : Property
Gets or sets the numeric Property specifying the angular distance between points on the polygon.
-
Default Value:
{CesiumMath.RADIANS_PER_DEGREE}
Gets or sets the numeric Property specifying the constant altitude of the polygon.
-
Default Value:
0.0
heightReference : Property
Gets or sets the Property specifying the
HeightReference
.
-
Default Value:
HeightReference.NONE
hierarchy : Property
Gets or sets the Property specifying the
PolygonHierarchy
.
Gets or sets the Property specifying the material used to fill the polygon.
-
Default Value:
Color.WHITE
outline : Property
Gets or sets the Property specifying whether the polygon is outlined.
-
Default Value:
false
outlineColor : Property
Gets or sets the Property specifying the
Color
of the outline.
-
Default Value:
Color.BLACK
outlineWidth : Property
Gets or sets the numeric Property specifying the width of the outline.
-
Default Value:
1.0
perPositionHeight : Property
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
Get or sets the enum Property specifying whether the polygon
casts or receives shadows from each light source.
-
Default Value:
ShadowMode.DISABLED
Gets or sets the boolean Property specifying the visibility of the polygon.
-
Default Value:
true
stRotation : Property
Gets or sets the numeric property specifying the rotation of the polygon texture counter-clockwise from north.
-
Default Value:
0
Gets or sets the zIndex Prperty specifying the ordering of ground geometry. Only has an effect if the polygon is constant and neither height or extrudedHeight are specified.
-
Default Value:
0
Methods
clone(result) → PolygonGraphics
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.
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. |