Polygon

new Cesium.Polygon(options)

A renderable polygon or hierarchy of polygons.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
ellipsoid Ellipsoid Ellipsoid.WGS84 optional The ellipsoid that the polygon is drawn on.
positions Array.<Cartesian3> optional The cartesian positions of the polygon.
polygonHierarchy Object optional An object defining the vertex positions of each nested polygon as defined in Polygon#configureFromPolygonHierarchy.
granularity Number CesiumMath.RADIANS_PER_DEGREE optional The distance, in radians, between each latitude and longitude in the underlying geometry.
height Number 0.0 optional The height, in meters, that the rectangle is raised above the Polygon#ellipsoid.
textureRotationAngle Number 0.0 optional The rotation of the texture coordinates, in radians. A positive rotation is counter-clockwise.
show Boolean true optional Determines if this primitive will be shown.
material Material optional The surface appearance of the primitive.
id Object optional A user-defined object to return when the instance is picked with Scene#pick
asynchronous Boolean true optional Determines if the primitive will be created asynchronously or block until ready.
debugShowBoundingVolume Boolean false optional For debugging only. Determines if the primitive's commands' bounding spheres are shown.
Throws:
  • DeveloperError : Either options.positions or options.polygonHierarchy can be provided, but not both.
  • DeveloperError : When options.positions is provided, at least three positions are required.
Examples:
// Example 1
var polygon = new Cesium.Polygon({
  positions : Cesium.Cartesian3.fromDegreesArray([
    0.0, 0.0,
    10.0, 0.0,
    0.0, 10.0
  ])
});
// Example 2
var polygon = new Cesium.Polygon();
polygon.material.uniforms.color = {
  red   : 1.0,
  green : 0.0,
  blue  : 0.0,
  alpha : 1.0
};
polygon.positions = Cesium.Cartesian3.fromDegreesArray([
    0.0, 0.0,
    10.0, 0.0,
    0.0, 10.0
]);
Demo:

Members

asynchronous : Boolean

Determines if the geometry instances will be created and batched on a web worker.
Default Value: true

debugShowBoundingVolume : Boolean

This property is for debugging only; it is not for production use nor is it optimized.

Draws the bounding sphere for each draw command in the primitive.

Default Value: false

ellipsoid : Ellipsoid

The ellipsoid that the polygon is drawn on.
Default Value: Ellipsoid.WGS84

granularity : Number

The distance, in radians, between each latitude and longitude in the underlying geometry. A lower granularity fits the curvature of the Polygon#ellipsoid better, but uses more triangles.
Default Value: CesiumMath.RADIANS_PER_DEGREE

height : Number

The height, in meters, that the polygon is raised above the Polygon#ellipsoid.
Default Value: 0.0

id : Object

User-defined object returned when the polygon is picked.
Default Value: undefined
See:

material : Material

The surface appearance of the primitive. This can be one of several built-in Material objects or a custom material, scripted with Fabric.

The default material is Material.ColorType.

Default Value: Material.fromType(Material.ColorType)
Example:
// 1. Change the color of the default material to yellow
polygon.material.uniforms.color = new Cesium.Color(1.0, 1.0, 0.0, 1.0);

// 2. Change material to horizontal stripes
polygon.material = Cesium.Material.fromType(Cesium.Material.StripeType);
See:

positions : Array.<Cartesian3>

Gets or sets positions that define the boundary of the polygon.
Example:
polygon.positions = Cesium.Cartesian3.fromDegreesArray([
    0.0, 0.0,
    10.0, 0.0,
    0.0, 10.0
]);

show : Boolean

Determines if this primitive will be shown.
Default Value: true

textureRotationAngle : Number

The angle, in radians, relative to north that the polygon's texture is rotated. Positive angles rotate counter-clockwise.
Default Value: 0.0