IDLgrAxis objects have the following properties in addition to properties inherited from any superclasses. Properties with the word “Yes” in the “Get” column of the property table can be retrieved via IDLgrAxis::GetProperty. Properties with the word “Yes” in the “Init” column of the property table can be set via IDLgrAxis::Init. Properties with the word “Yes” in the “Set” column in the property table can be set via IDLgrAxis::SetProperty.
Note: For a discussion of the property description tables shown below, see Modifying Object Property Descriptions.
Objects of this class have the following properties.
In addition, objects of this class inherit:
ALL
An anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.
Note: The fields of this structure may change in subsequent releases of IDL.
|
Property Type
|
Structure |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
ALPHA_CHANNEL
A floating-point value in the range [0.0, 1.0] to specify the opacity of the entire axis, including tick text and title text. The default value of 1.0 causes IDL to draw the axis completely opaque. If the value of this property is less than 1.0, then the pixels of the axis are blended with the pixels already on the screen, where the color of the axis is multiplied by the alpha value and the pixels already on the screen are multiplied by 1.0-alpha. Because an object can only be blended with objects already drawn on the screen, the drawing order of the objects must be considered carefully in order to obtain the desired results. This property has no effect on devices using indexed color mode. When the USE_TEXT_COLOR property is set to a non-zero value, the tick and title text is drawn using the value of the ALPHA_CHANNEL property from the tick and/or title text objects. In other words, USE_TEXT_COLOR also implies using the text objects’ alpha as well as its color.
|
Property Type
|
Float-point value
|
|
Name String
|
Transparency
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
AM_PM
A string array of 2 names to be used for the names of the AM and PM string when processing explicitly formatted dates (CAPA, CApA, and CapA format codes) with the TICKFORMAT property.
|
Property Type
|
String array |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
ANTIALIAS
A Boolean value that indicates whether anti-aliasing should be used when drawing the lines. The default is 0, which disables anti-aliasing.
|
Property Type
|
BOOLEAN |
|
Name String
|
Anti-aliasing
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
CLIP_PLANES
A 4 by n floating-point array that specifies the coefficients of the clipping planes to be applied to this object. The four coefficients for each clipping plane are of the form [A, B, C, D], where Ax + By + Cz + D = 0. Portions of this object that fall in the half space Ax + By + Cz + D > 0 will be clipped. By default, the value of this property is a scalar (-1) indicating that no clipping planes are to be applied.
Note: The clipping planes specified via this property are applied in addition to the near and far clipping planes associated with the IDLgrView in which this object appears.
Note: Clipping planes are applied in the data space of this object (prior to the application of any x, y, or z coordinate conversion).
Note: To determine the maximum number of clipping planes supported by the device, use the MAX_NUM_CLIP_PLANES property of the GetDeviceInfo method for the IDLgrBuffer, IDLgrClipboard, IDLgrWindow, and IDLgrVRML objects.
|
Property Type
|
Floating-point array
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
COLOR
The color to be used as the foreground color for this axis. The color may be specified as a color lookup table index or as a three-element vector [red, green, blue]. The default is [0, 0, 0].
|
Property Type
|
Color |
|
Name String
|
Color |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
CRANGE
A double-precision floating-point vector of the form [minval, maxval] that will contain the actual full range of the axis. This computed range may not exactly match the requested range provided via the RANGE property due to tick mark rounding and effects of the EXTEND property.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
DAYS_OF_WEEK
A string array of 7 names to be used for the names of the days of the week when processing explicitly formatted dates (CDWA, CDwA, and CdwA format codes) with the TICKFORMAT property.
|
Property Type
|
String array |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
DEPTH_TEST_DISABLE
An integer value that determines whether depth testing is disabled.
|
0 |
Inherit the value set by the parent model or view (the default). The parent view always enables depth testing. A model may also enable or disable depth testing.
|
|
1 |
Explicitly disable depth buffer testing while drawing this object.
|
|
2 |
Explicitly enable depth testing for this object
|
Disabling depth testing allows an object to draw itself “on top” of other objects already on the screen, even if the object is located behind them.
Note: Disabling depth testing also disables depth buffer writing. When disabling depth testing, the DEPTH_TEST_FUNCTION and DEPTH_WRITE_DISABLE properties are effectively ignored.
This property is registered as an enumerated list, but it is hidden by default.
|
Property Type
|
ENUMLIST
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
DEPTH_TEST_FUNCTION
An integer value that determines the depth test function. Set this property to 0 (the default) to inherit the value set by the parent model or view. The parent view always sets a depth test function of LESS. A model may also set a depth test function value. The graphics device compares the object’s depth at a particular pixel location with the depth stored in the depth buffer at that same pixel location. If the comparison test passes, the object’s pixel is drawn at that location on the screen and the depth buffer is updated (if depth writing is enabled).
Set this property to any of the following values to use the desired function while rendering this object.
|
0 |
INHERIT |
Use value from parent model or view
|
|
1 |
NEVER |
Never passes |
|
2 |
LESS |
Passes if the object’s depth is less than the depth buffer’s value
|
|
3 |
EQUAL |
Passes if the object’s depth is equal to the depth buffer’s value
|
|
4 |
LESS OR EQUAL |
Passes if the object’s depth is less than or equal to the depth buffer’s value
|
|
5 |
GREATER |
Passes if the object’s depth is greater than or equal to the depth buffer’s value
|
|
6 |
NOT EQUAL |
Passes if the object’s depth is not equal to the depth buffer’s value
|
|
7 |
GREATER OR EQUAL
|
Passes if the object’s depth is greater than or equal to the depth buffer’s value
|
|
8 |
ALWAYS |
Always passes |
Less means closer to the viewer.
This property is registered as an enumerated list, but it is hidden by default.
|
Property Type
|
ENUMLIST |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
DEPTH_WRITE_DISABLE
An integer value that determines whether depth writing is disabled:
|
0 |
Inherit the value set by the parent model or view (the default). The parent view always enables depth writing. A model may also enable or disable depth writing.
|
|
1 |
Explicitly disable depth buffer writing while rendering this object.
|
|
2 |
Explicitly enable depth writing for this object.
|
Disabling depth writing allows an object to be overdrawn by other objects, even if the object is located in front of them.
Note: If depth testing (see DEPTH_TEST_DISABLE property) is disabled, depth writing is also automatically disabled.
This property is registered as an enumerated list, but it is hidden by default.
|
Property Type
|
ENUMLIST |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
DIRECTION
An integer value that specifies which axis is being created:
|
0 |
Create X axis |
|
1 |
Create Y axis |
|
2 |
Create Z axis |
Specifying this property is the same as specifying the optional Direction argument to the IDLgrAxis::Init method.
This property is registered as an enumerated list, but it is hidden by default.
|
Property Type
|
ENUMLIST |
|
Name String
|
Direction |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
EXACT
A Boolean value that determines whether to force the axis range to be exactly as specified. If this property is not set, the range may be lengthened or shortened slightly to allow for evenly spaced tick marks.
|
Property Type
|
Boolean |
|
Name String
|
Use exact axis range
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
EXTEND
A Boolean value that determines whether to extend the axis slightly beyond the range of data to be plotted, which is a value specified by the RANGE property. This can be useful when you specify the axis range based on the minimum and maximum data values, but do not want the graphic to extend all the way to the end of the axis. The amount by which the axis is extended is determined by the system using a number of factors, including the MAJOR property of the axis.
|
Property Type
|
Boolean |
|
Name String
|
Extend axis |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
GRIDSTYLE
An integer or two-element vector that indicates the line style that should be used to draw the axis’ tick marks. The value can be either an integer value specifying a pre-defined line style, or a two-element vector specifying a stippling pattern.
To use a pre-defined line style, set this property equal to one of the following integer values:
|
0 |
Solid line (the default)
|
|
1 |
Dotted |
|
2 |
Dashed |
|
3 |
Dash dot |
|
4 |
Dash dot dot dot
|
|
5 |
Long dash |
|
6 |
No line drawn |
To define your own stippling pattern, specify a two-element vector [repeat, bitmask], where repeat indicates the number of times consecutive runs of 1’s or 0’s in the bitmask should be repeated. (That is, if three consecutive 0’s appear in the bitmask and the value of repeat is 2, then the line that is drawn will have six consecutive bits turned off.) The value of repeat must be in the range 1 ≤ repeat ≤ 255.
The bitmask indicates which pixels are drawn and which are not along the length of the line. Bitmask is most conveniently specified as a 16-bit hexadecimal value.
For example, GRIDSTYLE = [2, 'F0F0'X] describes a dashed line (8 bits on, 8 bits off, 8 bits on, 8 bits off).
In a property sheet, this property appears as a Linestyle drop-down list, with the following options:
|
Property Type
|
Linestyle |
|
Name String
|
Line style |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
HIDE
A Boolean value or enumerated list item indicating whether this object should be drawn. Options:
|
Value |
Property Sheet Value
|
Description |
|
0 |
True |
Draw graphic (the default)
|
|
1 |
False |
Do not draw graphic
|
|
Property Type
|
ENUMLIST |
|
Name String
|
Show |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
LOCATION
A two- or three-element floating-point vector of the form [x, y] or [x, y, z] to specify the coordinate through which the axis should pass. The default is [0, 0, 0]. IDL converts, maintains, and returns this data as double-precision floating-point.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
LOG
A Boolean value that indicates whether the axis is logarithmic.
|
Property Type
|
Boolean |
|
Name String
|
Use logarithmic axis
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
MAJOR
An integer representing the number of major tick marks. The default is -1, specifying that IDL will compute the number of tickmarks. Setting MAJOR equal to zero suppresses major tickmarks entirely.
|
Property Type
|
Integer |
|
Name String
|
Number of major ticks
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
MINOR
An integer representing the number of minor tick marks. The default is -1, specifying that IDL will compute the number of tickmarks. Setting MINOR equal to zero suppresses minor tickmarks entirely.
|
Property Type
|
Integer |
|
Name String
|
Number of minor ticks
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
MONTHS
A string array of 12 names to be used for the names of the months when processing explicitly formatted dates (CMOA, CMoA, and CmoA format codes) with the TICKFORMAT property.
|
Property Type
|
String array |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
NOTEXT
A Boolean value or an enumerated list item indicating whether the tick labels and the axis title should be drawn.
|
Value |
Property Sheet Value
|
Description |
|
0 |
True |
Draw tick labels and axis title (the default)
|
|
1 |
False |
Do not draw tick labels and axis title
|
|
Property Type
|
ENUMLIST |
|
Name String
|
Text show |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
PALETTE
The object reference of a palette object (an instance of the IDLgrPalette object class) that defines the color palette of this object. This property is only used if the destination device is using the RGB color model. If so, and a color value for the object is specified as a color index value, the palette set by this property is used to translate the color to RGB space. If the PALETTE property on this object is not set, the destination object PALETTE property is used (which defaults to a grayscale ramp).
Note: Objects specified via this property are not automatically cleaned up when the IDLgrAxis object is destroyed.
This property is registered as a user-defined property, but it is hidden by default.
|
Property Type
|
USERDEF |
|
Name String
|
Color palette |
|
Get: Yes |
Set: No |
Init: No |
Registered: Yes
|
PARENT
An object reference to the object that contains this object.
|
Property Type
|
Object reference
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
RANGE
A two-element floating-point vector containing the minimum and maximum data values covered by the axis. The default is [0.0, 1.0]. IDL converts, maintains, and returns this data as double-precision floating-point.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
REGISTER_PROPERTIES
A Boolean value that determines whether to register properties available for this object. If this property is set, all properties marked in this properties section as “Registered: Yes” will be registered for display in a property sheet. This property is useful mainly when creating iTools. By default, no properties are registered.
|
Property Type
|
Boolean |
|
Name String
|
not displayed
|
|
Get: No |
Set: No |
Init: Yes
|
Registered: No
|
SHADER
An object reference to an IDLgrShader object (or an object containing IDLgrShader as a superclass). When there is suitable graphics card hardware support, the axis is rendered using the GLSL shader program (executed on the graphics card) instead of using fixed OpenGL properties when initially drawn. (If a suitable graphics card is not present, IDL ignores the shader object when the scene is drawn.) A single IDLgrShader object may be associated with additional axis objects or other graphic objects that have the SHADER property.
|
Property Type
|
Object reference
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
SUBGRIDSTYLE
An integer or two-element vector that indicates the line style that should be used to draw the minor tick marks. The value can be either an integer value specifying a pre-defined line style, or a two-element vector specifying a stippling pattern. The default is -1, which indicates that the line style for minor ticks should follow the line style for the major ticks.
To use a pre-defined line style, set this property equal to one of the following values:
| -1 |
Same as major ticks |
|
0 |
Solid line |
|
1 |
Dotted |
|
2 |
Dashed |
|
3 |
Dash dot |
|
4 |
Dash dot dot dot
|
|
5 |
Long dash |
|
6 |
No line drawn |
To define your own stippling pattern, specify a two-element vector [repeat, bitmask], where repeat indicates the number of times consecutive runs of 1’s or 0’s in the bitmask should be repeated. (That is, if three consecutive 0’s appear in the bitmask and the value of repeat is 2, then the line that is drawn will have six consecutive bits turned off.) The value of repeat must be in the range 1 ≤ repeat ≤ 255.
|
Property Type
|
Linestyle |
|
Name String
|
Minor tick line style
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
SUBTICKLEN
A floating-point scale ratio specifying the length of minor tick marks relative to the length of major tick marks. The default is 0.5, specifying that the minor tick mark is one-half the length of the major tick mark.
|
Property Type
|
FLOAT |
|
Name String
|
Minor tick length
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TEXTALIGNMENTS
A two-element floating-point vector, [horizontal, vertical], specifying the horizontal and vertical alignments for the tick text. Each alignment value should be a value between 0.0 and 1.0. For horizontal alignment, 0.0 left-justifies the text; 1.0 right-justifies the text. For vertical alignment, 0.0 bottom-justifies the text, 1.0 top-justifies the text.
The defaults are as follows:
- X-Axis: [0.5, 1.0] (centered horizontally, top-justified vertically)
- Y-Axis: [1.0, 0.5] (right-justified horizontally, centered vertically)
- Z-Axis: [1.0, 0.5] (right-justified horizontally, centered vertically)
Set this property to a scalar value to restore the default values after they have been explicitly set.
|
Property Type
|
Floating-point scalar or vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
TEXTBASELINE
A two- or three-element floating-point vector describing the direction in which the baseline of the tick text is to be oriented. Use this property in conjunction with the TEXTUPDIR property to specify the plane on which the tick text lies. The default is [1,0,0].
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
TEXTPOS
An integer that indicates on which side of the axis to draw the tick text labels. The table below describes the placement of the tick text with each setting.
|
Axis |
TEXTPOS = 0 |
TEXTPOS = 1 |
|
X |
Tick text will be drawn below the X axis, where below is defined as being toward the direction of the negative Y axis (this is the default).
|
Tick text will be drawn above the X axis, where above is described as being toward the direction of the positive Y axis.
|
|
Y |
Tick text will be drawn to the left of the Y Axis, where left is defined as being toward the direction of the negative X axis (this is the default).
|
Tick text will be drawn to the right of the Y axis, where right is defined as being toward the direction of the positive X axis.
|
|
Z |
Tick text will be drawn to the left of the Z axis, where left is defined as being toward the direction of the negative X axis (this is the default).
|
Tick text will be drawn to the right of the Z axis, where right is defined as being toward the direction of the positive X axis.
|
In a property sheet, this property appears as an enumerated list. Options:
- Below/left: Text will be drawn below the axis and to the left.
- Above/right: Text will be drawn above the axis and to the right.
|
Property Type
|
ENUMLIST |
|
Name String
|
Text position |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TEXTUPDIR
A two- or three-element floating-point vector describing the direction in which the up-vector of the tick text is to be oriented. Use this property in conjunction with the TEXTBASELINE property to specify the plane on which the tick text lies. TEXTUPDIR should be orthogonal to TEXTBASELINE. The default is as follows:
- X-Axis: [0, 1, 0]
- Y-Axis: [0, 1, 0]
- Z-Axis: [0, 0, 1]
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
THICK
A floating-point value in points between 0.0 and 10.0 that specifies the line thickness used to draw the axis. A thickness of 0 displays a thin hairline on the chosen device. Out-of-range values are quietly clamped to the allowed range. The default is 1.0 points.
In a property sheet, this property appears as a Thickness drop-down list with the following options:
|
Property Type
|
Thickness |
|
Name String
|
Line thickness |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TICKDIR
An integer value of zero or one to indicate the tick mark direction.
|
Axis |
TICKDIR = 0 |
TICKDIR = 1 |
|
X |
Tick marks will be drawn above the X axis, in the direction of the positive Y axis (this is the default).
|
Tick marks will be drawn below the X axis.
|
|
Y |
Tick marks will be drawn to the right of the Y axis, in the direction of the positive X axis (this is the default).
|
Tick marks will be drawn to the left of the Y axis.
|
|
Z |
Tick marks will be drawn to the right the Z axis, in the direction of the positive X axis (this is the default).
|
Tick marks will be drawn to the left of the Z axis.
|
In a property sheet, this property appears as an enumerated list, with the following options:
- Right/above: Tick marks will be drawn above the axis and to the right.
- Left/below: Tick marks will be drawn below the axis and to the left.
|
Property Type
|
ENUMLIST |
|
Name String
|
Tick direction |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TICKFORMAT
Set this property to a string which represents a format string or the name of a function to be used to format the tick mark labels. TICKFORMAT can also be set to an array of format strings for each tick mark. If an array is provided, each string corresponds to a level of the axis. (The TICKUNITS property determines the number of levels for an axis.) If the number of strings stored in this property is one, GetProperty returns a scalar string, otherwise GetProperty returns an array of strings.
If the string begins with an open parenthesis, it is treated as a standard format string. (See Format Codes.)
If the string does not begin with an open parenthesis, it is interpreted as the name of a callback function to be used to generate tick mark labels. This function is defined with either three or four parameters, depending on whether TICKUNITS is specified.
If TICKUNITS are not specified:
- The callback function is called with three parameters: Axis, Index, and Value, where:
- Axis is the axis number: 0 for X axis, 1 for Y axis, 2 for Z axis
- Index is the tick mark index (indices start at 0)
- Value is the data value at the tick mark (a double-precision floating point value)
If TICKUNITS are specified:
The callback function is called with four parameters: Axis, Index, Value, and Level, where:
- Axis, Index, and Value are the same as described above.
- Level is the index of the axis level for the current tick value to be labeled. (Level indices start at 0.)
Whether or not TICKUNITS is specified, the callback function can also define a DATA keyword. If the callback function accepts the DATA keyword, it will be set equal to the value (if any) of the TICKFRMTDATA property.
|
Property Type
|
String or string array
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
TICKFRMTDATA
A value of any type that will be passed to the user-supplied formatting callback function (specified via the TICKFORMAT property) as the value of the DATA keyword. By default, this value is undefined, indicating that the value of the DATA keyword will be undefined.
Note: TICKFRMTDATA will not be included in the structure returned via the ALL property to the IDLgrAxis::GetProperty method.
|
Property Type
|
Scalar of any type
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
TICKINTERVAL
A floating-point scalar indicating the interval between major tick marks for the first axis level. The default value is computed according to the axis RANGE and the number of major tick marks (MAJOR). This property takes precedence over MAJOR.
For example, if TICKUNITS=['S','H','D'], and TICKINTERVAL=30, then the interval between major ticks for the first axis level will be 30 seconds.
|
Property Type
|
FLOAT |
|
Name String
|
Tick interval |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TICKLAYOUT
An integer scalar or enumerated list item that indicates the tick layout style to be used to draw each level of the axis. Valid values include:
|
Value |
Property Sheet Value
|
Description |
|
0 |
Axis plus labels
|
The axis line, major tick marks and tick labels are all included. Minor tick marks only appear on the first level of the axis. This is the default tick layout style.
|
|
1 |
Labels only |
Only the labels for the major tick marks are drawn. The axis line, major tick marks, and minor tick marks are omitted.
|
|
2 |
Box style |
Each major tick interval is outlined by a box. The tick labels are positioned within that box (left-aligned). For the first axis level only, the major and minor tick marks will also be drawn.
|
Note: For all tick layout styles, at least one tick label will appear on each level of the axis (even if no major tick marks fall along the axis line). If there are no major tick marks, the single tick label will be centered along the axis.
|
Property Type
|
ENUMLIST |
|
Name String
|
Tick layout |
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TICKLEN
A floating-point value that specifies the length of each major tick mark, measured in data units. The recommended, and default, tick mark length is 0.2. IDL converts, maintains, and returns this data as double-precision floating-point.
|
Property Type
|
FLOAT |
|
Name String
|
Major tick length
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TICKTEXT
An object reference to a single instance of the IDLgrText object class (with multiple strings) or a vector of instances of the IDLgrText object class (one per major tick) to specify the annotations to be assigned to the tickmarks. By default, with TICKTEXT set equal to a null object, IDL computes the tick labels based on major tick values. The positions of the provided text objects may be overwritten; position is determined according to tick mark location. The tickmark text will have the same color as the IDLgrAxis object, regardless of the color specified by the COLOR property of the IDLgrText object or objects, unless the USE_TEXT_COLOR property is specified.
Note: If IDL computes the tick labels, the text object it creates will be destroyed automatically when the axis object is destroyed, even if you have altered the properties of the text object. If you create your own text object containing tickmark text, however, it will not be destroyed automatically.
|
Property Type
|
Object reference or string vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
TICKUNITS
A string (or a vector of strings) indicating the units to be used for axis tick labeling. If the number of levels in the axis is one, GetProperty returns a scalar string, otherwise GetProperty returns an array of strings.
If more than one unit is provided, the axis will be drawn in multiple levels, one level per unit.
The order in which the strings appear in the vector determines the order in which the corresponding unit levels will be drawn. The first string corresponds to the first level (the level nearest to the primary axis line).
Valid unit strings include:
- "" - The default, indicating that no tick units are being set. IDLgrAxis will use regular numbers (non-scientific notation) for tick labels in the range to 10-4 to 104, and scientific notation for tick labels smaller than 10-4 or larger than 104.
- "Numeric" - IDLgrAxis will use regular numbers (non-scientific notation) for tick labels in the range to 10-10 to 1010, and scientific notation for tick labels smaller than 10-10 or larger than 1010.
- "Scientific" - IDLgrAxis will use scientific (exponential) notation for all tick labels (except 0.0).
- "Years" - The tick values are in years. IDL will assume that the tick values are in Julian date/times and will only label the "year" portion.
- "Months" - The tick values are in months. IDL will assume that the tick values are in Julian date/times and will only label the "month" portion.
- "Days" - The tick values are in days. IDL will assume that the tick values are in Julian date/times and will only label the "day" portion.
- "Hours" - The tick values are in hours. IDL will assume that the tick values are in Julian date/times and will only label the "hour" portion.
- "Minutes" - The tick values are in minutes. IDL will assume that the tick values are in Julian date/times and will only label the "minute" portion.
- "Seconds" - The tick values are in seconds. IDL will assume that the tick values are in Julian date/times and will only label the "second" portion.
- "Time" - Use this value to indicate that the tick values are time values; IDL will determine the appropriate time intervals and tick label formats based upon the range of values covered by the axis.
Note: The singular form of each of the time value strings is also acceptable (e.g, TICKUNITS='Day' is equivalent to TICKUNITS='Days').
Note: Julian values must be in the range -1095 to 1827933925, which corresponds to calendar dates 1 Jan 4716 B.C.E. and 31 Dec 5000000 A.D., respectively.
This property is registered as a user-defined property, but it is hidden by default.
|
Property Type
|
STRING |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: Yes
|
TICKVALUES
A floating-point vector of data values representing the values at each tick mark. If TICKVALUES is set to 0, the default, IDL computes the tick values based on the axis range and the number of major ticks. IDL converts, maintains, and returns this data as double-precision floating-point.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
TITLE
An object reference to an instance of the IDLgrText object class that specifies the title for the axis. The default is the null object, specifying that no title is drawn. The title will be centered along the axis, even if the text object itself has an associated location. The title will have the same color as the IDLgrAxis object, regardless of the color specified by the COLOR property of the IDLgrText object, unless the USE_TEXT_COLOR property is specified.
Note: Objects specified via this property are not automatically cleaned up when the IDLgrAxis object is destroyed.
The IDLgrText object becomes a child of the IDLgrAxis object; therefore, to use the same IDLgrText object for multiple axes, you must use multiple IDLgrAxis objects.
|
Property Type
|
Object reference
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
USE_TEXT_COLOR
A Boolean value that indicates whether, for the tick text and/or title of the axis, the color property values set for the given IDLgrText objects are to be used to draw those text items. By default, this value is zero, indicating that the color properties of the IDLgrText objects will be ignored, and that the COLOR property for the axis object will be used for these text items instead.
|
Property Type
|
Boolean |
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
XCOORD_CONV
A floating-point vector, [s0, s1], of scaling factors that convert X coordinates from data units to normalized units. The formula for the conversion is as follows:
NormalizedX = s0 + s1 * DataX
Recommended values are:
[(-Xmin)/(Xmax-Xmin), 1/(Xmax-Xmin)]
The default is [0.0, 1.0]. IDL converts, maintains, and returns this data as double-precision floating-point.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
XRANGE
A two-element double-precision floating-point vector of the form [xmin, xmax] that specifies the range of x data coordinates covered by the graphic object.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
YCOORD_CONV
A floating-point vector, [s0, s1], of scaling factors that convert Y coordinates from data units to normalized units. The formula for the conversion is as follows:
NormalizedY = s0 + s1 * DataY
Recommended values are:
[(-Ymin)/(Ymax-Ymin), 1/(Ymax-Ymin)]
The default is [0.0, 1.0]. IDL converts, maintains, and returns this data as double-precision floating-point.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
YRANGE
A two-element double-precision floating-point vector of the form [ymin, ymax] that specifies the range of y data coordinates covered by the graphic object.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|
ZCOORD_CONV
A floating-point vector, [s0, s1], of scaling factors used to convert Z coordinates from data units to normalized units. The formula for the conversion is as follows:
NormalizedZ = s0 + s1 * DataZ
Recommended values are:
[(-Zmin)/(Zmax-Zmin), 1/(Zmax-Zmin)]
The default is [0.0, 1.0]. IDL converts, maintains, and returns this data as double-precision floating-point.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: Yes |
Init: Yes
|
Registered: No
|
ZRANGE
A two-element double-precision floating-point vector of the form [zmin, zmax] that specifies the range of z data coordinates covered by the graphic object.
|
Property Type
|
Floating-point vector
|
|
Name String
|
not displayed
|
|
Get: Yes |
Set: No |
Init: No |
Registered: No
|