# PolygonGraphics

#### new Cesium.PolygonGraphics(options)
DataSources/PolygonGraphics.js 53

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
--- | --- | --- | ---
`show` | Property | `true` | optional A boolean Property specifying the visibility of the polygon.
`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.
`heightReference` | Property |  | optional A Property specifying what the height is relative to.
`extrudedHeight` | Property |  | optional A numeric Property specifying the altitude of the polygon's extruded face relative to the ellipsoid surface.
`extrudedHeightReference` | Property |  | optional A Property specifying what the extrudedHeight is relative to.
`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.
`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.
`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.
`arcType` | Property | `ArcType.GEODESIC` | optional The type of line the polygon edges must follow.
`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.
`classificationType` | Property | `ClassificationType.BOTH` | optional An enum Property specifying whether this polygon will classify terrain, 3D Tiles, or both when on the ground.
`zIndex` | ConstantProperty | `0` | optional A property specifying the zIndex used for ordering ground geometry. Only has an effect if the polygon is constant and neither height or extrudedHeight are specified.

##### Demo:

- Cesium Sandcastle Polygon Demo

##### See:

- Entity

### Members

#### arcType : Property
DataSources/PolygonGraphics.js 248

Gets or sets the `ArcType` Property specifying the type of lines the polygon edges use.

Default Value: `ArcType.GEODESIC`

#### classificationType : Property
DataSources/PolygonGraphics.js 272

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
DataSources/PolygonGraphics.js 240

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

#### closeTop : Property
DataSources/PolygonGraphics.js 233

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

#### readonlydefinitionChanged : Event
DataSources/PolygonGraphics.js 109

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

#### distanceDisplayCondition : Property
DataSources/PolygonGraphics.js 264

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

#### extrudedHeight : Property
DataSources/PolygonGraphics.js 153

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
DataSources/PolygonGraphics.js 161

Gets or sets the Property specifying the extruded `HeightReference`.

Default Value: `HeightReference.NONE`

#### fill : Property
DataSources/PolygonGraphics.js 185

Gets or sets the boolean Property specifying whether the polygon is filled with the provided material.

Default Value: `true`

#### granularity : Property
DataSources/PolygonGraphics.js 177

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 136

Gets or sets the numeric Property specifying the constant altitude of the polygon.

Default Value: `0.0`

#### heightReference : Property
DataSources/PolygonGraphics.js 144

Gets or sets the Property specifying the `HeightReference`.

Default Value: `HeightReference.NONE`

#### hierarchy : Property
DataSources/PolygonGraphics.js 128

Gets or sets the Property specifying the `PolygonHierarchy`.

#### material : MaterialProperty
DataSources/PolygonGraphics.js 193

Gets or sets the Property specifying the material used to fill the polygon.

Default Value: `Color.WHITE`

#### outline : Property
DataSources/PolygonGraphics.js 201

Gets or sets the Property specifying whether the polygon is outlined.

Default Value: `false`

#### outlineColor : Property
DataSources/PolygonGraphics.js 209

Gets or sets the Property specifying the `Color` of the outline.

Default Value: `Color.BLACK`

#### outlineWidth : Property
DataSources/PolygonGraphics.js 217

Gets or sets the numeric Property specifying the width of the outline.

Default Value: `1.0`

#### perPositionHeight : Property
DataSources/PolygonGraphics.js 226

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 257

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 121

Gets or sets the boolean Property specifying the visibility of the polygon.

Default Value: `true`

#### stRotation : Property
DataSources/PolygonGraphics.js 169

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

Default Value: `0`

#### zIndex : ConstantProperty
DataSources/PolygonGraphics.js 280

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
DataSources/PolygonGraphics.js 289

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 323

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.