Stock Chart Properties

DataTextTemplateHiLo

This is a global string property that can be used to define a MACRO-based format for data text labels in a stock chart. The default is a null string. If the default is used, a "[CLOSE]" value is used if the Graph Type has a close data item or "[HIGH]" otherwise. This property can be used to customize the data text labels and insert MACROS for the actual data any place in a defined string. The DataTextDisplay property must be set to true in order for the data text labels to be displayed in the graph.

DATA TYPE:

string

RANGE:

Any printable characters which may or may not include these macros:

OPEN_VALUE_MACRO = "[OPEN]"
HI_VALUE_MACRO = "[HIGH]"
LOW_VALUE_MACRO = "[LOW]"
CLOSE_VALUE_MACRO = "[CLOSE]"

DEFAULT:

Null String

SYNTAX:

void setDataTextTemplateHiLo (String newValue);
String getDataTextTemplateHiLo();

EXAMPLE:

setUseSampleData(false);
setData(0,0,1); 
setData(0,1,10);
setData(0,2,2); 
setData(0,3,9); 
setData(0,4,2);
setData(0,5,11);
setData(0,6,3);
setData(0,7,10);
setData(0,8,3);
setData(0,9,12);
setData(0,10,4);
setData(0,11,11);
setData(1,0,14);
setData(1,1,23);
setData(1,2,12);
setData(1,3,22);
setData(1,4,15);
setData(1,5,24);
setData(1,6,14);
setData(1,7,23);
setData(1,8,16);
setData(1,9,25);
setData(1,10,15);
setData(1,11,24);
setDataRange(0,0,1,12);
setDataTextDisplay(true);
setDataTextFormat(6);
setY1LabelFormat(6);
setLegendDisplay(true);
setSeriesLabel(0, "Company 1");
setSeriesLabel(1, "Company 2");
setGroupLabel(0, "January");
setGroupLabel(1, "February");
setGroupLabel(2, "March");
setStockTickLength(100);
setFillColor(getStockOpenTick(), new Color (255,0,0));
setFillColor(getStockCloseTick(), new Color(255,255,0));
setY1MajorGridStep(2);
setTitleString("GraphType(79);
Open/Hi/Lo/Close Stock Chart");
setGraphType(79);
setDataTextTemplateHiLo("[OPEN]");

setDataTextTemplateHiLo("[CLOSE]");

setDataTextTemplateHiLo("[HIGH]");

setDataTextTemplateHiLo("[LOW]");

ALSO SEE:

DataTextDisplay

InterpretAsHLOC

This property is included in Perspective to support backward compatibility with Hi-Lo-Open-Close datasets that were created in Three |D| Graphics Presentation Graphics Software Development Kit (PGSDK) for stock charts. In Perspective, stock charts that require four values per marker are interpreted as: Open, High, Low, and Close. When this property true, the four values will be interpreted as: High, Low, Open, and Close.

DATA TYPE:

boolean

RANGE:

true/false; true = Interpret data set values as High/Low/Open/Close, false = Interpret data set values as Open/High/Low/Close

DEFAULT:

false

SYNTAX:

void setInterpretAsHLOC(boolean newValue);
boolean setInterpretAsHLOC();

EXAMPLE:

setGraphType(79);
setInterpretAsHLOC(true);

setGraphType(79);
setInterpretAsHLOC(false);

Stock52WeekHighDisplay

This property enables (true) / disables (false) drawing of a 52-week high line in a stock chart. Stock52WeekHighValue defines the 52-week high value and the location of the 52-week high line.

DATA TYPE:

boolean

RANGE:

true / false; true = Draw 52-week high line, false = Do not draw 52-week high line

DEFAULT:

false

SYNTAX:

void setStock52WeekHighDisplay(boolean newValue);
boolean getStock52WeekHighDisplay();

EXAMPLE:

See Stock52WeekHighValue

NOTE:

Defining a Stock52WeekHighValue sets this property to true.

ALSO SEE:

Stock52WeekHighValue, Stock52WeekLowValue, Stock52WeekLowDisplay

Stock52WeekHighValue

This property defines a 52-week high value in a stock chart. Only one line per chart is available.

DATA TYPE:

double

RANGE:

Any value that falls within the data range of the chart.

DEFAULT:

40.0

SYNTAX:

void setStock52WeekHighValue(double newValue);
double getStock52WeekHighValue();

EXAMPLE:

setGraphType(79);
setStock52WeekHighValue(20.0);
setStock52WeekHighDisplay(true);
setFillColor(getStock52WeekHighLine(), new Color (255,0,0);

setStock52WeekHighValue(28.0);

NOTE:

See DataTextTemplateHiLo for the data set that was used to draw this chart.

ALSO SEE:

Stock52WeekHighDisplay

Stock52WeekLowDisplay

This property enables (true) / disables (false) the display of a 52-week low line in a stock chart. The GraphType property must be set to one of the stock charts. However, note that a 52-week low line is not available in bi-polar stock charts. Stock52WeekLowValue defines the 52-week low value and the location where the 52-week low line will be drawn. Only one line per chart is available.

DATA TYPE:

boolean

RANGE:

true / false; true = Draw 52-week low line, false = Do not draw 52-week low line

DEFAULT:

false

SYNTAX:

void setStock52WeekLowDisplay(boolean newValue);
boolean getStock52WeekLowDisplay();

EXAMPLE:

see Stock52WeekLowValue

NOTE:

Defining a Stock52WeekLowValue sets this property to true.

ALSO SEE:

Stock52WeekLowValue, Stock52WeekHighValue, Stock52WeekHighDisplay

Stock52WeekLowValue

This property is used to set a 52-week low value in a stock chart. The GraphType property must be set to one of the stock charts. However note that a 52-week low line is not available for bi-polar stock charts. Stock52WeekLowDisplay must be set to true in order to display a line in the chart identifying the 52-week low value. Only one line per chart is available.

DATA TYPE:

double

RANGE:

Any value that falls within the data range of the chart.

DEFAULT:

10.0

SYNTAX:

void setStock52WeekLowValue(double newValue);
double getStock52WeekLowValue();

EXAMPLE:

setGraphType(79);
setStock52WeekLowValue(6.0);
setStock52WeekLowDisplay(true);
setFillColor(getStock52WeekLowLine(), new Color (255,0,0);

setStock52WeekLowValue(12.0);

NOTE:

See DataTextTemplateHiLo for the data set that was used to draw this chart.

ALSO SEE:

Stock52WeekLowDisplay

StockCloseSplitDisplay

This property enables (true) / disables (false) the display of split risers at the stock close value. The GraphType property must be set to one of the stock charts. If a close value is not available, this property is ignored.

DATA TYPE:

boolean

RANGE:

true / false; true = Split risers at close value, false = Do not split risers at close value

DEFAULT:

true

SYNTAX:

void setStockCloseSplitDisplay(boolean newValue);
boolean getStockCloseSplitDisplay();

EXAMPLE:

setGraphType(79);
setStockCloseSplitDisplay(true);

setStockCloseSplitDisplay(false);

NOTE:

See DataTextTemplateHiLo for the data set that was used to draw this chart.

ALSO SEE:

StockCloseTicksDisplay, StockOpenTicksDisplay

StockCloseTicksDisplay

This property enables (true) / disables (false) the tick marks at the stock close value. The GraphType property must be set to one of the stock charts. If a close value is not available, this property is ignored. StockTickLength determines the size of the tick marks.

DATA TYPE:

boolean

RANGE:

true / false; true = Display close value tick marks, false = Do not display close value tick marks

DEFAULT:

true

SYNTAX:

void setStockCloseTicksDisplay(boolean newValue);
boolean getStockCloseTicksDisplay();

EXAMPLE:

setGraphType(79);
setStockCloseTicksDisplay(true);

setStockCloseTicksDisplay(false);

NOTE:

See DataTextTemplateHiLo for the data set that was used to draw this chart.

ALSO SEE:

StockCloseSplitDisplay, StockOpenTicksDisplay, StockTickLength

StockMovingAverageDisplay

This property enables (true) / disables (false) the display of a moving average line in a stock chart. The GraphType property must be set to one of the stock charts.

DATA TYPE:

boolean

RANGE:

true / false; true = Draw moving average line, false = Do not draw moving average line

DEFAULT:

false

SYNTAX:

void setStockMovingAverageDisplay(boolean newValue);
boolean getStockMovingAverageDisplay();

EXAMPLE:

setGraphType(76);
setStockMovingAverageDisplay(true);

setStockMovingAverageDisplay(false);

ALSO SEE:

Stock52WeekHighDisplay, Stock52WeekLowDisplay, StockCloseSplitDisplay, StockCloseTicksDisplay, StockOpenTicksDisplay, setLineWidth()

StockOpenTicksDisplay

This property enables (true) / disables (false) the tick marks at the stock open values. The GraphType property must be set to one of the stock charts. If an open value is not available, this property is ignored. StockTickLength determines the size of the tick marks.

DATA TYPE:

boolean

RANGE:

true / false; true = Display open value tick marks, false = Do not draw open value tick marks

DEFAULT:

true

SYNTAX:

void setStockOpenTicksDisplay(boolean newValue);
boolean getStockOpenTicksDisplay();

EXAMPLE:

setGraphType(79);
setStockOpenTicksDisplay(true);

setStockOpenTicksDisplay(false);

NOTE:

See DataTextTemplateHiLo for the data set that was used to draw this chart.

ALSO SEE:

StockCloseTicksDisplay, StockTickLength

StockTickLength

This property determines the length of tick marks in a stock chart. The GraphType property must be set to one of the stock charts. StockCloseTicksDisplay and/or StockOpenTicksDisplay must be enabled (true). If close and/or open values are not available, the tick mark(s) will not be displayed.

DATA TYPE:

integer

RANGE:

0...100

DEFAULT:

50

SYNTAX:

void setStockTickLength(int newValue);
int getStockTickLength();

EXAMPLE:

setViewableSeries(12);
setViewableGroupsStock(6);
setDataScrollerPresenceGroups(0);
setGraphType(79);
setStockCloseTicksDisplay(false);
setStockTickLength(10);
setViewableSeriesStock(8);

setStockTickLength(100);

ALSO SEE:

StockCloseTicksDisplay, StockOpenTicksDisplay

ViewableGroupsStock

This property selects the number of groups to be made visible in a stock hi-lo graph.

DATA TYPE:

integer

RANGE:

Zero to the number of groups in the data that defines the graph.

DEFAULT:

0 (Show all Groups)

SYNTAX:

void setViewableGroupsStock(int newValue);
int getViewableGroupsStock();

EXAMPLE:

setGraphType(73);
setViewableGroupsStock(5);
setDataScrollerPresenceGroups(0);

NOTE:

The setDataRange() method can also be used to set the number of groups to be made visible in a graph. It establishes the range of data that will be used in a graph.

ALSO SEE:

ViewableSeriesStock, setDataRange()

ViewableSeriesStock

This property selects the number of series to be made visible in a stock chart.

DATA TYPE:

integer

RANGE:

Zero to the number of series in the data that defines the graph.

DEFAULT:

0 (Show all Series)

SYNTAX:

void setViewableSeriesStock(int newValue);
int getViewableSeriesStock();

NOTE:

ALSO SEE:

ViewableGroupsStock, setDataRange()