Description
The PlotAxis object is used to configure the axes of a PlotWindow object. This object is not creatable in script, but an instance is automatically created for the X, Y, R, and Theta axes of the PlotWindow object, as seen in the examples below:
PlotWindow1.XAxis.GridVisible = 0;
PlotWindow1.YAxis.GridVisible = 0;
PlotWindow1.RAxis.GridVisible = 0;
PlotWindow1.ThetaAxis.GridVisible = 0;
You can assign PlotAxis objects using the = operator.
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.
Inheritance Hierarchy: ObjectàPlotBaseObjectàPlotAxis
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Name
|
Description
|
DeclaredName
|
The name of the object as declared.
|
Direction
|
Specifies whether the axis minimum and maximum scales will be swapped.
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
GridColor
|
Sets the color of the grid lines.
|
GridLineStyle
|
Sets the style of the grid lines.
|
GridLineWidth
|
Sets the width of the grid lines.
|
GridVisible
|
Sets whether the grid lines are visible.
|
LabelsArrangement
|
Sets how the labels will be displayed on the axis. Possible choices are Normal, Multi-line and Alternate. The Alternate option displays successive labels in alternating columns for vertical axes or alternating rows for horizontal axes. Use the Alternate setting when more labels are desired in a smaller area. The Multi-line option breaks up long date labels onto multiple lines. This option only works if the axis is displaying date-formatted strings and the date format contains a space.
|
LabelsColor
|
Sets the current color of the label text.
|
LabelsFont
|
Provides access to the Label's font properties.
|
LabelsFormat
|
Sets the formatting string that will be used to display the values for the labels. The formatting string follows the standard C# formatting as used with the .NET ToString() method. Example formats: '0.000', '#,##0.###', and '00e-0'. See the help file for more information and additional examples.
|
LabelsSpacing
|
Sets the spacing between labels on the axis. Setting this value to 0 will automatically determine the spacing between labels on the plot.
|
Location
|
Specifies whether axis will be moved to opposite side (Left to Right, Bottom to top, etc).
|
MaximumValue
|
Sets the maximum value displayed on the axis. Setting this property will set UseAutoMaximum to false. Note: If the axis is displaying date-formatted strings, use the TimeTools object to convert the desired maximum date to a Modified Julian Date variable in TAI.
|
MinimumValue
|
Sets the minimum value displayed on the axis. Setting this property will set UseAutoMinimum to false. Note: If the axis is displaying date-formatted strings, use the TimeTools object to convert the desired minimum date to a Modified Julian Date variable in TAI.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
Scaling
|
Specifies whether the scaling for the Axis will be normal (linear) or logarithmic.
|
Title
|
Provides access to the Axis' title properties.
|
UseAutoMaximum
|
Sets whether or not the axis maximum value is automatically set by the plot. This is set to false if the MaximumValue property is set by the user.
|
UseAutoMinimum
|
Sets whether or not the axis minimum value is automatically set by the plot. This is set to false if the MinimumValue property is set by the user.
|
UseDateTimeFormatting
|
Sets whether or not the axis values will be formatted into a Date/Time string according to the LabelsFormat property.
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetRange
|
This method will set both the minimum and maximum values for the axis. Setting this property will set AutoScale to false. Note: If the axis is displaying date-formatted strings, use the TimeTools object to convert the desired minimum date to a Julian-formatted variable in TAI.
|
|
See also
PlotWindow Guide
|
