Class: RectangleGraphics

RectangleGraphics

new RectangleGraphics(optionsopt)

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.
Parameters:
Name Type Attributes Description
options Object <optional>
 Object with the following properties:
Properties
Name Type Attributes Default Description
coordinates Property <optional>
 The Property specifying the Rectangle.
height Property <optional>
 0 A numeric Property specifying the altitude of the rectangle relative to the ellipsoid surface.
extrudedHeight Property <optional>
 A numeric Property specifying the altitude of the rectangle's extruded face relative to the ellipsoid surface.
closeTop Property <optional>
 true A boolean Property specifying whether the rectangle has a top cover when extruded
closeBottom Property <optional>
 true A boolean Property specifying whether the rectangle has a bottom cover when extruded.
show Property <optional>
 true A boolean Property specifying the visibility of the rectangle.
fill Property <optional>
 true A boolean Property specifying whether the rectangle is filled with the provided material.
material MaterialProperty <optional>
 Color.WHITE A Property specifying the material used to fill the rectangle.
outline Property <optional>
 false A boolean Property specifying whether the rectangle 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.
rotation Property <optional>
 0.0 A numeric property specifying the rotation of the rectangle clockwise from north.
stRotation Property <optional>
 0.0 A numeric property specifying the rotation of the rectangle texture counter-clockwise from north.
granularity Property <optional>
 Cesium.Math.RADIANS_PER_DEGREE A numeric Property specifying the angular distance between points on the rectangle.
shadows Property <optional>
 ShadowMode.DISABLED 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.
Source:
See:

Members

closeBottom :Property

Gets or sets the boolean Property specifying whether the rectangle has a bottom cover when extruded.
Type:
Default Value:
  • true
Source:

closeTop :Property

Gets or sets the boolean Property specifying whether the rectangle has a top cover when extruded.
Type:
Default Value:
  • true
Source:

coordinates :Property

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

(readonly) definitionChanged :Event

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

distanceDisplayCondition :Property

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

extrudedHeight :Property

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

fill :Property

Gets or sets the boolean Property specifying whether the rectangle 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 rectangle.
Type:
Default Value:
  • {CesiumMath.RADIANS_PER_DEGREE}
Source:

height :Property

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

material :MaterialProperty

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

outline :Property

Gets or sets the Property specifying whether the rectangle 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:

rotation :Property

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

shadows :Property

Get or sets the enum Property specifying whether the rectangle 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 rectangle.
Type:
Default Value:
  • true
Source:

stRotation :Property

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

Methods

clone(resultopt) → {RectangleGraphics}

Duplicates this instance.
Parameters:
Name Type Attributes Description
result RectangleGraphics <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
RectangleGraphics

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 RectangleGraphics The object to be merged into this object.
Source: