Class: PolygonGraphics

PolygonGraphics

new PolygonGraphics(optionsopt)

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.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
hierarchy Property <optional>
 A Property specifying the PolygonHierarchy.
height Property <optional>
 0 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 <optional>
 true A boolean Property specifying the visibility of the polygon.
fill Property <optional>
 true A boolean Property specifying whether the polygon is filled with the provided material.
material MaterialProperty <optional>
 Color.WHITE A Property specifying the material used to fill the polygon.
outline Property <optional>
 false A boolean Property specifying whether the polygon is outlined.
outlineColor Property <optional>
 Color.BLACK A Property specifying the Color of the outline.
outlineWidth Property <optional>
 1.0 A numeric Property specifying the width of the outline.
stRotation Property <optional>
 0.0 A numeric property specifying the rotation of the polygon texture counter-clockwise from north.
granularity Property <optional>
 Cesium.Math.RADIANS_PER_DEGREE A numeric Property specifying the angular distance between each latitude and longitude point.
perPositionHeight Property <optional>
 false A boolean specifying whether or not the the height of each position is used.
closeTop Boolean <optional>
 true When false, leaves off the top of an extruded polygon open.
closeBottom Boolean <optional>
 true When false, leaves off the bottom of an extruded polygon open.
shadows Property <optional>
 ShadowMode.DISABLED 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.
Source:
See:

Members

closeBottom :Property

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

closeTop :Property

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

(readonly) definitionChanged :Event

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

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.
Type:
Source:

fill :Property

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

granularity :Property

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

height :Property

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

hierarchy :Property

Gets or sets the Property specifying the PolygonHierarchy.
Type:
Source:

material :MaterialProperty

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

outline :Property

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

outlineColor :Property

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

outlineWidth :Property

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

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.
Type:
Source:

shadows :Property

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

show :Property

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

stRotation :Property

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

Methods

clone(resultopt) → {PolygonGraphics}

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

merge(source)

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