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

Top

Description

Sets the blockage diagram's overlay text from contents, location, and color of the passed arrays. Any positions that are outside of the blockage diagram's range will not be displayed.

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.SetOverlayText(	StringArray contents,
	Array xPositions,
	Array yPositions,
	Array positionModes,
	Array reds,
	Array greens,
	Array blues)

Arguments

contents
Description:	A StringArray containing the contents of each overlay text.

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

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

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

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

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

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

Syntax

myBlockageDiagram1.SetOverlayText(myStringArray1, myArray1, myArray2, myArray3, myArray4, myArray5, myArray6);