Description | Example | Return message | Group

VO DynDataText

Control the display of dynamic data text reports in the 3D window

Syntax

VO <ObjectPath> DynDataText {DynDataTextOption} <Parameters> [{DisplayOption} <Value>] [WindowID <WinNumber>]

Description

The VO DynDataText command allows you to turn on and off, and control the appearance of, a particular VO dynamic data text report.

WindowID <WinNumber> can specify a 3D Graphics window number or All. If no WindowID <WinNumber> is specified, Connect applies the command to all 3D Graphics windows. WindowID <WinNumber> can be entered multiple times on a command, to specify the windows where the data will be displayed.

If the WindowID <WinNumber> option is used to Show an annotation in specific windows, all window ids that are not specified will be set to the opposite Show state.

Prior to STK version 11.1.1 the <WinNumber> could be entered without the WindowID keyword. This option has been deprecated, and WindowID <WinNumber> should be used.

Valid values for {DynDataTextOption} are:

{DynDataTextOption}<Parameters>Description
DataDisplay"<ReportName>"Display the specified report.
Remove"<ReportName>"Remove the display of the specified report.
RemoveAllN/ARemove all dynamic displays.
Access"<ReportName>" <ToTruncObjectPath> [AttachObject <TruncObjectPath>]Display the specified access report. The optional AttachObject parameter allows you to specify the object to which the access display should be attach. The object specified, using <TruncObjectPath>, must be one of the two objects for which access is being computed. If no AttachObject is specified, text is attached to a fixed location in the 3D Graphics window. If the AttachObject option is used, you must specify the AttachPos {DisplayOption} to move the text (see below).
RemoveAccess"<ReportName>" <ToTruncObjectPath> [AttachObject <TruncObjectPath>]Remove the display of the specified access report.
RemoveAllAccess<ToTruncObjectPath>Remove all access reports for the access computed between the <ObjectPath> and the <ToTruncObjectPath>.

Valid values for {DisplayOption} and <Value> are:

Any, all or none of the following {DisplayOption} <Value> pairs can be entered.

{DisplayOption} <Value>Description
Show {On | Off}Turn on or off the display of this dynamic data.
Color {Color}Set the display color. For valid {Color} options see Common Options.
Pos {Origin} <XPos> <YPos> Valid values for {Origin} are BottomLeft, BottomCenter, BottomRight, CenterLeft, Center, CenterRight, TopLeft, TopCenter, TopRight

<XPos> and <YPos> are offsets from the specified origin. <XPos> and <YPos> are integers between 0 and 1000000.

Position {Left | Right | Center} <XPos> {Top | Bottom | Center} <YPos>{Left | Right | Center} indicates the Origin for the X Position. {Top | Bottom | Center} indicates the Origin for the Y Position. <XPos> and <YPos> are integers between 0 and 1000000.

This option is deprecated in STK 10.1. Use the Pos option instead.

Font {Small | Medium | Large}Specify the text font size.
ShowName {Yes | No}Turn on or off the object name in the title.
ShowTitle {On | Off}Turn on or off the display of the report title.
Title "<Title>"Specify a custom title for the data display.
Format {Horizontal | Vertical | NoLabels}Specify whether to display information horizontally, vertically, or with no labels.
BGShow {On | Off}Show or Hide the background for the data display.
BGBorder {On | Off}Turn on or off a border around the data display.
BGBorderColor {Color}Specify the color of the background border. For valid {Color} options see Common Options.
BGTransparent {On | Off}If On the background will be transparent.
BGTranslucency <Value>Specify the translucency of the background. Enter a value between 0.0 and 1.0.
BGColor {Color}Set the background color. For valid {Color} options see Common Options.
BGSize <Width> <Height>Set the size of the background area.
BgAutoWidth {On | Off}Turn on or off auto-sizing of the background width.
BgAutoHeight {On | Off}Turn on or off auto-sizing of the background height.
BGImage {On | Off}Turn on or off the display of a background image file (as specified by the BGImageFile option).
BGImageFile <Filename>Specify a background image file.

"<Filename>" can be the path to a file on your local drive or the path to a file on an SDF server. See Specifying Paths for "<SDFFilePath>" syntax information.

AttachPos {DataArea | Window | Object}Sets the position to which the dynamic data display will be attached.
  • DataArea - Text will be displayed in the data area of the 3D Graphics window.
  • Window - Text will be displayed in a fixed location of the 3D Graphics window.
  • Object - Text will be displayed at the location of an object in the 3D Graphics window. The position of the data display will depend on the type of dynamic data being displayed. If {DynDataTextOption} is DataDisplay, the data display will be attached to the owner of the report specified in the "<ReportName>" parameter. If {DynDataTextOption} is Access, the data display will be attached to AttachObject specified (see Access {DynDataTextOption} above).
PreData "<AdditionalRptData>"Some Report Styles require additional or pre-data, such as a comparison object for the RIC report for a Satellite. For these types of reports you must include the keyword PreData and the "<AdditionalRptData>". Data entered for "<AdditionalRptData>" depends on the report style being used. For more information see PreData section of the ReportCreate command. Also, see example below.

In order to change the PreData for a data display you must remove the data display and then add it again with the desired PreData value.

Examples

To dynamically display AER access data between the aosSat object and the aosFac object in yellow with no labels:

VO */Satellite/aosSat DynDataText Access "AER" Facility/aosFac Show On Color yellow Format NoLabels

To dynamically display AER access data between the aosSat object and the aosFac object in red at the indicated left bottom portion of the second 3D window specified:

VO */Satellite/aosSat DynDataText Access "AER" Facility/aosFac Color red Pos BottomLeft 15 100 WindowID 2

To dynamically display AER access data between the aosSat object and the aosFac object in all open 3D Graphics windows using a medium font:

VO */Satellite/aosSat DynDataText Access "AER" Facility/aosFac Show On Font Medium WindowID All

To dynamically display an AER access report between the aosSat object and the aosFac on a 200 X 100 red transparent background:

VO */Satellite/aosSat DynDataText Access "AER" Facility/aosFac BGShow On BGTransparent On BGSize 200 100 BGColor red

To show the report "AER" as dynamic text displaying access between Satellite1 and Facility1 at the position of Satellite1:

VO */Satellite/Satellite1 DynDataText Access "AER" Facility/Facility1 Show On AttachPos Object AttachObject Satellite/Satellite1

To remove all access dynamic text between Satellite1 and Facility1:

VO */Satellite/Satellite1 DynDataText RemoveAllAccess Facility/Facility1

To show the report "LLA Position" as dynamic text for Satellite1 at the position of Satellite1:

VO */Satellite/Satellite1 DynDataText DataDisplay "LLA Position" Show On AttachPos Window

To remove the report "LLA Position" dynamic text for Satellite1:

VO */Satellite/Satellite1 DynDataText Remove "LLA Position"

To display an RIC report between Satellite1 and Satellite2:

VO */Satellite/Satellite1 DynDataText DataDisplay "RIC" Show On PreData "Satellite/Satellite2"

To display a VectorChooseAxes report, with the Satellite2 Body Axes specified as the additional report data, display at the bottom left of the 3d window:

VO */Satellite/Satellite1 DynDataText DataDisplay "VectorChooseAxes" Show On Color cyan PreData "Satellite/Satellite2 Body Axes" Pos BottomLeft 15 100s

To display the LLA Position report in 3D Windows 1 and 3 (note: the report display will be set to off for any other windows in the scenario):

VO */Satellite/Satellite1 DynDataText DataDisplay "LLA Position" Show On WindowId 1 WindowId 3

Return message

Group membership

This command belongs to the following group(s):

Object Tools

VO

VO Objects

Version

11.7