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

Top

Description

Adds an annotation element to the active shape of the GraphicsOverlay. When used, this overload will set the type of the active shape to be Annotations.

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(	Variable x,
	Variable y,
	Variable z,
	String annotationValue,
	Variable overlayColor)

Arguments

x
Description:	The x-component of the position associated with this overlay element. This is referenced to the fixed frame of the ReferenceObject of the prefix GraphicsOverlay object.
Units:	km

y
Description:	The y-component of the position associated with this overlay element. This is referenced to the fixed frame of the ReferenceObject of the prefix GraphicsOverlay object.
Units:	km

z
Description:	The z-component of the position associated with this overlay element. This is referenced to the fixed frame of the ReferenceObject of the prefix GraphicsOverlay object.
Units:	km

annotationValue
Description:	The text of the annotation to add to the shape.

overlayColor
Description:	The color associated with this shape element.

Syntax

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