Riser/Marker Methods

get/setExceptionalRiser()

These methods get/set an exceptional riser. An exceptional riser can be manipulated separately (e.g., colored) from other risers in the series.

SYNTAX:

IdentObj getExceptionalRiser (int s, int g);
void     setExceptionalRiser();
void     setExceptionalRiser (int s, int g);

INPUT:

s; series number

g; group number

RETURN:

IdentObj; Object ID of a exceptional riser

EXAMPLE:

setExceptionalRiser (2, 1);
setFillType (getExceptionalRiser (2, 1), 1);
setFillColor (getExceptionalRiser (2, 1), new Color (0, 255, 255));
setDepthRadius (0);

ALSO SEE:

setNoExceptionalRiser()

getExceptionalRisers()

This method returns the entire hash table of exceptional risers.

SYNTAX:

java.util.Hashtable getExceptionalRisers();

INPUT:

None

RETURN:

Hashtable; Hash table of exceptional risers

ALSO SEE:

setNoExceptionalRiser()

get/setMarkerShape()

These methods get/set the shape of a marker for a specified object.

SYNTAX:

int getMarkerShape();
int getMarkerShape (IdentObj id);
void setMarkerShape (int integerMarkerShape);
void setMarkerShape (IdentObj id, int integerMarkerShape);

INPUT:

id; object ID returned by a getObject() method (e.g., getSeries())

integerMarkerShape: 0...32. If setMarkerTemplate() has not been used to replace any of the preset marker shapes, a value 1...16 selects one of the following shapes:

RETURN:

int; 0...32

EXAMPLE:

setDepthRadius (0);
setDepthAngle (0);
setGraphType (61);
setMarkerSizeDefault (60);
setMarkerShape (getSeries (0), 6);

NOTES:

If an object ID (id) is not specified, these methods get/set the marker shape (if any) for the first item in the selection list.

ALSO SEE:

get/setMarkerSize(), get/setMarkerTemplate(), MarkerDisplay, MarkerSizeDefault

get/setMarkerSize()

These methods get/set the size of a marker.

SYNTAX:

int getMarkerSize();
int getMarkerSize (IdentObj id);
int getMarkerSize (int seriesID);
int getMarkerSize (int seriesID, int groupID);
void setMarkerSize (int newValue);
void setMarkerSize (IdentObj id, int newValue);
void setMarkerSize (int seriesID, int newValue);
void setMarkerSize (int seriesID, int groupID, int newValue);

INPUT:

id; object ID returned by a getObject() method (e.g., getSeries())

seriesID; series number

groupID; group number

newValue; a value (0...100) that represents the size of a marker

RETURN:

int; 0...100 represents the size of a marker

EXAMPLE:

setGraphType (61);
setMarkerSize (0, 60);
setMarkerShape (0, 6);
setMarkerSize (1, 60);
setMarkerShape (1, 5);
setMarkerSize (2, 60);
setMarkerShape (2, 4);
setMarkerSize (3, 60);
setMarkerShape (3, 3);
setMarkerSize (4, 60);
setMarkerShape (4, 2);
setMarkerSize (5, 60);
setMarkerShape (5, 1);

NOTES:

If an object ID (id), series (seriesID), or series and group ID (groupID), is not specified, this method gets/sets the marker size (if any) for the first item in the selection list.

ALSO SEE:

get/setMarkerShape(), MarkerDisplay, MarkerSizeDefault

get/setMarkerTemplate()

These methods get/set a user-defined marker in a marker template slot. The getNextMarkerTemplateSlot() method can be used to determine the next marker template slot that is not used. The marker template can be assigned to an object or all objects in a chart by the setMarkerShape() method.

SYNTAX:

MarkerTemplate getMarkerTemplate (IdentObj id);
void setMarkerTemplate (int nIndex, Polygon newPolygon);
void setMarkerTemplate (int nIndex, tdg.MarkerTemplate MarkerTemplate new Template);

INPUT:

id; object ID returned by a getObject() method (e.g., getSeries())

nIndex: a slot (0...32) in the marker template where the marker should be assigned.

newPolygon: polygon where a marker shape is stored

newTemplate: not currently used.

RETURN:

MarkerTemplete; 0...32

ALSO SEE:

get/setMarkerShape(), getNextMarkerTemplateSlot(), registerMarkerTemplate()

getNextMarkerTemplateSlot()

When registerMarkerTemplate() is used to specify user-defined marker shapes, this method returns the next available slot in the template of defined markers.

SYNTAX:

int getNextMarkerTemplateSlot()

INPUT:

None

RETURN:

int; The number (0...32) of the next available marker template slot

ALSO SEE:

registerMarkerTemplate()

registerMarkerTemplate()

This method is used to register a user-defined marker.

SYNTAX:

int registerMarkerTemplate (java.awt.Polygon newPolygon);
int registerMarkerTemplate (tdg.MarkerTemplate MarkerTemplate newTemplate)

INPUT:

newPolygon: a standard Java Polygon. The polygon must fit in the rectangle: -900, -900, 1800, 1800 (i.e., a rectangle that goes from -900 to 900 in the X- and Y-directions). These are Perspective virtual coordinates.

INPUT:

newTemplate: not currently used

RETURN:

int: new marker shape number that can be used assign the marker shape in the chart with setMarkerShape().

ALSO SEE:

getNextMarkerTemplateSlot(), get/setMarkerTemplate()

setNoExceptionalRiser()

This method can be used to prohibit the use of exceptional risers in a chart.

SYNTAX:

void setNoExceptionalRiser();

INPUT:

None

RETURN:

void

ALSO SEE:

get/setExceptionalRiser(), getExceptionalRisers(), isExceptionalAllowed()