HighLow Object Class


Overview

A Chart Object creates a Plot object of type HighLow when the chart type resource is set to XintCHART_TYPE_HIGH_LOW. This plot type is often used for stock prices, to display high/low/open/close information. This type of plot can also be used for scientific data - for example, to indicate temperature ranges. Resource XmNdrawCandlestick is available to draw the HighLow chart as a Candlestick plot.

Data

The HighLow class accepts only DataSampled series for data. You must pass DataGroup objects containing DataSampled objects in the following order: high, low, open and close. You need to pass a DataGroup containing at least two DataSampled series (for the high and low information). Open and close information is optional. Transposition is not supported for this plot object class.

The HighLow object class creates a HighLowSeries object to display a high-low-open-close curve. A maximum of one curve is created for each DataGroup associated with the chart. To display multiple curves you will need to associate additional DataGroup objects, each containing at least two DataSampled objects.


Inherited Behavior and Resources

The HighLow object class inherits behavior and resources from the Xt Object, Graphic, Group and Plot2D object classes.
The following resources are defined by the HighLow object class:
NameTypeDefaultAccess
XmNdrawCandlestickBooleanFalseCSG
XmNshowCloseBooleanTrueCSG
XmNshowGainLossBooleanFalseCSG
XmNshowOpenBooleanTrueCSG
XmNtickLengthint75CSG


XmNdrawCandlestick

Specifies whether or not to draw the chart as a candlestick chart. In a candlestick chart, a filled rectangle is used to draw the area between the open and the close. The width of the rectangle is set by resource XmNtickLength. Resources XmNshowClose, XmNshowOpen are ignored when resource XmNdrawCandlestick is set to True.

XmNshowClose

Specifies whether or not the close indicator is displayed.

XmNshowGainLoss

Specifies whether samples corresponding to a loss are drawn using the same color as the samples corresponding to a gain. See section HighLow Series for a description of the resources to use to set the HighLowSeries colors.

XmNshowOpen

Specifies whether or not the open indicator is displayed.

XmNtickLength

Specifies the length of the open and close indicators as a percentage between 0 and 100. Specify 100 to have the close from one sample connected to the open from the next sample.

Plot2D Object Inherited Resources

See section
Plot2D Object Class for a complete listing of the inherited resources for the HighLow object class.

Macro

Macro XintIsHighLow returns True if the specified object is a HighLow object.

     Boolean XintIsHighLow (Object object)


HighLow Series

The HighLow object class displays its data using HighLowSeries objects. This resource class inherits its resources from the Graphic class. The following is a list of the applicable resources for this class. See class Graphic for a complete description of these resources.

HighLowSeries Resources
NameTypeDefaultAccess
XmNcolorPixelassigned from color listCSG
XmNdashListchar *NULLCSG
XmNgainColorPixel"white"CSG
XmNlineStyleintXintLINE_SOLIDCSG
XmNlineThicknessint1CSG
XmNlossColorPixel"black"CSG
XmNsensitiveBooleanTrueCSG

For a HighLow plot, resource XmNcolor controls the color of the lines when resource XmNshowGainLoss is False. When resource XmNshowGainLoss is True, resources XmNgainColor and XmNlossColor are used to draw the samples corresponding to a gain or a loss respectively.

For a Candlestick plot, resource XmNcolor is used to draw the wick. The color used to draw the body of the candle is specified by resources XmNgainColor or XmNlossColor.