GraphicsOverlay.AddOverlayElement(String, Variable, Variable, Variable, Variable) Method

Top

Description

Adds a geometric element to the active shape of the GraphicsOverlay using the element type specified by 'mode'.

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

Method Signature

GraphicsOverlay.AddOverlayElement(	String mode,
	Variable e1,
	Variable e2,
	Variable e3,
	Variable overlayColor)

Arguments

mode

Description:

Determines if the specific coordinates represent a x-y-z coordinate or a ra-dec-radius coordinate. All coordinates are stored in Cartesian form regardless of how they are specified.

Valid Values:

Value	Label
"x-y-z"	x-y-z
"ra-dec-radius"	ra-dec-radius

e1
Description:	When the mode is 'x-y-z' this represents the x component of the position associated with this overlay element. When the mode is 'ra-dec-radius' this represents the right ascension of this overlay element. These coordinates are referenced from the fixed frame of the ReferenceObject of the GraphicsOverlay object.

e2
Description:	When the mode is 'x-y-z' this represents the y component of the position associated with this overlay element. When the mode is 'ra-dec-radius' this represents the declination of this overlay element. These coordinates are referenced from the fixed frame of the ReferenceObject of the GraphicsOverlay object.

e3
Description:	When the mode is 'x-y-z' this represents the z component of the position associated with this overlay element. When the mode is 'ra-dec-radius' this represents the radius of this overlay element. These coordinates are referenced from the fixed frame of the ReferenceObject of the GraphicsOverlay object.

overlayColor
Description:	The color associated with this shape element.

Syntax

myGraphicsOverlay1.AddOverlayElement(myString1, myVariable1, myVariable2, myVariable3, myVariable4);