Chart-Specific Methods

get/setAlertLabel(); Get/Set Alert Label in a Gantt Chart
get/setCubeRotationMatrix(); Get/Set 3D Cube Rotation Matrix
get/setGaugeAlphaChannel(); Get/Set Gauge Alpha Channel
get/setGaugeBandMax(); Get/Set Gauge Band Maximum
get/setGaugeBandMin(); Get/Set Gauge Band Minimum
get/setPieSliceDelete(); Get/Set Pie Slice Delete
get/setPieSliceDetach(); Get/Set Slice Detach
get/setQOColor(); Get/Set Quality Object Color in a Gantt Chart
get/setQOLabel(); Get/Set Quality Object Label in a Gantt Chart
get/setQuadrantLineValueX(); Get/Set X-Axis Quadrant Line Value in a Bubble Chart
get/setQuadrantLineValueY(); Get/Set Y-Axis Quadrant Line Value in a Bubble Chart
getQualityLegendRect(); Get Quality Legend Rectangle in a Gantt Chart
get/setWaterfallGroupMode(); Get/Set Waterfall Group Mode
restoreAllSlices(); Restore All Slices in a Pie Chart

get/setAlertLabel()

This method get/set the alert label string that has been assigned to a series/task in a gantt chart. If a specific object is not identified with the input parameters id or seriesID, the get method will return the associated value (if any) for the first item in the selection list. The set method assigns the alert label string.

SYNTAX:

String getAlertLabel()
String getAlertLabel (IdentObj id)
String getAlertLabel (int seriesID)
void   setAlertLabel (IdentObj id, String newValue)

INPUT:

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

seriesID: series ID

newValue; alert label text

RETURN:

String; the data label at series

EXAMPLE:

setGraphType (99);
setTitleString ("Gantt Chart");
setData (0, 0, 8, 1, 2003); 
setData (0, 1, 8, 2, 2003); 
setData (0, 2, 25.0); 
setData (0, 3, 8, 3, 2003); 
setData (0, 4, 8, 4, 2003); 
setData (0, 5, 1); 
setData (0, 6, -1); 
setSeriesLabel (0, "Task 1 - Wash Dog");
setData (1, 0, 8, 5, 2003); 
setData (1, 1, 8, 6, 2003); 
setData (1, 2, 50.0); 
setData (1, 3, 8, 7, 2003); 
setData (1, 4, 8, 8, 2003); 
setData (1, 5, 2); 
setData (1, 6, -1); 
setSeriesLabel (1, "Task 2 - Wash Cat");
setStartDate (8, 1, 2003);
setCurrentDate (8, 11, 2003);
setEndDate (8, 30, 2003);
setDataRange (0, 0, 1, 6);
setToolTipDisplay (true); 
setAlertLabel  (getSeries (0), "Alert for Task 1");

get/setCubeRotationMatrix()

These methods get/set the rotation matrix of a 3D cube.

SYNTAX:

tdg.model3d.Matrix3d getCubeRotationMatrix();
void setCubeRotationMatrix (double rx, double ry, double rq);
void setCubeRotationMatrix (tdg.model3d.Matrix3d m);
void setCubeRotationMatrix (
     double m00,
     double m01,
     double m02,
     double m10,
     double m11,
     double m12,
     double m20,
     double m21,
     double m22
);

INPUT:

rx; rotation in x direction

ry; rotation in y direction

rz; rotation in z direction

RETURN:

Matrix3d;

class Matrix3d implements java.io.Serializable 
{
    double   m00;// row 0, col 0
    double   m01;// row 0, col 1
    double   m02;
    double   m10;
    double   m11;
    double   m12;
    double   m20;
    double   m21;
    double   m22;
}

NOTES:

The default setting is:

setCubeRotationMatrix (
     0.7071067811865474,
     0.0,
     0.7071067811865477,
     -0.3535533905932738,
     0.8660254037844387,
     0.3535533905932736,
     -0.6123724356957947,
     -0.49999999999999994,
     0.6123724356957945
);

get/setGaugeAlphaChannel()

These methods get/set the amount (0.0...1.0) of highlighting applied to a gauge object.

SYNTAX:

double getGaugeAlphaChannel (IdentObj identObj);
void   setGaugeAlphaChannel (IdentObj identObj, double newValue);

INPUT:

identObj; object ID returned by a getGauge...Object() method (e.g., getGaugeGlass())

newValue: 0.0...1.0 = amount of highlighting to apply.

RETURN:

double; 0.0...1.0 = amount of highlighting applied to identObj

EXAMPLE:

setBorderColor (getGaugeArea(), new Color (0, 0, 0));
setBorderColor (getGaugeBand3(), new Color (255, 255, 0));
setBorderColor (getGaugeGlass(), new Color (0, 0, 0));
setBorderColor (getGaugeBand1(), new Color (255, 0, 0));
setBorderColor (getGaugeBand4(), new Color (0, 255, 0));
setBorderColor (getGaugeBand2(), new Color (0, 255, 0));
setBorderColor (getGaugeBand5(), new Color (255, 0, 0));
setFillColor (getGaugeArea(), new Color (255, 255, 255));
setFillColor (getGaugeGlass(), new Color (255, 255, 255));
setGaugeAlphaChannel (getGaugeGlass(), 0.7);
setGaugeBackgroundStyle (getGaugeArea(), 1);
setGaugeNeedleStyle (getGaugeNeedle(), 2);
setGaugeRelativeTickLength (getGaugeMajorGrid(), 0.09);
setGaugeRelativeTickLength (getGaugeMinorGrid(), 0.05);
setGraphType (110);
setScrollOffsetGroup (1);
setUseSampleData (true);
setViewableGroups (1);
setViewableSeries (1);

get/setGaugeBandMax()

These methods get/set the maximum value assigned to a quality band in a guage chart. The quality bands in a gauge chart are typically assigned colors that show when the gauge needle (value) is in an acceptable or unacceptable region (e.g., red=bad, yellow=marginal, green=good).

SYNTAX:

double getGaugeBandMax (IdentObj identObj);
void   setGaugeBandMax (IdentObj identObj, double newValue);

INPUT:

identObj; object ID returned by getGaugeBand1(), getGaugeBand2(), getGaugeBand3(), getGaugeBand4(), or getGaugeBand5()

newValue: Maximum value of the gauge band.

RETURN:

double; Maximum value for a guage quality band

EXAMPLE:

setGraphType (110);
setViewableGroups (1);
setViewableSeries (1);
setDataScrollerPresenceGroups (0);
setGaugeBandMax (getGaugeBand1(), 18.5);
setGaugeBandMax (getGaugeBand2(), 38.5);
setGaugeBandMax (getGaugeBand3(), 58.5);

ALSO SEE:

get/setGaugeBandMin()

get/setGaugeBandMin()

These methods get/set the minimum value assigned to a quality band in a guage chart. The quality bands in a gauge chart are typically assigned colors that show when the gauge needle (value) is in an acceptable or unacceptable region (e.g., red=bad, yellow=marginal, green=good).

SYNTAX:

double getGaugeBandMin (IdentObj identObj);
void   setGaugeBandMin (IdentObj identObj, double newValue);

INPUT:

identObj; object ID returned by getGaugeBand1(), getGaugeBand2(), getGaugeBand3(), getGaugeBand4(), or getGaugeBand5()

newValue: Minimum value of the gauge band.

RETURN:

double; Minimum value for a guage quality band

EXAMPLE:

setGraphType (110);
setViewableGroups (1);
setViewableSeries (1);
setDataScrollerPresenceGroups (0);
setGaugeBandMin (getGaugeBand1(), 1.5);
setGaugeBandMin (getGaugeBand2(), 21.5);
setGaugeBandMin (getGaugeBand3(), 41.5);

ALSO SEE:

get/setGaugeBandMax()

get/setPieSliceDelete()

These methods get/set the delection of a slice from a pie chart.

SYNTAX:

boolean getPieSliceDelete();
boolean getPieSliceDelete (IdentObj id);
boolean getPieSliceDelete (int seriesID);
boolean getPieSliceDelete (int seriesID, int groupID);
void setPieSliceDelete (boolean newValue);
void setPieSliceDelete (IdentObj id,  boolean newValue);
void setPieSliceDelete (int seriesID,  boolean newValue);
void setPieSliceDelete (int seriesID, int groupID, boolean newValue);

INPUT:

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

seriesID; series number

groupID; group number

newValue; true = delete slice, false = do not delete slice

RETURN:

boolean; true = Slice deleted, false = Slice not deleted

EXAMPLE:

setPieSliceDelete (getSeries (3), true);
setPieSliceDelete (getSeriesGroup (3, 0), true);
setPieSliceDelete (getSeries (0), false);
setPieSliceDelete (getSeriesGroup (0, 0), false);
setPieSliceDetach (getSeries (0), 100);
setPieSliceDetach (getSeriesGroup (0, 0), 100);

NOTES:

If a specific object is not identified with the input parameters id, seriesID, or groupID, these methods get/set the associated value (if any) for the first item in the selection list.

ALSO SEE:

get/setPieSliceDetach(), restoreAllSlices()

get/setPieSliceDetach()

These methods get/set the distance a slice is detached from a pie chart.

SYNTAX:

int getPieSliceDetach();
int getPieSliceDetach (IdentObj id);
int getPieSliceDetach (int seriesID);
int getPieSliceDetach (int seriesID, int groupID);
void setPieSliceDetach (boolean newValue);
void setPieSliceDetach (IdentObj id,  boolean newValue);
void setPieSliceDetach (int seriesID,  boolean newValue);
void setPieSliceDetach (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; distance (0...100) to detach slice

RETURN:

int; 0...100 distance slice has been detached from pie chart

EXAMPLE:

setPieSliceDelete (getSeries (3), true);
setPieSliceDelete (getSeriesGroup (3, 0), true);
setPieSliceDelete (getSeries (0), false);
setPieSliceDelete (getSeriesGroup (0, 0), false);
setPieSliceDetach (getSeries (0), 100);
setPieSliceDetach (getSeriesGroup (0, 0), 100);

NOTES:

If a specific object is not identified with the input parameters id, seriesID, or groupID, these methods get/set the associated value (if any) for the first item in the selection list.

ALSO SEE:

get/setPieSliceDelete(), restoreAllSlices()

get/setQOColor()

When the quality legend area is shown in a gantt chart with setDisplay (getQualityLegendArea(), true), these methods get/set the color of a legend marker.

SYNTAX:

Color getQOColor (int nRange);
void setQOColor (int nRange, Color newColor);

INPUT:

nRange; series number

newColor; the new color specified as 3 RGB values (e.g., new Color (255, 255, 255))

RETURN:

Color; Color of the specified series legend.

EXAMPLE:

setGraphType (99);
setTitleString ("Gantt Chart");
setSubtitleDisplay (false);
setFootnoteDisplay (false);
setLegendDisplay (false);
setData (0, 0, 8, 1, 2003); 
setData (0, 1, 8, 2, 2003); 
setData (0, 2, 25.0); 
setData (0, 3, 8, 3, 2003); 
setData (0, 4, 8, 4, 2003); 
setData (0, 5, 1); 
setData (0, 6, -1); 
setSeriesLabel (0, "Task 1 - Wash Dog");
setData (1, 0, 8, 5, 2003); 
setData (1, 1, 8, 6, 2003); 
setData (1, 2, 50.0); 
setData (1, 3, 8, 7, 2003); 
setData (1, 4, 8, 8, 2003); 
setData (1, 5, 2); 
setData (1, 6, -1); 
setSeriesLabel (1, "Task 2 - Wash Cat");
setStartDate (8, 1, 2003);
setCurrentDate (8, 11, 2003);
setEndDate (8, 30, 2003);
setDataRange (0, 0, 1, 6);
setDisplay (getQualityLegendArea(), true);
setQOColor (1, new Color (255, 0, 255));

get/setQOLabel()

When the quality legend area is shown in a gantt chart with setDisplay (getQualityLegendArea(), true), these methods get/set a series label string.

SYNTAX:

String getQOLabel (int nRange);
void setQOLabel (int nRange, String strLabel);

INPUT:

nRange; series number

strLabel; label text

RETURN:

String; the data label at range

EXAMPLE:

setGraphType (99);
setTitleString ("Gantt Chart");
setSubtitleDisplay (false);
setFootnoteDisplay (false);
setLegendDisplay (false);
setData (0, 0, 8, 1, 2003); 
setData (0, 1, 8, 2, 2003); 
setData (0, 2, 25.0); 
setData (0, 3, 8, 3, 2003); 
setData (0, 4, 8, 4, 2003); 
setData (0, 5, 1); 
setData (0, 6, -1); 
setSeriesLabel (0, "Task 1 - Wash Dog");
setData (1, 0, 8, 5, 2003); 
setData (1, 1, 8, 6, 2003); 
setData (1, 2, 50.0); 
setData (1, 3, 8, 7, 2003); 
setData (1, 4, 8, 8, 2003); 
setData (1, 5, 2); 
setData (1, 6, -1); 
setSeriesLabel (1, "Task 2 - Wash Cat");
setStartDate (8, 1, 2003);
setCurrentDate (8, 11, 2003);
setEndDate (8, 30, 2003);
setDataRange (0, 0, 1, 6);
setDisplay (getQualityLegendArea(), true);
setQOLabel (0, "Seriously Overdue");
setQOLabel (1, "OK");
setQOLabel (2, "Ahead of Schedule");

get/setQuadrantLineValueX()

These methods get/set the scale value at which to place vertical quadrant line nIndex on the X-axis in a bubble chart.

SYNTAX:

double getQuadrantLineValueX (int nIndex);
void setQuadrantLineValueX (int nIndex,  double newValue);

INPUT:

nIndex; quadrant line number (zero to number of quadrant lines drawn)

newValue: Scale value. NO_LINEVALUE = enable automatic scaling

RETURN:

double; scale value. NO_LINEVALUE = automatic scaling is enabled

EXAMPLE:

setGraphType (89);
setQuadrantLineValueX (0, 50);

setQuadrantLineValueX (0, 20);

ALSO SEE:

get/setQuadrantLineValueY()

get/setQuadrantLineValueY()

These methods get/set the scale value at which to place horizontal quadrant line nIndex on the Y-axis in a bubble chart.

SYNTAX:

double getQuadrantLineValueY (int nIndex);
void setQuadrantLineValueY (int nIndex,  double newValue);

INPUT:

nIndex; quadrant line number (zero to number of quadrant lines drawn)

newValue: Scale value. NO_LINEVALUE = enable automatic scaling

RETURN:

double; scale value. NO_LINEVALUE = automatic scaling is enabled

EXAMPLE:

setGraphType (89);
setQuadrantLineValueY (10);

setQuadrantLineValueY (60);

ALSO SEE:

get/setQuadrantLineValueX()

getQualityLegendRect()

This method returns a rectangle that represents the size and location of the quality legend area a gantt chart.

SYNTAX:

Rectangle getQualityLegendRect()

INPUT:

None

RETURN:

Rectangle; size/location of the quality legend in a gantt chart

get/setWaterfallGroupMode()

These methods get/set the waterfall mode (normal, subtotal, total, extra, or reset to zero) for a specified group in a waterfall chart.

SYNTAX:

int getWaterfallGroupMode (int nGroup);
void setWaterfallGroupMode (int nGroup, int nGroupMode);

INPUT:

nGroup; group number

nGroupMode; group mode (0...4)

WATERFALLGROUPMODE_NORMAL = 0; // Normal
WATERFALLGROUPMODE_SUBTOTAL = 1; // Subtotal
WATERFALLGROUPMODE_TOTAL = 2; // Total
WATERFALLGROUPMODE_EXTRA = 3; // Extra
WATERFALLGROUPMODE_NORMAL_RESETTOZERO = 4 // Reset to Zero

RETURN:

int; The waterfall group mode number (0...4)

EXAMPLE:

setGraphType (100); 
setUseSampleData (false);
setDepthRadius (0);
setDepthAngle (0);
setData (0, 0, 10); 
setData (1, 0, 20); 
setData (2, 0, 30); 
setGroupLabel (0, "Grp0");
setData (0, 1, 40); 
setData (1, 1, 50); 
setData (2, 1, 60); 
setGroupLabel (1, "Grp1");
setData (0, 2, 0); 
setData (1, 2, 0); 
setData (2, 2, 0); 
setWaterfallGroupMode (2, 1);
setGroupLabel (getGroup (2), "Subtot1"); 
setData (0, 3, 10); 
setData (1, 3, 20); 
setData (2, 3, 30); 
setGroupLabel (3, "Grp3");
setData (0, 4, 0); 
setData (1, 4, 0); 
setData (2, 4, 0); 
setWaterfallGroupMode (4, 2);
setGroupLabel (getGroup (4), "Total"); 
setData (0, 5, 10); 
setData (1, 5, 20); 
setData (2, 5, 30); 
setWaterfallGroupMode (5, 3); 
setGroupLabel (getGroup (5), "Extra"); 
setStackedDataValueSum (true); 
setDataTextDisplay (true);
setTextJustHoriz (getDataText(), 1); 
setFontSizeAbsolute (getDataText(), true); 
setFontSize (getDataText(), 10); 
setFontSizeAbsolute (getO1Label (0), true);
setFontSize (getO1Label (0), 12);
setDataRangeToExtent();
setSeriesLabel (0, "Series 0");
setSeriesLabel (1, "Series 1");
setSeriesLabel (2, "Series 2");
setTitleString ("Waterfall Chart");

NOTES:

Group mode 4 (WATERFALLGROUPMODE_NORMAL_RESETTOZERO) is the same as mode 0 (WATERFALLGROUPMODE_NORMAL) except it resets the cumulative sum to zero before drawing.
For a Normal group, series risers are stacked on top of each other and each successive series represents the value of its series/group plus any preceding series/group. For a Subtotal or Total group, the data for the group is ignored and the cumulative total up to this point will be shown for this group. Only one group in a chart can designated as a Total. An Extra group is not used when performing any waterfall cumulative sums. It will appear just as stacked data. When used, it should be defined as the last group in the chart.

restoreAllSlices()

This method restores all deleted or detached slices to a pie chart.

SYNTAX:

void restoreAllSlices();

INPUT:

None

RETURN:

void

ALSO SEE:

get/setPieSliceDelete(), get/setPieSliceDetach()