BlockageDiagram.AddOverlayText(String, Variable, Variable, Variable, Variable) Method

Top

Description

Adds a text overlay that can be displayed to the blockage diagram.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

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

Method Signature

BlockageDiagram.AddOverlayText(	String text,
	Variable xPosition,
	Variable yPosition,
	Variable positionMode,
	Variable color)

Arguments

text
Description:	The text to display.

xPosition
Description:	The x position on the diagram at which to display the text. The meaning of this value is dependent upon the positionMode argument. If the x position is outside the bounds of the blockage diagram, the text will not be displayed.

yPosition
Description:	The y position on the diagram at which to display the text. The meaning of this value is dependent upon the positionMode argument. If the y position is outside the bounds of the blockage diagram, the text will not be displayed.

positionMode

Description:

The mode with which to interpret xPosition and yPosition.

Valid Values:

Value	Label
0	Look Angles : xPosition and yPosition are treated as look angle 1 and 2 values respectively.
1	Pixels Upper Left : xPosition and yPosition are treated as pixel locations with the origin in the upper left.
2	Pixels Lower Left : xPosition and yPosition are treated as pixel locations with the origin in the lower left.

color
Description:	The color in which to display the text.

Syntax

myBlockageDiagram1.AddOverlayText(myString1, myVariable1, myVariable2, myVariable3, myVariable4);