BlockageDiagram.SetOverlayText(StringArray, 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 colors)

 

 

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.

 

 

colors


Description:

An Array containing the colors of each overlay text.

 

 

 

Syntax

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

 

 

See also

BlockageDiagram Object

BlockageDiagram.SetOverlayText

Blockage Diagram Viewpoints Guide

Coverage and Contact Analysis Guide

Blockage Diagrams Guide