CircleEntity (Circle/Cylinder Entity)

Creates and manages an Entity representing a circle or a cylinder.

Constructor

new ge3d.feature.CircleEntity(options?: {}): CircleEntity

Parameters (StyleOptions)

Parameter	Type	Default	Description
radius	Number	100	Radius
height	Number	0	Height of the circle relative to the ellipsoid surface
heightReference	Cesium.HeightReference	Cesium.HeightReference.NONE	What the height is referenced to
diffHeight	Number	100	Height difference (the cylinder's own height); mutually exclusive with extrudedHeight
extrudedHeight	number	-	Height of the extruded surface relative to the ellipsoid
extrudedHeightReference	Cesium.HeightReference	Cesium.HeightReference.NONE	What the extruded height is referenced to
fill	Boolean	true	Whether the geometry is filled
materialType	String	"Color"	Fill type; see MaterialType
material	Cesium.MaterialProperty | Cesium.Color	Cesium.Color.WHITE	Material used for filling; overrides materialType and its parameters when specified
color	String	"#3388ff"	Fill color
opacity	Number	1.0	Opacity, range 0.0 - 1.0
outline	Boolean	false	Whether to draw an outline
outlineWidth	Number	1	Outline width
outlineColor	String | Cesium.Color	"#ffffff"	Outline color
outlineOpacity	Number	0.6	Outline opacity
outlineStyle	PolylineEntity.StyleOptions	-	Full custom outline style; overrides outlineWidth, outlineColor, etc.
rotation	Number	0	Rotation in radians; 0 means north, counterclockwise positive
rotationDegree	Number	0	Rotation in degrees (0–360); mutually exclusive with rotation
stRotation	Number	0	Texture rotation in radians; 0 means north, counterclockwise positive
stRotationDegree	Number	0	Texture rotation in degrees (0–360); mutually exclusive with stRotation
distanceDisplayCondition	Boolean | Cesium.DistanceDisplayCondition	false	Toggle distance-based visibility, or specify camera distance thresholds
distanceDisplayCondition_far	Number	100000	Far distance
distanceDisplayCondition_near	Number	0	Near distance
granularity	number	Cesium.Math.RADIANS_PER_DEGREE	Angular distance between points on the ellipse
numberOfVerticalLines	number	16	Number of vertical lines drawn along the perimeter
hasShadows	Boolean	false	Whether it casts shadows
shadows	Cesium.ShadowMode	Cesium.ShadowMode.DISABLED	Whether the ellipse casts or receives shadows from light sources
clampToGround	String	false	Whether to clamp to ground
classificationType	Cesium.ClassificationType	Cesium.ClassificationType.BOTH	Coverage type when clamped (terrain, 3D Tiles, or both)
zIndex	Number	0	Render order; effective only when ellipse is constant and height/extrudedHeight are not set
addHeight	Number	0	Extra height added to existing coordinates (commonly used in layers)
highlight	CircleEntity.StyleOptions	-	Highlight style on hover or click (type: 'click'); can also be toggled via openHighlight/closeHighlight
label	LabelEntity.StyleOptions	-	Text label options