RectangleGraphics

new Cesium.RectangleGraphics(options)
DataSources/RectangleGraphics.js 50

Describes graphics for a Rectangle. The rectangle 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 rectangle.
coordinates Property optional The Property specifying the Rectangle.
height Property 0 optional A numeric Property specifying the altitude of the rectangle 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 rectangle's extruded face relative to the ellipsoid surface.
extrudedHeightReference Property optional A Property specifying what the extrudedHeight is relative to.
rotation Property 0.0 optional A numeric property specifying the rotation of the rectangle clockwise from north.
stRotation Property 0.0 optional A numeric property specifying the rotation of the rectangle texture counter-clockwise from north.
granularity Property Cesium.Math.RADIANS_PER_DEGREE optional A numeric Property specifying the angular distance between points on the rectangle.
fill Property true optional A boolean Property specifying whether the rectangle is filled with the provided material.
material MaterialProperty Color.WHITE optional A Property specifying the material used to fill the rectangle.
outline Property false optional A boolean Property specifying whether the rectangle 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.
shadows Property ShadowMode.DISABLED optional An enum Property specifying whether the rectangle casts or receives shadows from each light source.
distanceDisplayCondition Property optional A Property specifying at what distance from the camera that this rectangle will be displayed.
classificationType Property ClassificationType.BOTH optional An enum Property specifying whether this rectangle will classify terrain, 3D Tiles, or both when on the ground.
zIndex Property 0 optional A Property specifying the zIndex used for ordering ground geometry. Only has an effect if the rectangle is constant and neither height or extrudedHeight are specified.
Demo:
See:

Members

classificationType : Property
DataSources/RectangleGraphics.js 239

Gets or sets the ClassificationType Property specifying whether this rectangle will classify terrain, 3D Tiles, or both when on the ground.
Default Value: ClassificationType.BOTH

coordinates : Property
DataSources/RectangleGraphics.js 119

Gets or sets the Property specifying the Rectangle.

readonlydefinitionChanged : Event
DataSources/RectangleGraphics.js 100

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

distanceDisplayCondition : Property
DataSources/RectangleGraphics.js 231

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

extrudedHeight : Property
DataSources/RectangleGraphics.js 143

Gets or sets the numeric Property specifying the altitude of the rectangle extrusion. Setting this property creates volume starting at height and ending at this altitude.

extrudedHeightReference : Property
DataSources/RectangleGraphics.js 151

Gets or sets the Property specifying the extruded HeightReference.
Default Value: HeightReference.NONE

fill : Property
DataSources/RectangleGraphics.js 183

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

granularity : Property
DataSources/RectangleGraphics.js 175

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

height : Property
DataSources/RectangleGraphics.js 127

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

heightReference : Property
DataSources/RectangleGraphics.js 135

Gets or sets the Property specifying the HeightReference.
Default Value: HeightReference.NONE

material : MaterialProperty
DataSources/RectangleGraphics.js 191

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

outline : Property
DataSources/RectangleGraphics.js 199

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

outlineColor : Property
DataSources/RectangleGraphics.js 207

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

outlineWidth : Property
DataSources/RectangleGraphics.js 215

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

rotation : Property
DataSources/RectangleGraphics.js 159

Gets or sets the numeric property specifying the rotation of the rectangle clockwise from north.
Default Value: 0

shadows : Property
DataSources/RectangleGraphics.js 224

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

show : Property
DataSources/RectangleGraphics.js 112

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

stRotation : Property
DataSources/RectangleGraphics.js 167

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

zIndex : ConstantProperty
DataSources/RectangleGraphics.js 247

Gets or sets the zIndex Property specifying the ordering of the rectangle. Only has an effect if the rectangle is constant and neither height or extrudedHeight are specified.
Default Value: 0

Methods

clone(result) → RectangleGraphics
DataSources/RectangleGraphics.js 256

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

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