Class: PointGraphics

PointGraphics

new PointGraphics(options)

Describe the graphic points located at the location containing the Entity.

Name Type Description
options Object optional

Object is an object that contains the following properties:

Name Type Default Description
show Property true optional

Boolean attribute, specifying the visibility of the line.

pixelSize Property 1 optional

The number attribute specifies the pixel size of a point.

heightReference Property HeightReference.NONE optional

The HeightReference property specifies the relative reference point of the height.

color Property Color.WHITE optional

The Color property specifies the color of a point.

outlineColor Property Color.BLACK optional

The Color property specifies the color of the contour.

outlineWidth Property 0 optional

The number attribute specifies the pixel width of the contour.

scaleByDistance Property optional

The NearFarScalar property is used to scale the size of a point based on its distance from the camera.

translucencyByDistance Property optional

The NearFarScalar property is used to modify the transparency of a point based on its distance from the camera.

distanceDisplayCondition Property optional

The DistanceDisplayCondition property specifies how far the point is displayed from the camera.

disableDepthTestDistance Property optional

The number attribute specifies that depth detection is turned off when the distance from the point to the camera is less than a specified value.

Members

colorProperty

Get or set the Color property to specify the color of a point.

Default Value:
Color.WHITE

readonly definitionChangedEvent

Get events. This event is thrown when the value of a property or sub property is modified, or when the definition is modified.

disableDepthTestDistanceProperty

Get or set the distance between the bulletin board and the camera. When the distance between the bulletin board and the camera is less than this distance, turn off depth detection. For example, to prevent being cut off due to terrain obstruction. When the value is 0, always enable depth detection. The value is Number. POSITIVE.INFINITY, and depth detection is always turned off.

distanceDisplayConditionProperty

Get or set the DistanceDisplayCondition property to specify how far away the point is from the camera for display.

heightReferenceProperty

Get or set the HeightReference property

Default Value:
HeightReference.NONE

outlineColorProperty

Get or set the Color property to specify the color of the contour.

Default Value:
Color.BLACK

outlineWidthProperty

Get or set the number property to specify the pixel width of the contour.

Default Value:
0

pixelSizeProperty

Get or set the number property to specify the pixel size of a point.

Default Value:
1

scaleByDistanceProperty

Get or set the NearFarScalar property to scale the size of a point based on its distance from the camera. If not specified, a constant value will be used.

showProperty

Get the visibility of the set point, of type boolean.

Default Value:
true

translucencyByDistanceProperty

Get or set the NearFarScalar property to modify the transparency of a point based on its distance from the camera. When the camera distance is within the specified range of NearFarScalar # nearValue and NearFarScalar # farValue, the translucency of the point will be interpolated between NearFarScalar # nearValue and NearFarScalar # farValue. Outside of these ranges, the translucency of the points will remain within the nearest range.

Methods

clone(result){PointGraphics}

Copy instance

Name Type Description
result PointGraphics optional

The object that stores the copied results

Returns:
Type Description
PointGraphics If input parameters are provided, return the modified input parameter object. If no input parameters are provided, return a new instance.

merge(source)

Assign the attribute values corresponding to the source object to all unspecified attributes of this instance.

Name Type Description
source PointGraphics

An object that provides attribute values.