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 |
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 |
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.
| Note |
|
Property Type
|
Float-point value
|
||
|
Name String
|
Transparency
|
||
|
Get: Yes
|
Set: Yes
|
Init: Yes
|
Registered: Yes
|
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.
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 |
| Note |
| Note |
|
Property Type
|
Floating-point array
|
||
|
Name String
|
not displayed
|
||
|
Get: Yes
|
Set: Yes
|
Init: Yes
|
Registered: No
|
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].
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
|
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.
An integer value that determines whether depth testing is disabled.
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.
This property is registered as an enumerated list, but it is hidden by default.
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.
Less means closer to the viewer.
This property is registered as an enumerated list, but it is hidden by default.
An integer value that determines whether depth writing is disabled.
Disabling depth writing allows an object to be overdrawn by other objects, even if the object is located in front of them.
This property is registered as an enumerated list, but it is hidden by default.
An integer value that specifies which axis is being created. Specify 0 (zero) to create an X axis, 1 (one) to create a Y axis, or 2 to create a Z axis. Specifying this property is the same as specifying the optional Direction argument.
This property is registered as an enumerated list, but it is hidden by default.
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.
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.
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 the GRIDSTYLE property equal to one of the following integer values:
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:
A Boolean value indicating whether this object should be drawn. Options:
In property sheets, this property appears as an enumerated list, with the following options:
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
|
A Boolean value that indicates whether the axis is logarithmic.
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.
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.
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.
A Boolean value indicating whether the tick labels and the axis title should be drawn.
In a property sheet, this property appears as an enumerated list. Options:
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).
This property is registered as a user-defined property, but it is hidden by default.
An object reference to the object that contains this object.
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
|
A Boolean value that determines whether to register properties available for this object. Set this property to automatically register the following properties of the object for display in a property sheet. This property is useful mainly when creating iTools. By default, no properties are registered.
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.
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:
|
Property Type
|
Floating-point vector
|
||
|
Name String
|
not displayed
|
||
|
Get: Yes
|
Set: Yes
|
Init: Yes
|
Registered: No
|
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
|
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.
In a property sheet, this property appears as an enumerated list. Options:
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:
|
Property Type
|
Floating-point vector
|
||
|
Name String
|
not displayed
|
||
|
Get: Yes
|
Set: Yes
|
Init: Yes
|
Registered: No
|
A floating-point value in points between 1.0 and 10.0 that specifies the line thickness used to draw the axis. The default is 1.0 points.
In a property sheet, this property appears as a Thickness drop-down list with the following options:
An integer value of zero or one to indicate the tick mark direction.
In a property sheet, this property appears as an enumerated list, with the following options:
A string, or an array of strings, in which each string represents a format string or the name of a function to be used to format the tick mark labels. 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.
The callback function is called with four parameters: Axis, Index, Value, and Level, where:
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.
| Note |
Used with the LABEL_DATE function, this property can easily create axes with date/time labels.
|
Property Type
|
String or string array
|
||
|
Name String
|
not displayed
|
||
|
Get: Yes
|
Set: Yes
|
Init: Yes
|
Registered: No
|
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 |
|
Property Type
|
Scalar of any type
|
||
|
Name String
|
not displayed
|
||
|
Get: Yes
|
Set: Yes
|
Init: Yes
|
Registered: No
|
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.
An integer scalar that indicates the tick layout style to be used to draw each level of the axis.
Valid values include:
| Note |
In a property sheet, this property appears as an enumerated list with the following options:
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.
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 |
|
Property Type
|
Object reference or string vector
|
||
|
Name String
|
not displayed
|
||
|
Get: Yes
|
Set: Yes
|
Init: Yes
|
Registered: No
|
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:
If any of the time units are utilized, then the tick values are interpreted as Julian date/time values. Note that the singular form of each of the time value strings is also acceptable (e.g, TICKUNITS='Day' is equivalent to TICKUNITS='Days').
| Note |
This property is registered as a user-defined property, but it is hidden by default.
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
|
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.
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.
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.
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
|
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
|
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
|
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
|
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
|
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
|
ALPHA_CHANNEL added: 6.1