EllipseGraphics

new Cesium.EllipseGraphics(options)
DataSources/EllipseGraphics.js 48

Describes an ellipse defined by a center point and semi-major and semi-minor axes. The ellipse 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. The center point is determined by the containing Entity.
Name Type Description
options Object optional Object with the following properties:
Name Type Default Description
semiMajorAxis Property optional The numeric Property specifying the semi-major axis.
semiMinorAxis Property optional The numeric Property specifying the semi-minor axis.
height Property 0 optional A numeric Property specifying the altitude of the ellipse relative to the ellipsoid surface.
extrudedHeight Property optional A numeric Property specifying the altitude of the ellipse's extruded face relative to the ellipsoid surface.
show Property true optional A boolean Property specifying the visibility of the ellipse.
fill Property true optional A boolean Property specifying whether the ellipse is filled with the provided material.
material MaterialProperty Color.WHITE optional A Property specifying the material used to fill the ellipse.
outline Property false optional A boolean Property specifying whether the ellipse 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.
numberOfVerticalLines Property 16 optional A numeric Property specifying the number of vertical lines to draw along the perimeter for the outline.
rotation Property 0.0 optional A numeric property specifying the rotation of the ellipse counter-clockwise from north.
stRotation Property 0.0 optional A numeric property specifying the rotation of the ellipse texture counter-clockwise from north.
granularity Property Cesium.Math.RADIANS_PER_DEGREE optional A numeric Property specifying the angular distance between points on the ellipse.
shadows Property ShadowMode.DISABLED optional An enum Property specifying whether the ellipse casts or receives shadows from each light source.
distanceDisplayCondition Property optional A Property specifying at what distance from the camera that this ellipse will be displayed.
Demo:

Members

classificationType : Property
DataSources/EllipseGraphics.js 234

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

readonlydefinitionChanged : Event
DataSources/EllipseGraphics.js 96

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

distanceDisplayCondition : Property
DataSources/EllipseGraphics.js 226

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

extrudedHeight : Property
DataSources/EllipseGraphics.js 154

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

fill : Property
DataSources/EllipseGraphics.js 178

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

granularity : Property
DataSources/EllipseGraphics.js 162

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

height : Property
DataSources/EllipseGraphics.js 146

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

material : MaterialProperty
DataSources/EllipseGraphics.js 138

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

numberOfVerticalLines : Property
DataSources/EllipseGraphics.js 210

Gets or sets the numeric Property specifying the number of vertical lines to draw along the perimeter for the outline.
Default Value: 16

outline : Property
DataSources/EllipseGraphics.js 186

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

outlineColor : Property
DataSources/EllipseGraphics.js 194

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

outlineWidth : Property
DataSources/EllipseGraphics.js 202

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

rotation : Property
DataSources/EllipseGraphics.js 122

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

semiMajorAxis : Property
DataSources/EllipseGraphics.js 107

Gets or sets the numeric Property specifying the semi-major axis.

semiMinorAxis : Property
DataSources/EllipseGraphics.js 114

Gets or sets the numeric Property specifying the semi-minor axis.

shadows : Property
DataSources/EllipseGraphics.js 219

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

show : Property
DataSources/EllipseGraphics.js 130

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

stRotation : Property
DataSources/EllipseGraphics.js 170

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

Methods

clone(result) → EllipseGraphics
DataSources/EllipseGraphics.js 243

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

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