MapViewpointOptions Object

The MapViewpointOptions object allows the user to configure a 2D map type Viewpoint object. This object is not creatable in script, but is always created as a child object of the Viewpoint object as seen in the example below:

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

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.

Name	Description	Attributes
Body	The celestial object whose surface will be mapped.	Type: Variable Access: Read/Write
CenterLatitude	The latitude of the center of the 2D map.	Type: Variable Access: Read/Write Units: deg
CenterLongitude	The longitude of the center of the 2D map.	Type: Variable Access: Read/Write Units: deg
CenterObject	A Vehicle who's projected location determines the center of the map. When this property is zero, CenterLatitude and CenterLongitude will be used instead.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Force2to1AspectRatio	Determines whether the map is always drawn with a 2:1 aspect ratio regardless of the dimensions of the ViewWindow.	Type: Variable Access: Read/Write
Height	The height of the 2D map.	Type: Variable Access: Read/Write Units: deg
LatitudeGridLabelColor	The color used to render the latitude grid labels.	Type: Variable Access: Read/Write
LatitudeGridLabelFont	The font used to draw labels for the latitude grid	Type: ViewFont Access: Read/Write
LatitudeGridLabelFormat	The printf-style format used to convert the corresponding grid latitude into a string. When 'auto' is specifed the format will be automatically managed according to the current viewpoint and window size.	Type: String Access: Read/Write
LatitudeGridLabelInterval	The ratio of latitude grid lines to labels. For example, if the interval is one there will be one label for each line. If the interval is two there will be one label for every two grid lines. If the interval is zero, the ratio will be automatically managed according to the current viewpoint and window size.	Type: Variable Access: Read/Write
LatitudeGridLabelLocation	Determines if and where the longitude grid labels are drawn. If the grid is not visible, this property has no effect.	Type: Variable Access: Read/Write
LatitudeGridLineColor	The color with which the latitude grid lines will be drawn.	Type: Variable Access: Read/Write
LatitudeGridLineOpacity	The opacity with which the latitude grid lines will be drawn.	Type: Variable Access: Read/Write
LatitudeGridLineSpacing	The spacing between adjacent latitude grid lines. When this value is zero the grid line spacing will be automatically managed according to the current viewpoint and window size.	Type: Variable Access: Read/Write Units: deg
LatitudeGridLineWidth	The line width of the latitude grid lines.	Type: Variable Access: Read/Write Units: pixel
LongitudeGridLabelColor	The color used to render the longitude grid labels.	Type: Variable Access: Read/Write
LongitudeGridLabelFont	The font used to draw labels for the longitude grid	Type: ViewFont Access: Read/Write
LongitudeGridLabelFormat	The printf-style format used to convert the corresponding grid longitude into a string. When 'auto' is specifed the format will be automatically managed according to the current viewpoint and window size.	Type: String Access: Read/Write
LongitudeGridLabelInterval	The ratio of longitude grid lines to labels. For example, if the interval is one there will be one label for each line. If the interval is two there will be one label for every two grid lines. If the interval is zero, the ratio will be automatically managed according to the current viewpoint and window size.	Type: Variable Access: Read/Write
LongitudeGridLabelLocation	Determines if and where the latitude grid labels are drawn. If the grid is not visible, this property has no effect.	Type: Variable Access: Read/Write
LongitudeGridLineColor	The color with which the longitude grid lines will be drawn.	Type: Variable Access: Read/Write
LongitudeGridLineOpacity	The opacity with which the longitude grid lines will be drawn.	Type: Variable Access: Read/Write
LongitudeGridLineSpacing	The spacing between adjacent longitude grid lines. When this value is zero the grid line spacing will be automatically managed according to the current viewpoint and window size.	Type: Variable Access: Read/Write Units: deg
LongitudeGridLineWidth	The line width of the longitude grid lines.	Type: Variable Access: Read/Write Units: pixel
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
ReferenceFrame	The coordinate frame in which offsets to the camera are applied.	Type: String Access: Read/Write
ShowLatitudeLongitudeGrid	Determines whether a latitude/longitude grid is drawn over the map.	Type: Variable Access: Read/Write
ShowSensorSwaths	Determines whether sensor swath histories are shown. Needs to be set before the first View or Update command; not dynamically controllable.	Type: Variable Access: Read/Write
ShowTerminatorShadow	Determines whether the areas of the mapped body obscured from the Sun are drawn with either a muted color or night texture.	Type: Variable Access: Read/Write
Width	The width of the 2D map.	Type: Variable Access: Read/Write Units: deg

MapViewpointOptions Object

Description

Available In Editions:

Timing Precision Mode