BlockageDiagram.GetOverlayText(StringArray, Array, Array, Array, Array, Array, Array) Method

Top

Description

Fills the array arguments with the contents, location, and color of any overlay text associated with 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.GetOverlayText(	StringArray contents,
	Array xPositions,
	Array yPositions,
	Array positionModes,
	Array reds,
	Array greens,
	Array blues)

Arguments

contents
Description:	A StringArray to hold the contents of each overlay text.

xPositions
Description:	An Array to hold the x positions of each overlay text.

yPositions
Description:	An Array to hold the y positions of each overlay text.

positionModes
Description:	An Array to hold the position modes of each overlay text.

reds
Description:	An Array to hold the red components of the colors of each overlay text.

greens
Description:	An Array to hold the green components of the colors of each overlay text.

blues
Description:	An Array to hold the blue components of the colors of each overlay text.

Return Value

Type:

number

Returns the number of overlay texts.

Syntax

myVariable1 = myBlockageDiagram1.GetOverlayText(myStringArray1, myArray1, myArray2, myArray3, myArray4, myArray5, myArray6);