Description | Example | Return Message | Group

MapAnnotation Add

Adds annotations to the 2D Graphics window

Syntax

MapAnnotation <ScenarioPath> Add <AnnotNum> {AnnotType} [<Parameters>]

Related Commands

Description

The MapAnnotation Add command can be used to add annotations to be displayed in the 2D Graphics window by specifying the {AnnotType} and associated parameters.

To add an annotation, the <AnnotNum> must be a unique integer. If a duplicate <AnnotNum> is used the command will fail.

Once an annotation is added it can be changed using the MapAnnotation Modify command, or deleted using the MapAnnotation Delete command.

{AnnotType}	{Option}	<Parameters>
Text	String	"<TextString>"
	Coord	{LatLon \| Screen \| PixelRelative \| Pixel}
	Position	<XPos> <YPos>
	Color	{Color}
	HorizPixelOrigin	{Left \| Right}
	VertPixelOrigin	{Top \| Bottom}
	HorizJustify	{Left \| Center \| Right}
	VertJustify	{Top \| Center \| Bottom}
	FontStyle	{1 \| 2 \| 3} The number indicates the size of the font: enter 1 for small, 2 for medium and 3 for large.
	WindowID	<WinNumber>
Marker	Style	<MarkerNum>
	Coord	{LatLon \| Screen \| PixelRelative \| Pixel}
	Position	<XPos> <YPos>
	Color	{Color}
	HorizPixelOrigin	{Left \| Right}
	VertPixelOrigin	{Top \| Bottom}
	Scale	<ScaleVal> This is a value greater or equal to 1.0.
	Rotation	<RotationVal> Enter a value between 0.0 and 360.0, indicating the number of degrees of rotation.
	WindowID	<WinNumber>
Line	Coord	{LatLon \| Screen \| PixelRelative \| Pixel}
	Position	<NumPts> <XPos1> <YPos1> <XPos2> <YPos2>...
	Color	{Color}
	HorizPixelOrigin	{Left \| Right}
	VertPixelOrigin	{Top \| Bottom}
	Width	<Width> Enter a width value between 1.0 and 10.0
	Style	{LineStyle}. Enter a name such as Solid, Dashed, Dotted, etc, or a number 0, 1, 2, etc. For all valid {LineStyle} options see Common Options.
	Smooth	{Yes \| No}
	WindowID	<WinNumber>
Polygon	Coord	{LatLon \| Screen \| PixelRelative \| Pixel}
	Position	<NumPts> <XPos1> <YPos1> <XPos2> <YPos2>...
	Center	<XPos> <YPos>
	Color	{Color}
	HorizPixelOrigin	{Left \| Right}
	VertPixelOrigin	{Top \| Bottom}
	LineWidth	<Width> Enter a width value between 1.0 and 10.0
	LineStyle	{LineStyle} Enter a name such as Solid, Dashed, Dotted, etc, or a number 0, 1, 2, etc. For all valid {LineStyle} options see Common Options.
	Smooth	{Yes \| No}
	Fill	{Yes \| No}
	FillTranslucency	<Value> Set the percent translucency of the fill. <Value> can be between 0.0 and 100.0
	FillStyle	<FillStyleNum> Enter an integer between 0 and 7 as follows: 0 for Solid 1 for Vertical Stripe 2 for Horizontal Stripe 3 for Diagonal Stripe 1 4 for Diagonal Stripe 2 5 for Hatch 6 for Diagonal Hatch 7 for Screen
	WindowID	<WinNumber>

For valid {Color} options see Common Options.

Note: If Coord is LatLon the Position values are interpreted as <Lon> <Lat> and are entered in degrees (see Examples below). For all other Coord options the Position values are <XPos> <YPos>.

Note: The options HorizPixelOrigin and VertPixelOrigin only affect annotations with Coord set to ScreenRelative or Pixel. The option Smooth is only valid if Coord is set to LatLon.

Example

Add the phrase "Red Text" positioned at 20 degrees Lat and 10 degrees Lon in the 2D Graphics window in red:

MapAnnotation * Add 1 Text String "Red Text" Color Red Position 10.0 20.0

Add the text string "Blue Text" in blue at an X,Y position of 10,50:

MapAnnotation * Add 2 Text String "Blue Text" Color Blue Coord Pixel Position 10.0 50.0

Add a yellow circle marker at 70 degrees Lat (XPos) and 100 degrees Lon (YPos):

MapAnnotation * Add 3 Marker Style 3 Color yellow Position 100.0 70.0

Add a green square marker at pixel position of 10, 50 from the lower right corner of the screen:

MapAnnotation * Add 4 Marker Style 5 Color green Coord Pixel Position 10.0 50.0 HorizPixelOrigin right VertPixelOrigin bottom

Add a white great-arc line from lat, lon 10,5 to 30,0:

MapAnnotation * Add 5 Line Color white Position 2 5.0 10.0 0.0 30.0 Smooth yes

Add a filled cyan great-arc polygon from lat,lon 0,-40 to -80,-60 to 20,-160:

MapAnnotation * Add 6 Polygon Color cyan Position 3 -40.0 0.0 -60.0 -80.0 -160.0 20.0 Smooth yes Fill yes

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

2D Graphics Window

Version

STK Programming Interface 11.0.1