StarMapViewpointOptions Object

The StarMapViewpointOptions object allows the user to configure a Star Map view 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
CenterDeclination	The declination of the center of the star map.	Type: Variable Access: Read/Write Units: deg
CenterRightAscension	The right ascension of the center of the star map.	Type: Variable Access: Read/Write Units: deg
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DeclinationGridLabelColor	The color used to draw the declination labels.	Type: Variable Access: Read/Write
DeclinationGridLabelFont	The font used to draw labels for the declination grid	Type: ViewFont Access: Read/Write
DeclinationGridLabelFormat	The printf-style format used to convert the corresponding grid declination 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
DeclinationGridLabelInterval	The ratio of declination 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
DeclinationGridLabelLocation	Determines if and where the declination grid labels are drawn. If the grid is not visible, this property has no effect.	Type: Variable Access: Read/Write
DeclinationGridLineColor	The color with which the declination grid lines will be drawn.	Type: Variable Access: Read/Write
DeclinationGridLineOpacity	The opacity with which the declination grid lines will be drawn.	Type: Variable Access: Read/Write
DeclinationGridLineSpacing	The spacing between adjacent declination 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
DeclinationGridLineWidth	The line width of the declination grid lines.	Type: Variable Access: Read/Write Units: pixel
Force2to1AspectRatio	Determines whether the star 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 star map.	Type: Variable Access: Read/Write Units: deg
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
ReferenceObject	The reference object to be used as the origin of the star map. The valid reference object types are Spacecraft and GroundVehicle.	Type: Variable Access: Read/Write
RightAscensionGridLabelColor	The color used to draw the right-ascension labels.	Type: Variable Access: Read/Write
RightAscensionGridLabelFont	The font used to draw labels for the right ascension grid	Type: ViewFont Access: Read/Write
RightAscensionGridLabelFormat	The printf-style format used to convert the corresponding grid right-ascension 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
RightAscensionGridLabelInterval	The ratio of right-ascension 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
RightAscensionGridLabelLocation	Determines if and where the right ascension grid labels are drawn. If the grid is not visible, this property has no effect.	Type: Variable Access: Read/Write
RightAscensionGridLineColor	The color with which the right-ascension grid lines will be drawn.	Type: Variable Access: Read/Write
RightAscensionGridLineOpacity	The opacity with which the right-ascension grid lines will be drawn.	Type: Variable Access: Read/Write
RightAscensionGridLineSpacing	The spacing between adjacent right-ascension 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
RightAscensionGridLineWidth	The line width of the right-ascension grid lines.	Type: Variable Access: Read/Write Units: pixel
ShowDeclinationRightAscensionGrid	Determines whether a declination/right ascension grid is drawn over the star 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
Width	The width of the star map.	Type: Variable Access: Read/Write Units: deg

StarMapViewpointOptions Object

Description

Available In Editions:

Timing Precision Mode