Description | Example | Return message | Group

VO AttFOMLegend

Display the Attitude Coverage contours legend.

Syntax

VO <AttFOMObjectPath> AttFOMLegend {GfxType} {DisplayOption1} <Value> [{DisplayOption2} <Value> ...]

Description

Related commands

This command will allow you to display the contours legend in a pop-up window.

If contours do not exist, the command will NACK.

This command is only available when running STK Desktop.

GfxType options are:

{GfxType}Description
StaticDisplays attitude coverage data for all points based on evaluation over the entire attitude coverage interval.
AnimationDisplays coverage data for all points based on the current animation time.

{DisplayOption} can be:

{DisplayOption}<Value>Description
DisplayOnThe contours legend displays in a pop-up window.
OffThe contours legend window is closed.
BackgroundColor{Color}Specify the legend background color. For valid {Color} options see Common Options.
TextColor{Color}Specify the text color for the legend. For valid {Color} options see Common Options.
Title"<Title>"The text to appear at the top of the contours legend.
DecimalDigits<Value>The precision, or number of digits that should display to the right of the decimal point, with which real numbers should display.
FPFormatfSelect the legend format.

FPFormat values are case-sensitive.

e
E
LevelOrderHorizMinToMaxContours Legend should display horizontally in the 3D Graphics window and contour levels should appear in ascending order.
HorizMaxToMinContours Legend should display horizontally in the 3D Graphics window and contour levels should appear in descending order.
VertMinToMaxContours Legend should display vertically in the 3D Graphics window and contour levels should appear in ascending order.
VertMaxToMinContours Legend should display vertically in the 3D Graphics window and contour levels should appear in descending order.
LevelMax<MaxValue> If LevelOrder is HorizMinTolMax or HorizMaxToMin, enter a number between 1 and 1000 representing the number of colors per row. If LevelOrder is VertMinToMax or VertMaxToMin, enter a number between 1 and 1000 representing the number of colors per column.
ColorSqWidth<WidthValue>Pixel value between 1 and 100 representing the width of individual color bands.
ColorSqHeight<HeightValue>Pixel value between 1 and 100 representing the height of individual color bands.

Examples

To display the static legend:

VO */Satellite/FOMTest1/AttitudeCoverage/FOMTest/AttitudeFigureOfMerit/FOMTest AttFOMLegend Static Display On

Examples

To change the background color and title of the static legend:

VO */Satellite/FOMTest1/AttitudeCoverage/FOMTest/AttitudeFigureOfMerit/FOMTest AttFOMLegend Static BackgroundColor red Title "Its a Static Legend"

Return message

Group membership

This command belongs to the following group(s):

Attitude

Attitude Coverage

Coverage

Version

6.1