save()

The save() method can be used to save a chart to an output stream. It will save all of the properties and methods required to recreate the chart in ASCII text file format. The contents of the file can be viewed or edited with any text editor.

Syntax:.

void save(java.io.OutputStream os);

void save(
    java.io.OutputStream os,
    java.lang.String ChartObjectName
);

Input:

os: a Java OutputStream

ChartObjectName: Chart object name

Return:

None

Also See:

load()

 

 

SendChartToFTP()

This method sends a chart to an FTP server an an ASCII text file.

Syntax:

boolean sendChartToFTP (
    String strHost,
    String strUser,
    String strPass,
    String strDir,
    String strDestFile
);

Input:

strHost: Host Name

strUser: User Name

strPass: Password

strDir: Directory name

strDestFile: Destination file name

Return:

boolean: TRUE = success/FALSE = failed

Also See:

getChartFromFTP(), sendGIFToFile(), sendGIFToFTP(),
sendGIFToStream()

sendGIFToFile()

This method sends the current chart to a file as a GIF image.

Syntax:

void sendGIFToFile ( os OutputStream );

Input:

os: Location to store chart as GIF

Return:

None

Example:

String gifFile = new String("SaveChartGIFDemo.gif");
perspective1.sendGIFToFile new FileOutputStream(gifFile));

Also See:

sendChartToFTP(), sendGIFToFTP(), sendGIFToStream()

sendGIFToFTP()

This method sends the current chart to an FTP server as a GIF file.

Syntax:

void sendGIFToFTP (
    String strHost,
    String strUser,
    String strPass,
    String strDir,
    String strDestFile
);

Input:

strHost: Host Name

strUser: User Name

strPass: Password

strDir: Directory name

strDestFile: Destination file name

Return:

None

Also See:

sendChartToFTP(), sendGIFToFile(), sendGIFToStream()

sendGIFToStream()

This method sends the current chart to an output stream as a GIF file.

Syntax:

void sendGIFToStream (os OutputStream);

Input:

os: Location to store chart as GIF image

Return:

None

Also See:

sendChartToFTP(), sendGIFToFile(), sendGIFToFTP()

sendImageMapToStream()

This method creates a map of the image that forms a chart.

Syntax:

void sendImageMapToStream(
    java.io.PrintWriter outWriter,
    java.lang.String mapName,
    java.lang.String pathName,
    boolean bPage
)

Input:

outWriter; A Java IO PrintWriter object

mapName: Name of ImageMap.

pathName: Name of the path to write ImageMap to.

bPage: true = pageable, false = non-pageable

Return:

None

Also See:

sendGIFToStream(), copyImageMap()

sendPNGToFile()

This method writes the chart image to the specified file in .png format. Any errors are passed to TDGErrorListeners with an ID of TDGError.WRITE_ERROR.

Syntax:

void sendPNGToFile(java.io.File pngFile)

Input:

pngFile: File to write the chart image to

Return:

None

Also See:

sendPNGToStream()

sendPNGToStream()

This method writes the chart image to the specified stream in .png format. Any errors are passed to TDGErrorListeners with an ID of TDGError.WRITE_ERROR.

Syntax:

void sendPNGToStream(java.io.OutputStream pngStream)

Input:

pngStream: Stream to write the chart image. to.

Return:

None

Also See:

sendPNGToFile()

setAutofit()

This method enables/disables automatic fitting and sizing of a text object. If a specific object is not identified by id or objectID, this method sets automatic fitting/sizing for the first item in the selection list. You may also use one of the object-specific properties to set the automatic fitting of an object (e.g., FootnoteAutofit(), LegendTextAutofit(), O1LabelAutofit(), etc.).

Syntax:

void setAutofit(boolean newValue);

void setAutofit(tdg.draw.IdentObj id, boolean newValue);

void setAutofit(int objectID, boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

newValue: true / false

 

true=

enable autofitting

 

false=

disable autofitting

Return:

None

Example:

perspective1.setAutofit(perspective1.getFootnote(),false);
perspective1.setFontName(
    perspective1.getFootnote(),"TimesRoman");
perspective1.setFontSizeVC(
    perspective1.getFootnote(),2318);

Notes:

All text autofitting can be disabled by the FontSizeAbsolute property.

Also See:

getAutofit(), setAutofit(), FontSizeAbsolute, FootnoteAutofit, LegendTextAutofit, O1LabelAutofit, O1TitleAutofit, O2LabelAutofit, O2TitleAutofit, X1LabelAutofit, X1TitleAutofit, Y1LabelAutofit, Y1TitleAutofit, Y2LabelAutofit, Y2TitleAutofit

setAutoSkip()

This method sets or disables label skip for labels on the O1 axis. If this method selects manual label skip (2), use setSkipBegin() to define the first label to skip and setSkipCount() to define the skip interval. If this method selects automatic skip mode (1), Perspective will automatically omit/skip labels when the chart size causes the labels to be drawn in less than 8-point type. Automatic skip mode may omit all but two labels if the chart is reduced to its minimum size.

Syntax:

void setAutoSkip(int newValue);

void setAutoSkip(tdg.draw.IdentObj id, int newValue);

void setAutoSkip(int objectID, int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

newValue: 0...2

 

0=

No label skipping

 

1=

Automatic label skipping

 

2=

Manual skipping as defined by setSkipBegin() and setSkipCount()

Return:

None

Example:

perspective1.setAutoSkip(perspective1.getO1Label(),2);
perspective1.setSkipBegin(perspective1.getO1Label(),1);
perspective1.setSkipCount(perspective1.getO1Label(),1);

Also See:

setSkipBegin(), setSkipCount()

setAxisAssignment()

In dual-axis charts, this method can be used to assign individual series to the Y1 and Y2 axes. If an object id or SeriesID is not specified, this method sets the axis assignment attribute for the first item in the selection list.

Syntax:

void setAxisAssignment(int newValue);

void setAxisAssignment(tdg.draw.IdentObj id, int newValue);

void setAxisAssignment(int seriesID, int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Series(1))

seriesID: Series Number

newValue: 0 (Y1 Axis)/1 (Y2 Axis)

Return:

None

Example:

perspective1.setGraphType(21);
perspective1.setAxisAssignment(
    perspective1.getSeries(1),0);
perspective1.setAxisAssignment(
    perspective1.getSeries(0),1);

perspective1.setAxisAssignment(
    perspective1.getSeries(3),1);
perspective1.setAxisAssignment(
    perspective1.getSeries(4),0);

Also See:

getAxisAssignment(), getAxisDescending(), setAxisDescending(),
getAxisSide(), setAxisSide(), Y1AxisSide, Y2AxisSide

setAxisDescending()

This method can be used to draw an axis in ascending or descending attribute. If an axis is not identified by id or objectID, the method sets the axis-descending attribute for the first item in the selection list. You may also use one of the axis-specific properties (e.g., X1AxisDescending, Y1AxisDescending, etc.) to set the descending attribute of an axis.

Syntax:

void setAxisDescending(boolean newValue );

void setAxisDescending(tdg.draw.IdentObj id, boolean newValue);

void setAxisDescending(int objectID, boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

newValue: true/false

 

true=

Descending

 

false=

Ascending

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setViewableGroups(4);
perspective1.setViewableSeries(4);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setAxisDescending(
    perspective1.getY1Axis(), true);

Also See:

getAxisAssignment, setAxisAssignment(), getAxisSide(), setAxisSide(), X1AxisDescending, Y1AxisDescending, Y2AxisDescending

setAxisSide()

This method sets the side of a chart where an axis is imaged. If a specific object is not identified by id or objectID, the method sets this attribute for the first item in the selection list. You may also use one of the axis-specific properties (e.g., X1AxisSide, Y1AxisSide, etc.) to assign an axis to a side.

Syntax:

void setAxisSide(int newValue);

void setAxisSide(tdg.draw.IdentObj id, int newValue);

void setAxisSide(int objectID, int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

newValue: 0...2

 

0=

Left (or bottom for Horizontal charts)

 

1=

right (or top for Horizontal charts)

 

2=

Both sides of chart

Return:

None

Example:

perspective1.setAxisSide(perspective1.getY1Axis(),1);

perspective1.setAxisSide(perspective1.getO1Axis(),2);

Also See:

getAxisAssignment(), setAxisAssignment(), getAxisDescending(), setAxisDescending(), O1AxisSide, X1AxisSide, Y1AxisSide, Y2AxisSide

setBorderColor()

This method sets the border color attribute of an object in a chart.

Syntax:

void setBorderColor(Color newValue);

void setBorderColor(IdentObj id, Color newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries(1))

Color: value of color to be assigned to border

Return:

None

Example:

perspective1.setBorderColor(
    perspective1.getSeries(4),new Color(255,0,0));
perspective1.setFillColor(
    perspective1.getSeries(4),new Color(0,255,255));

perspective1.setBorderColor(
    perspective1.getSeries(4),new Color(0,0,0));
perspective1.setFillColor(
    perspective1.getSeries(4),new Color(255,255,255));

Also See:

getFillColor(), setFillColor(), getSelectionBorderColor(),
setSelectionBorderColor(), getTransparentBorderColor(),
setTransparentBorderColor(), isSelectionBorderColorTransparent(),
setSeriesBorderColor(), ColorMode()

setCubeRotationMatrix()

This method sets the rotation matrix of a 3D chart.

Syntax:

void setCubeRotationMatrix (double rx, double ry,
    double rq );

void setCubeRotationMatrix (tdg.model3d.Matrix3d m);

public 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:

None

Example:

perspective1.setCubeFocusFactor(87.49999876279527);
perspective1.setCubeRotationMatrix(0.9595622863061368,
    -0.4715354993437172,1.031956469611238,
    -0.03648998497747465,1.3380131050659487,
    0.6453131606305538,-1.1339966328478057,
    -.44205753827450966,0.8524531853183448);
perspective1.setCubeViewerZ(80.8979539352483);
perspective1.setGraphType(0);

Notes:

The default setting is: setCubeRotationMatrix (0.7071067811865474,
0.0, 0.7071067811865477, -0.3535533905932738, 0.8660254037844387, 0.3535533905932736, -0.6123724356957947, -0.49999999999999994, 0.6123724356957945);

Also See:

getCubeRotationMatrix()

setCurveFitPolynomialOrder()

If the setCurveFit() method selects a polynomial fit line across a series of risers (i.e., setCurveFit(FIT_POLYNOMIAL)), this method sets the order (the largest power to which "x" is raised) for the polynomial fit. The default value is 3. It may be set to a value in the range 0...10.

Syntax:

void setCurveFitPolynomialOrder(int newValue)

void setCurveFitPolynomialOrder(tdg.draw.IdentObj id, int newValue)

void setCurveFitPolynomialOrder(int seriesID, int newValue)

Input:

newValue; order for the polynomial fit (0...10)

id; IdentObj returned by a getObjectID() method (e.g., getSeries())

seriesID; Series Number

Return:

Void

Example:

perspective1.setDepthRadius(0);
perspective1.setCurveFitType(1,3);
int i = perspective1.getCurveFitPolynomialOrder();
perspective1.setCurveFitPolynomialOrder(i+10);

 

Also See:

getCurveFitPolynomialOrder(), getCurveFitType(), setCurveFitType()

setCurveFitType()

This method selects a curve fit line and draws the selected curve type across one or more series of risers in a chart.

void setCurveFitType(int newValue)

void setCurveFitType(tdg.draw.IdentObj id, int newValue)

void setCurveFitType(int seriesID, int newValue)

Input:

newValue; Curve fit type (0...11)

CurveFitType Constant

Value

Description

FIT_NONE

0

None

FIT_LINEAR

1

Linear regression curve fit line

FIT_QUADRATIC

2

Quadratic curve fit line

FIT_POLYNOMIAL

3

Polynomial fit line

FIT_HYPERBOLIC

4

Hyperbolic curve fit line

FIT_LOGARITHMIC

5

Logarithmic curve fit line

FIT_MODHYPERBOLIC

6

Modified hyperbolic

FIT_RATIONAL

7

Rational curve fit line

FIT_EXPONENTIAL

8

Exponential curve fit line

FIT_MODEXPONENTIAL

9

Modified exponential

FIT_LOGQUADRATIC

10

Logarithmic/Quadratic curve fit line

FIT_GEOMETRIC

11

Geometric curve fit line

id; IdentObj returned by a getObjectID() method (e.g., getSeries())

seriesID; Series Number

Return:

Void

Example:

perspective1.setDepthRadius(0);
perspective1.setCurveFitType(1,11);

 

Also See:

getCurveFitType(), CurveFitEquationDisplay, CurveFitHighOrderFirst

setData()

This method sets the data value for a series/group intersection. This is THE master method for setting data in charts It can be used to assign a single value to a row and column in a chart for the currently selected object or for a specific object in the chart. You may also specify whether or not the chart should be repainted when the new value is assigned. You must use setDataRangeToExtent() after the last setData().

Syntax:

void setData (int row,int col,double fValue);

void setData(int row, int col, double fValue, boolean bRecalc);

void setData(int row,int col, java.lang.Object obj);

void setData(int row,int col, java.lang.Object obj,boolean bRecalc);

Input:

row: Row number

col: Column number

obj: Object ID

fValue: Data value to set at row/column

bRecalc:

 

true=

Repaint the chart when the new data value is assigned

 

false

Don't repaint the chart.

Return:

None

Example:

perspective1.setData(0,0,.5);/* Row 0/Col 0 */
perspective1.setData(0,1,1); /* Row 0/Col 1 */
perspective1.setData(0,2,2); /* Row 0/Col 2 */
perspective1.setData(0,3,3); /* Row 0/Col 3 */
perspective1.setData(0,4,4); /* Row 0/Col 4 */
perspective1.setData(0,5,5); /* Row 0/Col 5 */
perspective1.setData(1,0,.5); /* Row 1/Col 0 */
perspective1.setData(1,1,1); /* Row 1/Col 1 */
perspective1.setData(1,2,2); /* Row 1/Col 2 */
perspective1.setData(1,3,3); /* Row 1/Col 3 */
perspective1.setData(1,4,4); /* Row 1/Col 4 */
perspective1.setData(1,5,5); /* Row 1/Col 5 */
perspective1.setDataRangeToExtent()

Also See:

setDataFileURL(), setDataFromCallBack(), setDataFromDataGrid(), setDataFromResultSet(), setDataFromSQL(), setDataRange(), setDataRangeToExtent()

setDataFileURL()

You can load any text file into a Perspective applet. This can be done by using setDataFileURL which takes any valid file location or Internet URL as input or setDataStream() which takes a stream as input. The text file needs to be organized in "spreadsheet" fashion, with rows of number for series, and columns of numbers for groups. You can optionally supply row and/or column headers which will be used for labeling the series and groups. Each value must be in quotes and separated by a comma. If you ARE supplying row and column headers, the very first word in the file must be "labels", in quotes, separated by a comma.

Syntax:

void setDataFileURL (java.lang.String aDataFileURL);

Input:

aDataFileURL: any valid file location or Internet URL

Return:

None

Also See:

setData(), setDataFromCallBack(), setDataFromDataGrid(), setDataFromResultSet(), setDataFromSQL(), setDataStream()

setDataFromCallBack()

This method can be used to enable the chart data to be slaved to an arbitrary Java Object which implements the TDGDataGrid Interface. When a "callback" is in effect and the chart needs to redraw itself, for instance, after a property is changed, the chart will query the isDirty() method of the Java Object. If the result is true, Perspective for Java will call several other methods on the Java Object to gather all of the data required to draw itself. The Java Object itself may be a remote object through Remote Method Invocation (RMI) or may obtain data through JDBC or by any other means as long as it implements the TDGDataGrid Interface.

Syntax:

void setDataFromCallBack(TDGDataGrid grid);

Input:

grid: This parameter should identify an interface that represents an abstract data model. The data model defines a way of preparing data for graphing.

Return:

None

Also See:

setDataFromDataGrid(), TDGDataGrid, The Callback Technique, Handling Large Data Sets, TDGDataGrid Methods

setDataFromDataGrid()

TDGDataGrid is series of methods that you must implement into an object. This method tells the charting engine to use the TDGDataGrid object to collect data for the chart.

Syntax:

void setDataFromDataGrid (TDGDataGrid grid);

Input:

grid: This parameter must identify an interface that represents an abstract data model that is one way of preparing data for graphing.

Return:

None

Also See:

setDataFromCallBack(). See TDGDataGrid Methods in Chapter 10 for a description of the methods in the TDGDataGrid.

setDataFromResultSet()

This method graphs columns and rows in the given result set. The result set is not closed.

Syntax:

void setDataFromResultSet (java.sql.ResultSet rs);

Input:

rs: SQL Result Set

Return:

None

Also See:

setDataFromSQL()

setDataFromSQL()

This method graphs columns and rows in the given query. It creates a result set and closes the result set.

Syntax:

void setDataFromSQL (java.lang.String SQLQuery, java.sql.Statement aStmt);

Input:

SQLQuery: A Java language SQL Query String

aStmt: An SQL Statement

Return:

None

Also See:

setDataFromResultSet()

setDataLabel()

This method sets a label string at a specified series (s) and group (g).

Syntax:

void setDataLabel (
    int s,
    int g,
    java.lang.String newValue
);

Input:

s: Series number

g: Group number

newValue: Data label string

Return:

None

Also See:

getDataLabel(), getGroupLabel(), setGroupLabel(), getSeriesLabel(), setSeriesLabel(). For HTML ONLY, see setSeriesLabelArray() and setGroupLabelArray() in Chapter 4.

setDataRange()

This method is used to establish the range of data that will be used in a chart.

Syntax:

void setDataRange(int rowStop,int colStop);

void setDataRange (
    int rowStart, int colStart,
    int rowStop, int colStop );

Input:

rowStop: last row number

colStop: last column number

rowStart: first row number (0 if not specified)

colStart: first column number (0 if not specified)

Return:

None

Example:

perspective1.setDataRange(1,1,2,2);

Also See:

getDataRange(), setData(), setDataFileURL(), setDataFromCallBack(), setDataFromDataGrid(), setDataFromResultSet(), setDataFromSQL(), setDataRangeToExtent()

setDataRangeToExtent()

This method sets the range of data to be used in the chart according to the number of values identified by the setData() method. It will override values that may be set by setDataRange().

Syntax:

void setDataRangeToExtent ();

Input:

None

Return:

None

Example:

perspective1.setData(0,0,.5);/* Row 0/Col 0 */
perspective1.setData(0,1,1); /* Row 0/Col 1 */
perspective1.setData(0,2,2); /* Row 0/Col 2 */
perspective1.setData(0,3,3); /* Row 0/Col 3 */
perspective1.setData(0,4,4); /* Row 0/Col 4 */
perspective1.setData(0,5,5); /* Row 0/Col 5 */
perspective1.setData(1,0,.5); /* Row 1/Col 0 */
perspective1.setData(1,1,1); /* Row 1/Col 1 */
perspective1.setData(1,2,2); /* Row 1/Col 2 */
perspective1.setData(1,3,3); /* Row 1/Col 3 */
perspective1.setData(1,4,4); /* Row 1/Col 4 */
perspective1.setData(1,5,5); /* Row 1/Col 5 */
perspective1.setDataRangeToExtent()

Also See:

setData(), setDataFileURL(), setDataFromCallBack(),
setDataFromDataGrid(), setDataFromResultSet(), setDataFromSQL(), setDataRange()

setDataStream()

You can load any text file into a Perspective applet. This can be done by using setDataStream() which takes a stream as input or setDataFileURL which takes any valid file location or Internet URL as input. The text file needs to be organized in "spreadsheet" fashion, with rows of number for series, and columns of numbers for groups. You can optionally supply row and/or column headers which will be used for labeling the series and groups. Each value must be in quotes and separated by a comma. If you ARE supplying row and column headers, the very first word in the file must be "labels", in quotes, separated by a comma.

Syntax:

void setDataStream(java.io.InputStream in);
     throws tdg.AssertionException

Input:

in: Input Stream in which to load data.

Return:

None

Also See:

setDataFileURL()

setDataTextAngle()

This method sets the angle from center point that all or selected data text is drawn from in the chart.

Syntax:

void setDataTextAngle(int newValue);

void setDataTextAngle(tdg.draw.IdentObj id,int newValue);

void setDataTextAngle(int seriesID,int newValue);

void setDataTextAngle(int seriesID,
    int groupID,int newValue );

Input:

id: IdentObj returned by a getObject() method (e.g., getDataText())

seriesID: Series number

groupID: Group number

newValue: Data text angle (0...360)

Return:

None

Example:

perspective1.setViewableGroups(2);
perspective1.setViewableSeries(2);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataTextDisplay(true);
perspective1.setDataTextPosition(0);
perspective1.setDataTextAngle(0,0,30);
perspective1.setDataTextAngle(0,1,60);
perspective1.setDataTextAngle(1,0,90);
perspective1.setDataTextAngle(1,1,120);
perspective1.setDepthRadius(0);

Notes:

DataTextPosition must be set to zero and DataTextDisplay must be set to true in order for data text to be drawn in the chart.

Also See:

getDataTextAngle(), getDataTextRadius(), setDataTextRadius(), DataTextAngleDefault, DataTextDisplay, DataTextPosition

setDataTextRadius()

This methods sets the radius for the data text position.

Syntax:

void setDataTextRadius(int newValue);

void setDataTextRadius(tdg.draw.IdentObj id,int newValue);

void setDataTextRadius(int seriesID,int newValue);

void setDataTextRadius(int seriesID,int groupID,
    int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getDataText())

seriesID: Series number

groupID: Group number

newValue: Data text radius (0...100)

Return:

None

Example:

perspective1.setViewableGroups(2);
perspective1.setViewableSeries(2);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setDataTextDisplay(true);
perspective1.setDataTextPosition(0);
perspective1.setDataTextRadius(0,0,0);
perspective1.setDataTextRadius(0,1,10);
perspective1.setDataTextRadius(1,0,20);
perspective1.setDataTextRadius(1,1,30);
perspective1.setDepthRadius(0);

Notes:

The DataTextPosition property must be set to zero. The DataTextDisplay property must be set to true in order for data text to be drawn in the chart.

Also See:

getDataTextRadius(), getDataTextAngle(), setDataTextAngle(), DataTextRadiusDefault, DataTextDisplay, DataTextPosition

setDataValue()

This method sets a data value for a specific data object (riser) in a chart.

Syntax:

void setDataValue(
    tdg.draw.IdentObj id,
    double newValue
);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeriesGroup())

newValue: data value to be assigned to the object

Return:

None

Example:

perspective1.setDataRange(1,1,2,2);
perspective1.setDataTextDisplay(true);
perspective1.setDataTextPosition(0);
perspective1.setDataTextRadius(0,0,20);
perspective1.setDataTextRadius(0,1,20);
perspective1.setDataTextRadius(1,0,20);
perspective1.setDataTextRadius(1,1,20);
perspective1.setDataValue(
    perspective1.getSeriesGroup(0,0),100);
perspective1.setDataValue(
    perspective1.getSeriesGroup(0,1),50);
perspective1.setDataValue(
    perspective1.getSeriesGroup(1,0),25);
perspective1.setDataValue(
    perspective1.getSeriesGroup(1,1),5);
perspective1.setDepthRadius(0);

 

Also See:

getDataValue()

setDeveloperToolTip()

When the ToolTipDisplay property is enabled (true) and the ToolTipMode property selects developer information mode (1), the setDeveloperToolTip() method can be used to define a custom tool tip string that will be displayed when the user positions the mouse pointer over a selectable object in a chart.

When ToolTipMode selects developer information, the default tool tip string consists of the following: Object ID, object description, series number (if applicable), group number (if applicable), and value (if applicable).

Syntax:

void setDeveloperToolTip (java.lang.String CustomToolTip);

Input:

CustomToolTip = Any string of characters which may or may not include the following macros:

[ON] = Object Name

[OID] = Object ID

[R] = New Line

[OIN] = Object Instance

[OD] = Object Description

[SL] = Series Label

[GL] = Group Label

Return:

None

Example:

perspective1.setToolTipDisplay(true);
perspective1.setToolTipMode(true);
perspective1.setDeveloperToolTip(
    "This is the developer's tool tip");

Notes:

See "ToolTipDemoOne" in a Appendix G.

Also See:

ToolTipDisplay, ToolTipMode, setUserToolTip()

setDeveloperToolTipDefault()

The setDeveloperToolTipDefault() method selects the default developer tool tip strings that are provided with the application. When ToolTipMode selects developer information, the default tool tip string consists of the following: Object ID, object description, series number (if applicable), group number (if applicable), and value (if applicable).

Syntax:

void setDeveloperToolTipDefault();

Input:

None

Return:

None

Example:

perspective1.setDeveloperToolTipDefault();
perspective1.setToolTipMode(true);
perspective1.setToolTipDisplay(true);

Also See:

ToolTipDisplay, ToolTipMode, setDeveloperToolTip(), setUserToolTip()

setDisplay()

This method sets the display attribute of an object. If an object is not identified by id or objectID, this method will set the display attribute for the first item in the selection list. See "Getting an Object ID" in Chapter 3 for a list of methods that can be used to obtain object ID.

Syntax:

void setDisplay(boolean newValue);

void setDisplay(tdg.draw.IdentObj id, boolean newValue);

void setDisplay(int objectID, boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Title())

objectID: Object Number

newValue: true/false

 

true=

Object is displayed

 

false=

Object is not imaged

Return:

None

Example:

perspective1.setDisplay(
    perspective1.getLegendArea(), false);
perspective1.setY1TitleString("Y1 AXIS TITLE");
perspective1.setDisplay(perspective1.getY1Title(), true);
perspective1.setDisplay(
    perspective1.getSubtitle(), false);
perspective1.setY2TitleString("Y2 AXIS TITLE");
perspective1.setDisplay(perspective1.getY2Title(), true);

Also See:

getDisplay(), DataTextDisplay, Display3DFloor, Display3DRightWall, Display3DLeftWall, DualAxisLineDisplay, FootnoteDisplay, FrameDisplay, and many other object specific display properties. See Chapter 7.

setDisplayOffScale()

This method can be used to set whether or not off scale data points are imaged in a chart. You may also use one of the object-specific properties to set the off-scale attribute of a specific object (e.g., X1OffScaleDisplay(), Y1OffScaleDisplay(), etc.).

Syntax:

void setDisplayOffscale(boolean newValue);

void setDisplayOffscale(tdg.draw.IdentObj id,boolean newValue);

void setDisplayOffscale(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

newValue: true/false

 

true=

off scale values are imaged

 

false=

offscale values are not imaged

Return:

None

Example:

perspective1.setDisplayOffScale(
    perspective1.getY1Axis(),true);
perspective1.setY1MajorGridStep(10.0);
perspective1.setY1LogScale(false);
perspective1.setY1ScaleMax(80.0);
perspective1.setY1ScaleMaxAuto(false);
perspective1.setY1ScaleMinAuto(true);

Also See:

getDisplayOffScale(), X1OffScaleDisplay, Y1OffScaleDisplay, Y2OffScaleDisplay

setDynamicToolTip()

This method can be used to set the dynamic tool tip to any specific string. If NULL or "" is used, a tool tip will not be generated. Multiple lines may be used in the string definition. See the macros defined below.

Syntax:

void setDynamicToolTip (java.lang.String aTooptip);

Input:

aToolTip = Any string of characters which may or may not include the following macros:

[ON] = Object Name

[OID] = Object ID

[R] = New Line

[OIN] = Object Instance

[OD] = Object Description

[SL] = Series Label

[GL] = Group Label

Use NULL or "" to disable the generation of an event for tool tips. If you use setDynamicToolTip(null) or setDynamicToolTip("") and the callback also returns null or "", tool tips will not be generated.

Return:

None

Example:

The macros can be placed directly in a string that is being fed to a tool tip such as in a tool tip callback. See ToolTipDemoOne in Appendix G.

Also See:

setToolTipOff()

setExceptionalRiser()

This property can be used to specify an exceptional riser. An exceptional riser can be manipulated separately (e.g., colored) from other risers in the series.

Syntax:

void setExceptionalRiser();

void setExceptionalRiser( int s, int g );

Input:

s: an optional series number

g: an optional group number

Return:

None

Also See:

getExceptionRiser(), setNoExceptionalRiser()

setExcludeMaxLabel()

This method can be used to exclude the maximum label from an ordinal or numeric axis. You may also use one of the axis-specific properties to exclude the maximum label.

Syntax:

void setExcludeMaxLabel(boolean newValue);

void setExcludeMaxLabel(tdg.draw.IdentObj id,boolean newValue);

void setExcludeMaxLabel(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

newValue: true/false

 

true=

Exclude Maximum Label

 

false=

Include Maximum Label

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setLegendDisplay(false);
perspective1.setExcludeMaxLabel(
    perspective1.getY1Label(),true);

Also See:

getExcludeMaxLabel(), getExcludeMinLabel(), setExcludeMinLabel(), O1ExcludeMaxLabel, O2ExcludeMaxLabel, X1ExcludeMaxLabel, Y1ExcludeMaxLabel, Y2ExcludeMaxLabel.

setExcludeMinLabel()

This method can be used to exclude the minimum label on an ordinal or numeric axis. You may also use one of the axis-specific properties to exclude the minimum label

Syntax:

setExcludeMinLabel(boolean newValue);

setExcludeMinLabel(tdg.draw.IdentObj id, boolean newValue);

setExcludeMinLabel(int objectID, boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

newValue: true/false

 

true=

Exclude Minimum Label

 

false=

Include Minimum Label

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setLegendDisplay(false);
perspective1.setExcludeMinLabel(
    perspective1.getY1Label(),true);

Also See:

getExcludeMinLabel(), getExcludeMaxLabel(), setExcludeMaxLabel(), O1ExcludeMinLabel, O2ExcludeMinLabel, X1ExcludeMinLabel, Y1ExcludeMinLabel, Y2ExcludeMinLabel

setFillColor()

This method sets the fill color for an area object. If an object ID (id or objectID) is not specified, the method sets the fill type for the first item in the selection list. If the first item in the selection list is not an area object, the method is ignored.

Syntax:

void setFillColor(java.awt.Color newValue);

void setFillColor(tdg.draw.IdentObj id, java.awt.Color newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getChartBackground())

newValue: the value of the fill color

Return:

None

Example:

perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setFillColor(
    perspective1.getChartBackground(),
    new Color(255,255,0));

Notes:

The fill type must be set to color with setFillType(1);

Also See:

getFillColor(), getBorderColor(), setBorderColor(),
getFillType(), setFillType(), getSelectionFillColor(),
getTransparentFillColor(), setTransparentFillColor(), isSelectionFillColorTransparent(), setSeriesFillColor()

setFillType()

This method sets the fill type for an area object. If an object ID (id or objectID) is not specified, the method sets the fill type for the first item in the selection list. If the first item in the selection list is not an area object, the method is ignored.

Syntax:

void setFillType(int newValue);

void setFillType(tdg.draw.IdentObj id,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

newValue: fill type (1...3)

 

1=

Color

 

2=

Gradient

 

3=

Texture

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(4),2);
perspective1.setGradientDirection(
    perspective1.getSeries(4),1);
perspective1.setGradientNumPins(
    perspective1.getSeries(4),2);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,255),0);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),1.0,1);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),0.0,0);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,255),0);

Notes:

If you select fill type 2 (gradient), see the setGradientDirection(), setGradientNumPins(), get/setGradientPinLeftColor(), GradientPinPosition(), setGradientPinRightColor(). If you select fill type 3 (textures), use setTextureURL() and setTextureDisplayMode() methods to define the texture.

Also See:

getFillType(), getFillColor(), setFillColor(), getGradientDirection(),
setGradientDirection(), setGradientNumPins(), getGradientNumPins(),
getGradientPinLeftColor(), setGradientPinLeftColor(),
getGradientPinPosition(), setGradientPinPosition(),
getGradientPinRightColor(), setGradientPinRightColor(),
setTextureURL(), getTextureDisplayMode(), setTextureDisplayMode()

setFontName()

This method sets the name of the font to be used for a text object. If an object ID (id or objectID) is not specified, the method sets the font name for the first item in the selection list. If the first item in the selection list is not a text object, the method is ignored.

Syntax:

void setFontName(java.lang.String newValue);

void setFontName(tdg.draw.IdentObj id, java.lang.String newValue);

void setFontName(int objectID, java.lang.String newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootnote())

objectID: Object Number

newValue: Font name string

Return:

None

Example:

perspective1.setFontName(
    perspective1.getFootnote(),"TimesRoman");
perspective1.setFontName(
    perspective1.getLegendText(),"Dialog");
perspective1.setFontName(
    perspective1.getSubtitle(),"DialogInput");
perspective1.setFontName(
    perspective1.getTitle(),"Courier");

Also See:

getFontName(), getFontSizeVC(), setFontSizeVC(), getFontStyle(), setFontStyle(), setFontSize()

setFontSize()

This method sets the font size for all text objects in a chart.

Syntax:

void setFontSize (int newValue);

void setFontSize (tdg.draw.IdentObj id, int newValue);

void setFontSize (int objectID, int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: an object ID number

newValue: Font size value

Return:

None

Example:

perspective1.setFontName(
    perspective1.getFootnote(),"TimesRoman");
perspective1.setFontName(
    perspective1.getLegendText(),"Dialog");
perspective1.setFontName(
    perspective1.getSubtitle(),"DialogInput");
perspective1.setFontName(
    perspective1.getTitle(),"Courier");
perspective1.setFontSize(10);

Notes:

1.

This method disables text autofitting (setTextAutofit(false);).

2.

If the FontSizeAbsolute property is set to true, the font size set by this method will be used regardless of the virtual coordinates system. For example, if you set the font size to 24, this point size will be used regardless of the size of the window in which it is drawn.

Also See:

FontSizeAbsolute, setFontSizeVC()

setFontSizeVC()

This method sets the size of a font in virtual coordinates. If a text object is not identified with the input parameter id or objectID, this method will set the font size for the first item in the selection list.

Syntax:

void setFontSizeVC(int newValue);

void setFontSizeVC(tdg.draw.IdentObj id,int newValue);

void setFontSizeVC(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

newValue: Font size in virtual coordinates

Return:

None

Example:

perspective1.setAutofit(perspective1.getFootnote(),false);
perspective1.setAutofit(
    perspective1.getLegendText(),false);
perspective1.setAutofit(perspective1.getSubtitle(),false);
perspective1.setAutofit(perspective1.getTitle(),false);
perspective1.setFontSizeVC(
    perspective1.getY1Label(),1391);
perspective1.setFontSizeVC(
    perspective1.getLegendText(),1159);
perspective1.setFontSizeVC(perspective1.getTitle(),2086);
perspective1.setFontSizeVC(perspective1.getO1Label(),927);
perspective1.setFontSizeVC(
    perspective1.getSubtitle(),2086);
perspective1.setFontSizeVC(
    perspective1.getFootnote(),1391);

Notes:

See Virtual Coordinates in Chapter 3 if you need additional information about the values that can be set by this method. If autofitting is enabled for the text object, the font size setting will be ignored.

Also See:

FontSizeAbsolute, getFontSizeVC(), setAutofit(), setFontName(), setFontStyle(), setFontSize()

setFontStyle()

This method sets the style of a font that is used for a text object in a chart. If a specific object is not identified by the input parameter id or objectID, the method will set the font style for the first item in the selection list.

Syntax:

void setFontStyle(int newValue);

void setFontStyle(tdg.draw.IdentObj id,int newValue);

void setFontStyle(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

newValue: Font style (0...5)

 

0=

Plain

 

1=

Italic

 

2=

Bold

 

3=

Italic/Bold

 

4=

Underline

 

5=

Italic/Underline

Return:

None

Example:

perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setFontStyle(perspective1.getSubtitle(),2);
perspective1.setFontStyle(perspective1.getTitle(),7);

Example:

Also See:

getFontStyle(), getFontSizeVC(), setFontSizeVC(), getFontName(), setFontName(), setFontSize()

setGradientDirection()

This method sets the direction of a gradient that is applied to an object.

Syntax:

void setGradientDirection(int newValue);

void setGradientDirection(tdg.draw.IdentObj id,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

newValue: Gradient direction (1...13)

 

1=

Right

 

2=

Left

 

3=

Down

 

4=

Up

 

5=

Down/Left

 

6=

Up/Left

 

7=

Down/Right

 

8=

Up/Right

 

9=

Radial

 

10=

Radial/Top

 

11=

Radial/Top

 

12=

Radial/Bottom/Left

 

13=

Radial/Bottom/Right

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(4),2);
perspective1.setGradientDirection(
    perspective1.getSeries(4),1);
perspective1.setGradientNumPins(
    perspective1.getSeries(4),2);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,255),0);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),1.0,1);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),0.0,0);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,255),0);

Notes:

The fill type for the selected object must be set to two with setFillType(2).

Also See:

getGradientDirection(), getFillType(), setFillType(), setGradientNumPins(), setGradientPinLeftColor(), setGradientPinRightColor(), setGradientPinPosition(), insertGradientPin()

setGradientNumPins()

This method sets the number of pins in a gradient that is applied to an object in a chart.

Syntax:

void setGradientNumPins(int newValue);

void setGradientNumPins(tdg.draw.IdentObj id,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

newValue: Number of pins in gradient

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(4),4);
perspective1.setGradientDirection(
    perspective1.getSeries(4),1);
perspective1.setGradientNumPins(
    perspective1.getSeries(4),2);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,255),0);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),1.0,1);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),0.0,0);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,255),0);

 

Notes:

The fill type for the selected object must be set to two with the method setFillType(2).

Also See:

getGradientNumPins(), getFillType(), setFillType(), getGradientDirection(), setGradientDirection(), getGradientPinLeftColor(), setGradientPinLeftColor(), getGradientPinRightColor(), setGradientPinRightColor(), getGradientPinPosition(), setGradientPinPosition(), insertGradientPin()

setGradientPinLeftColor()

This method sets the color value of the left pin of a gradient that is applied to an object in a chart.

Syntax:

void setGradientPinLeftColor(java.awt.Color newValue,int nIndex);

void setGradientPinLeftColor(
     tdg.draw.IdentObj id,
     java.awt.Color newValue,
     int nIndex
);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

nIndex: 0...Number of pins in gradient

newValue: the color value of the left pin in a gradient

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(4),2);
perspective1.setGradientDirection(
    perspective1.getSeries(4),1);
perspective1.setGradientNumPins(
    perspective1.getSeries(4),2);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,255),0);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),1.0,1);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),0.0,0);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,255),0);

 

Notes:

The fill type for the selected object must be set to two with setFillType(2).

Also See:

getGradientPinLeftColor(), getFillType(), setFillType(),
getGradientDirection(), setGradientDirection(), getGradientNumPins(),
setGradientNumPins(), getGradientPinRightColor(),
setGradientPinRightColor(), getGradientPinPosition(),
setGradientPinPosition(), insertGradientPin()

setGradientPinPosition()

This method sets the pin position of a gradient that is applied to an object in a chart.

Syntax:

void setGradientPinPosition(double newValue,int nIndex );

void setGradientPinPosition(tdg.draw.IdentObj id,
    double NewValue, int nIndex );

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

nIndex: 0...Number of pins in gradient

newValue: position in the gradient (0.0 to 1.0)

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(4),2);
perspective1.setGradientDirection(
    perspective1.getSeries(4),1);
perspective1.setGradientNumPins(
    perspective1.getSeries(4),2);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,255),0);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),1.0,1);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),0.0,0);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,255),0);

 

Notes

The fill type for the selected object must be set to two with setFillType(2).

Also See:

getGradientPinPosition(), getFillType(), setFillType(), getGradientDirection(), setGradientDirection(), getGradientNumPins(), setGradientNumPins(), getGradientPinRightColor(), setGradientPinRightColor(), getGradientPinLeftColor(), setGradientPinLeftColor(), insertGradientPin()

setGradientPinRightColor()

This method sets the color value of the right pin of a gradient.

Syntax:

void setGradientPinRightColor(java.awt.Color newValue,int nIndex);

void setGradientPinRightColor(tdg.draw.IdentObj id,
    java.awt.Color newValue, int nIndex );

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

nIndex: 0...Number of pins in gradient

newValue: the color value of the right pin in a gradient

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(4),2);
perspective1.setGradientDirection(
    perspective1.getSeries(4),1);
perspective1.setGradientNumPins(
    perspective1.getSeries(4),2);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinLeftColor(
    perspective1.getSeries(4), new Color(0,0,255),0);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),1.0,1);
perspective1.setGradientPinPosition(
    perspective1.getSeries(4),0.0,0);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,0),1);
perspective1.setGradientPinRightColor(
    perspective1.getSeries(4), new Color(0,0,255),0);

 

Notes:

The fill type for the selected object must be set to two with setFillType(2).

Also See:

getGradientPinRightColor(), getFillType(), setFillType(),
getGradientDirection(), setGradientDirection(), getGradientNumPins(),
setGradientNumPins(), getGradientPinPosition(), setGradientPinPosition(),
getGradientPinLeftColor(), setGradientPinLeftColor(), insertGradientPin()

setGridCount()

This method can be used to set the number of minor grid lines that will appear between major grid lines.

Syntax:

void setGridCount(int newValue);

void setGridCount(tdg.draw.IdentObj id,int newValue);

void setGridCount(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1MinorGrid())

objectID: Object Number

newValue: the number of grid lines for the object

Return:

None

Example:

perspective1.setDataTextDisplay(true);
perspective1.setDataTextPosition(0);
perspective1.setDataTextRadius(0,0,20);
perspective1.setDataTextRadius(0,1,20);
perspective1.setDataTextRadius(1,0,20);
perspective1.setDataTextRadius(1,1,20);
perspective1.setDataValue(
    perspective1.getSeriesGroup(0,0),100);
perspective1.setDataValue(
    perspective1.getSeriesGroup(0,1),50);
perspective1.setDataValue(
    perspective1.getSeriesGroup(1,0),25);
perspective1.setDataValue(
    perspective1.getSeriesGroup(1,1),5);
perspective1.setDepthRadius(0);
perspective1.setGridCount(
    perspective1.getO1MinorGrid(),2);
perspective1.setDisplay(
    perspective1.getO1MinorGrid(),true);
perspective1.setGridStyle(
    perspective1.getO1MajorGrid(),3);

Also See:

getGridCount(), O1MinorGridCount

setGridStep()

This method sets the number of grid steps used on a numeric axis. If the input parameters id or objectID do not identify an axis in the chart, the method sets the number of grid steps for the first item in the selection list. You may also use one of the axis-specific properties to set the number of grid steps assigned on an axis (e.g., X1MajorGridStep, X1MinorGridStep, Y1MajorGridStep, etc.). The value assigned by this method will be ignored if setGridStepAuto() enables (TRUE) automatic calculation of grid steps on a particular axis.

Syntax:

void setGridStep(double newValue);

void setGridStep(tdg.draw.IdentObj id,double newValue);

void setGridStep(int objectID,double newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1MajorGrid())

objectID: Object Number

newValue: the number of grid steps on an axis

Return:

None

Example:

perspective1.setGraphType(61);
perspective1.setGridStep(
    perspective1.getX1MajorGrid(),20.0);
perspective1.setGridStep(
    perspective1.getY1MajorGrid(),10.0);
perspective1.setX1MinorGridStepAuto(true);
perspective1.setX1MajorGridStepAuto(false);

Also See:

getGridStep(), getGridStepAuto(), setGridStepAuto(), X1MajorGridStep, X1MajorGridStepAuto, X1MinorGridStep, X1MinorGridStepAuto, Y2MajorGridStep, Y2MajorGridStepAuto, Y2MinorGridStep, Y2MinorGridStepAuto, Y1MajorGridStep, Y1MajorGridStepAuto, Y1MinorGridStep, Y1MinorGridStepAuto

setGridStepAuto()

This method sets a boolean that indicates whether or not grid steps are automatically calculated for a specified numeric axis in a chart. You may also use one of the axis-specific properties to set whether or not grid steps are automatically calculated on an axis (e.g., X1MajorGridStepAuto, X1MinorGridStepAuto, Y1MajorGridStepAuto, etc.). If this method sets a value of TRUE, a value assigned by setGridStep() will be ignored.

Syntax:

void setGridStepAuto(boolean newValue);

void setGridStepAuto(tdg.draw.IdentObj id,boolean newValue);

void setGridStepAuto(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1MajorGrid())

objectID: Object Number

newValue: true/false

 

true=

grid steps are automatically calculated

 

false=

grid steps are not automatically calculated

Return:

None

Example:

perspective1.setGraphType(61);
perspective1.setX1MajorGridStep(20.0);
perspective1.setY1MinorGridStep(5.0);
perspective1.setY1MajorGridStep(10.0);
perspective1.setGridStepAuto(
    perspective1.getX1MinorGrid(),true);
perspective1.setGridStepAuto(
    perspective1.getY1MinorGrid(),false);
perspective1.setGridStepAuto(
    perspective1.getX1MajorGrid(),false);
perspective1.setGridStepAuto(
    perspective1.getY1MajorGrid(),true);

Also See:

getGridStepAuto(), getGridStep(), setGridStep(), X1MajorGridStepAuto, X1MinorGridStepAuto, Y2MajorGridStepAuto, Y2MinorGridStepAuto, Y1MajorGridStepAuto, Y1MinorGridStepAuto

setGridStyle()

This method selects the style of grids on an axis.

Syntax:

void setGridStyle(tdg.draw.IdentObj id,int newValue);

void setGridStyle(int newValue);

void setGridStyle(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getX1MajorGrid())

objectID: Object Number

newValue: Grid Style (0...5)

 

0=

No Grid

 

1=

Normal Grid

 

2=

Grid and Ticks

 

3=

Inner Ticks

 

4=

Outer Ticks

 

5=

Spanned Ticks

Return:

None

Example:

perspective1.setY1MinorGridDisplay(true);
perspective1.setGraphType(61);
perspective1.setX1MajorGridStep(20.0);
perspective1.setY1MinorGridStep(5.0);
perspective1.setY1MajorGridStep(10.0);
perspective1.setY1MinorGridStepAuto(false);
perspective1.setX1MajorGridStepAuto(false);
perspective1.setGridStyle(
    perspective1.getX1MinorGrid(),0);
perspective1.setGridStyle(
    perspective1.getX1MajorGrid(),1);
perspective1.setGridStyle(
    perspective1.getY1MinorGrid(),2);
perspective1.setGridStyle(
    perspective1.getY1MajorGrid(),4);

Also See:

getGridStyle(), O1MajorGridStyle, O1MinorGridStyle, X1MajorGridStyle, X1MinorGridStyle, Y1MajorGridStyle, Y1MinorGridStyle, Y2MajorGridStyle, Y2MinorGridStyle

setGroupLabel()

This method defines a group label.

Syntax:

void setGroupLabel(tdg.draw.IdentObj id, java.lang.String newValue);

void setGroupLabel(int g, java.lang.String newValue);

void setGroupLabel(java.lang.String newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getGroup())

g: a group number

newValue: Group label string

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setGroupLabel(0,"Fish");
perspective1.setGroupLabel(1,"Birds");
perspective1.setGroupLabel(2,"Cats");
perspective1.setGroupLabel(3,"Puppies");
perspective1.setGroupLabel(4,"Parrots");
perspective1.setGroupLabel(5,"Spiders");
perspective1.setTitleString("Jake's Pet Store");

Also See:

getDataLabel(), setDataLabel(), getSeriesLabel(), setSeriesLabel()

setIgnoreSeries()

This method can be used to ignore (do not draw) a particular series in a chart.

Syntax:

void setIgnoreSeries (boolean newValue);

void setIgnoreSeries (tdg.draw.IdentObj id, boolean newValue);

void setIgnoreSeries (int seriesID, boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries(1))

seriesID: Series Number

newValue: true/false

 

true=

Ignore series "s"

 

false=

Restore previously ignored series "s"

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setIgnoreSeries(2,true);

 

perspective1.setIgnoreSeries(2,false);

setLabelMargin()

This method can be used to assign a margin value to a label.

Syntax:

void setLabelMargin( int newValue );

void setLabelMargin(tdg.draw.IdentObj id, int newValue );

void setLabelMargin( int objectID, int newValue );

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries(1))

objectID: an object ID Number

newValue: 0...100% label margin value

Return:

None

Also See:

getLabelMargin()

setLabelStagger()

This method enables/disables staggered labels on an axis. You may also use one of the axis-specific properties to set whether or not labels are staggered on a particular axis (e.g., X1LabelStagger, Y1LabelStagger, Y2LabelStagger, etc.).

Syntax:

void setLabelStagger(boolean newValue)

void setLabelStagger(tdg.draw.IdentObj id,boolean newValue);

void setLabelStagger(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (eg., getO1Label())

objectID: Object Number

newValue: true/false

 

true=

Stagger labels

 

false=

Do not stagger labels

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setGroupLabel(0,"Fish");
perspective1.setGroupLabel(1,"Birds");
perspective1.setGroupLabel(2,"Cats");
perspective1.setGroupLabel(3,"Puppies");
perspective1.setGroupLabel(4,"Parrots");
perspective1.setGroupLabel(5,"Spiders");
perspective1.setLabelStagger(true);
perspective1.setTitleString("Jake's Pet Store");

getLabelStagger(), O1LabelStagger, X1LabelStagger, Y1LabelStagger, Y2LabelStagger

setLegendOrient()

This method is used to set the orientation of the legends in a chart.

Syntax:

void setLegendOrient (int newValue);

newValue: 0/1

 

0=

Vertical

 

1=

Horizontal

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setGroupLabel(0,"Fish");
perspective1.setGroupLabel(1,"Birds");
perspective1.setGroupLabel(2,"Cats");
perspective1.setGroupLabel(3,"Puppies");
perspective1.setGroupLabel(4,"Parrots");
perspective1.setGroupLabel(5,"Spiders");
perspective1.setLabelStagger(true);
perspective1.setTitleString("Jake's Pet Store");
perspective1.setLegendOrient(0);

Also See:

setLegendTextAutofit(), LegendAutomatic, LegendDisplay, LegendMarkerPosition, LegendReverse

setLegendRect()

This method sets the size and location of the legend rectangle. This rectangle is the area in the chart where legend markers and labels are drawn.

Syntax:

void setLegendRect(java.awt.Rectangle newValue);

void setLegendRect(java.awt.Rectangle newValue, boolean bSetRecalc);

Input:

Rectangle: location/size of legend area

bSetRecalc: true / false

 

true=

recalculate entire chart based on new legend rectangle

 

false=

do not recalculate

Return:

None

Example:

perspective1.setGraphType(69);
perspective1.setLegendRect(
    new Rectangle(-15340,-3478,4948,18550));

Also See:

getLegendRect(), LegendAutomatic, LegendDisplay, LegendMarkerPosition, LegendReverse, LegendTextAutofit

setLegendTextAutofit()

This method to enables (true) / disables (false) automatic fitting and sizing of the legend text within the legend rectangle area.

Syntax:

void setLegendTextAutofit (boolean newValue);

Input:

newValue: true / false

 

true=

autofit legend text

 

false=

use font size setting

Return:

None

Example:

perspective1.setGraphType(69);
perspective1.setLegendTextAutofit(false);
perspective1.setFontSizeVC(
    perspective1.getLegendText(),1159);
perspective1.setFontStyle(perspective1.getLegendText(),2);
perspective1.setX1MajorGridStep(10.0);

Also See:

setLegendOrient(), LegendAutomatic, LegendDisplay, LegendMarkerPosition, LegendReverse

setLineWidth()

This method defines the thickness (in pixels) of a line object. See "Getting an Object ID" in Chapter 3 for a list of methods that can be used to get the ID of a line object.

Syntax:

void setLineWidth(IdentObj id,int newValue);

void setLineWidth(int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries ())

objectID: Object Number

newValue: line width in pixels

Return:

None

Example:

perspective1.setGraphType(67);
perspective1.setLineWidth(perspective1.getSeries(3),10);
perspective1.setLineWidth(perspective1.getSeries(1),10);

 

Also See:

getLineWidth()

setLogScale()

This method selects logarithmic or linear scale on an axis. You may also use one of the axis-specific properties to select a logarithmic or linear scale (e.g., X1LogScale, Y1LogScale, Y2LogScale, etc.).

Syntax:

void setLogScale(boolean newValue);

void setLogScale(tdg.draw.IdentObj id,boolean newValue);

void setLogScale(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

objectID: Object Number

newValue: true/false

 

true=

use logarithmic scale

 

false=

use linear scale

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setY1MinorGridStep(0.5);
perspective1.setY1MajorGridStep(1.0);
perspective1.setY1MinorGridStepAuto(true);
perspective1.setY1MajorGridStepAuto(true);
perspective1.setLogScale(perspective1.getY1Axis(),true);
perspective1.setY1ScaleMaxAuto(true);
perspective1.setY1ScaleMinAuto(true);
perspective1.setY1MustIncludeZero(false);

Also See:

setLogScaleBase(), X1LogScale, Y1LogScale, Y2LogScale

setLogScaleBase()

When logarithmic scaling is used on a numeric axis in a chart, this property sets the lowest/base value drawn on the axis.

Syntax:

void setLogScaleBase(double newValue)

void setLogScaleBase(tdg.draw.IdentObj id, double newValue)

void setLogScaleBase(int objectID, double newValue)

Input:

newValue: Log scale base value

id: IdentObj returned by a getObject() method (e.g., getY1Axis())

int; An object value

Return:

void

Also See:

getLogScale(), getLogScaleBase(), setLogScale()

setMarkerShape()

This method sets the shape of a marker object. If an object ID (id) is not specified, the method sets the marker shape (if any) for the first item in the selection list.

Syntax:

void setMarkerShape(int integerMarkerShape );

void setMarkerShape(tdg.draw.IdentObj id,int integerMarkerShape);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries(1))

newValue or integerMarkerShape: a value 0...6

 

0=

Null

 

1=

Square

 

2=

Circle

 

3=

Diamond

 

4=

Plus

 

5=

Triangle/Down

 

6=

Triangle/Up

Return:

None

Example:

perspective1.setGraphType(61);
perspective1.setMarkerShape(0,6);
perspective1.setMarkerShape(1,5);
perspective1.setMarkerShape(2,4);
perspective1.setMarkerShape(3,3);
perspective1.setMarkerShape(4,2);
perspective1.setMarkerShape(5,1);

Also See:

getMarkerShape(), getMarkerSize(), setMarkerSize(), getMarkerTemplate(), MarkerDisplay, MarkerSizeDefault.

setMarkerSize()

This method sets the size of a marker in a chart. If an object ID (id) or series ID (seriesID) is not specified, the method sets the size of the marker (if any) for the first item in the selection list.

Syntax:

void setMarkerSize(int newValue );

void setMarkerSize(tdg.draw.IdentObj id, int newValue);

void setMarkerSize(int seriesID,int newValue);

void setMarkerSize(int seriesID,int groupID,int newValue);

Input:

seriesID: series number

groupID: group number

id: IdentObj returned by a getObject() method (e.g., getSeries(1))

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

Return:

None

Example:

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

Also See:

getMarkerSize(), getMarkerShape(), setMarkerShape(), MarkerDisplay, MarkerSizeDefault

setMarkerTemplate()

This method is used to assign a user-defined marker to a marker template slot. You can use getNextMarkerTemplateSlot() to determine the next marker template slot that is not used.

Syntax:

void setMarkerTemplate (
    int nIndex,
    java.awt.Polygon newPolygon
);

void setMarkerTemplate (
    int nIndex,
    tdg.MarkerTemplate MarkerTemplate new Template
);

Input:

int: 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:

None

Also See:

getMarkerTemplate(), getNextMarkerTemplateSlot(), registerMarkerTemplate()

setNoExceptionalRiser()

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

Syntax:

void setNoExceptionalRiser();

Input:

None

Return:

None

Also See:

getExceptionalRiser(), getExceptionalRisers(), setExceptionalRiser(), isExceptionalAllowed()

setNoSelection()

This method removes all currently selected items from the selection list.

Syntax:

void setNoSelection();

Input:

None

Return:

None

Note:

You may also use setSelection( (tdg.draw.IdentObj) null );

Also See:

setSelection()

setNumberFormatCallBack()

This method can be used to register a "number format callback" object. The assigned object will be called by Perspective's custom number formatting code.

Syntax:

void setNumberFormatCallBack(
    NumberFormatCallBack numberFormattingObject
);

Input:

numberFormattingObject: a number format call back object

Return:

None

Also See:

getNumberFormatCallBack(), isNumberFormatCallBack(), CustomNumberFormatting.Java, TestNumberFormatCallBack.Java

setO1LabelCallback()

This function is used to assign a call back function to handle the nested label functions that are enabled by the NestedLabels property. This function must implement all of the abstract methods in TDGNestedLabel.Java. They are:

 

public abstract int getNumLevels();

 

public abstract int getNumLabelsOnLevel(int nLevel);

 

public abstract Vector getAllLabels(int nLevel);

 

public abstract String getLabel(
    int nGroup, int nLevel);

 

public abstract int getLabelGrouping(
    int nGroup, int nLevel);

Syntax:

void setO1LabelCallback (TDGNestedLabel cb);

Input:

cb: a nested labels call back object

Return:

None

Also See:

getO1LabelCallback(), NestedLabels

setPieSliceDelete()

This method can be used to delete a slice from a pie chart.

Syntax:

public void setPieSliceDelete(boolean newValue);

public void setPieSliceDelete(tdg.draw.IdentObj id, 
    boolean newValue );

public void setPieSliceDelete(int seriesID, 
    boolean newValue );

public void setPieSliceDelete(int seriesID,
    int groupID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (eg., getSlice ())

 

seriesID: series number

 

groupID: group number

 

newValue: true/false

 

true=

delete slice

 

false=

do not delete slice

Return:

None

Example:

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

Also See:

getPieSliceDelete(), getPieSliceDetach(), setPieSliceDetach(),
restoreAllSlices()

setPieSliceDetach()

This method detaches a slices from a pie chart by a specified distance.

Syntax:

public void setPieSliceDetach(boolean newValue);

public void setPieSliceDetach(tdg.draw.IdentObj id, 
    boolean newValue );

public void setPieSliceDetach(int seriesID, 
    boolean newValue );

public void setPieSliceDetach(int seriesID,
    int groupID, int newValue);

Input:

id: IdentObj returned by a getObject() method (eg., getSlice ())

 

seriesID: series number

 

groupID: group number

 

newValue: distance (0...100) to detach slice

Return:

None

Example:

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

Also See:

getPieSliceDetach(), getPieSliceDelete(), setPieSliceDelete(),
restoreAllSlices()

setQuadrantLineValueX()

This method sets the scale value at which to place vertical quadrant line number nIndex.

Syntax:

void setQuadrantLineValueX(
    int nIndex,
    double newValue
);

Input:

nIndex: Quadrant line number (0...number of quadrant lines in chart)

double: Scale value. NO_LINEVALUE = enable automatic scaling

Return:

None

Example:

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

perspective1.setQuadrantLineValueX(0,20);

Also See:

setQuadrantLineValueY()

setQuadrantLineValueY()

This method sets the scale value at which to place horizontal quadrant line number nIndex.

Syntax:

void setQuadrantLineValueY(
    int nIndex,
    double newValue
);

Input:

nIndex: Quadrant line number (0...number of quadrant lines in chart)

double: Scale value. NO_LINEVALUE = enable automatic scaling

Return:

None

Example:

perspective1.setGraphType(89);
perspective1.setQuadrantLineValueY(10);

perspective1.setQuadrantLineValueY(60);

Also See:

setQuadrantLineValueX()

setRect()

This method sets the bounding rectangle for a user-movable object in virtual coordinates (x, y, width, height). See Chapter 3 for a description of the virtual coordinates and a list of user-movable objects.

Syntax:

public void setRect(Rectangle newValue);

public void setRect(tdg.draw.IdentObj id, java.awt.Rectangle newValue);

public void setRect(int objectID, java.awt.Rectangle newValue);

Input:

id: IdentObj returned by a getObject() method (eg., getSlice ())

objectID: Object number

Rectangle: the bounding rectangle for a user-movable object in virtual coordinates (x, y, width, height)

Return:

None

Example:

perspective1.setRect(perspective1.getTitle(),
    new Rectangle(-15175,10550,29850,1800));

Also See:

getRect(), getFrameRect(), getLegendRect(), setLegendRect()

setScaleMax()

This method sets the maximum scale value assigned to a numeric axis in a chart. You may also use one of the axis-specific properties to set the maximum scale on a particular axis (e.g., X1ScaleMax(), Y1ScaleMax(), Y2ScaleMax(), etc.). If setScaleMaxAuto() sets autoscaling to TRUE, the value set by setScaleMax() will be ignored. If an object ID is not specified, the method sets the value of this attribute (if any) for the first item in the selection list.

Syntax:

void setScaleMax ( double newValue );

void setScaleMax (tdg.draw.IdentObj id, double newValue );

void setScaleMax ( int objectID, double newValue );

Input:

id: IdentObj returned by a getObject() method (eg., getX1Axis())

objectID: Object number

newValue: a value identifying the maximum scale value on an axis

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setY1MajorGridStep(10.0);
perspective1.setY1LogScale(false);
perspective1.setScaleMax(perspective1.getY1Axis(),50.0);
perspective1.setY1ScaleMaxAuto(false);
perspective1.setY1ScaleMinAuto(true);
perspective1.setY1MustIncludeZero(false);

Also See:

getScaleMax(), setScaleMaxAuto(), setScaleMin(), setScaleMinAuto()

setScaleMaxAuto()

This method sets automatic calculation of the maximum scale value for a numeric axis. You may also use one of the axis-specific properties to set automatic scaling on a particular axis (e.g., X1ScaleMaxAuto(), Y1ScaleMaxAuto(), Y2ScaleMaxAuto(), etc.). If this method set a value of true, a value set by setScaleMax() is ignored. If an object ID is not specified, this method returns the value of this attribute (if any) for the first item in the selection list.

Syntax:

void setScaleMaxAuto(boolean newValue);

void setScaleMaxAuto(tdg.draw.IdentObj id,boolean newValue);

void setScaleMaxAuto(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (eg., getX1Axis())

objectID: Object number

newValue: true / false

 

true=

automatically calculate maximum value on axis

 

false=

use value set by setScaleMax()

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setY1MajorGridStep(10.0);
perspective1.setY1LogScale(false);
perspective1.setY1ScaleMax(50.0);
perspective1.setScaleMaxAuto(
    perspective1.getY1Axis(),false);
perspective1.setY1ScaleMinAuto(true);
perspective1.setY1MustIncludeZero(false);

Also See:

getScaleMaxAuto(), setScaleMax(), setScaleMin(), setScaleMinAuto()

setScaleMin()

This method sets the minimum scale value assigned to a numeric axis in a chart. You may also use one of the axis-specific properties to set the minimum scale on a particular axis (e.g., X1ScaleMin(), Y1ScaleMin(), Y2ScaleMin(), etc.). If setScaleMinAuto() sets autoscaling to TRUE, the value set by setScaleMin() will be ignored. If an object ID is not specified, the method sets the value of this attribute (if any) for the first item in the selection list.

Syntax:

void setScaleMin ( double newValue );

void setScaleMin (tdg.draw.IdentObj id, double newValue );

void setScaleMin ( int objectID, double newValue );

Input:

id: IdentObj returned by a getObject() method (eg., getX1Axis())

objectID: Object number

newValue: the minimum scaling value that can be used on an axis

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setY1MajorGridStep(5.0);
perspective1.setY1LogScale(false);
perspective1.setY1ScaleMax(65.0);
perspective1.setY1ScaleMaxAuto(true);
perspective1.setScaleMin(perspective1.getY1Axis(),20.0);
perspective1.setY1ScaleMinAuto(false);
perspective1.setY1MustIncludeZero(false);

Also See:

getScaleMin(), setScaleMax(), setScaleMaxAuto(), setScaleMinAuto()

setScaleMinAuto()

This method sets automatic calculation of the maximum scale value for a numeric axis. You may also use one of the axis-specific properties to set automatic scaling on a particular axis (e.g., X1ScaleMinAuto(), Y1ScaleMinAuto(), Y2ScaleMinAuto(), etc.). If this method sets a value of true, a value returned set by setScaleMin() is ignored.

Syntax:

void setScaleMinAuto(boolean newValue );

void setScaleMinAuto(tdg.draw.IdentObj id,boolean newValue);

void setScaleMinAuto(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (eg., getSlice ())

objectID: Object number

newValue: true/false

 

true=

automatically calculate minimum value

 

false=

use value set by setScaleMin()

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setY1MajorGridStep(5.0);
perspective1.setY1LogScale(false);
perspective1.setY1ScaleMax(65.0);
perspective1.setY1ScaleMaxAuto(true);
perspective1.setY1ScaleMin(20.0);
perspective1.setScaleMinAuto(
    perspective1.getY1Axis(),false);
perspective1.setY1MustIncludeZero(false);

Also See:

getScaleMinAuto(), setScaleMin(), setScaleMax(), setScaleMaxAuto()

setScaleMustIncludeZero()

This method sets whether or not a given axis must include a zero value. You may also use one of the axis-specific properties to set a mandatory zero on a particular axis (e.g., X1MustIncludeZero(), Y1MustIncludeZero(), Y2MustIncludeZero (), etc.). If an object ID is not specified, the method sets the value of this attribute (if any) for the first item in the selection list.

Syntax:

void setScaleMustIncludeZero(boolean newValue );

void setScaleMustIncludeZero(tdg.draw.IdentObj id,
    boolean newValue);

void setScaleMustIncludeZero(int objectID,
    boolean newValue);

Input:

id: IdentObj returned by a getObject() method (eg., getX1Axis())

objectID: Object number

newValue: true/false

 

true=

axis must include zero

 

false=

zero is not required on this axis

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setY1MajorGridStep(5.0);
perspective1.setY1LogScale(false);
perspective1.setY1ScaleMax(65.0);
perspective1.setY1ScaleMaxAuto(true);
perspective1.setY1ScaleMin(20.0);
perspective1.setY1ScaleMinAuto(false);
perspective1.setScaleMustIncludeZero(
    perspective1.getY1Axis(),false);

Also See:

getScaleMustIncludeZero()

setSelection()

This method can be used to select part of a chart at the API level without using the mouse. For example, you could select the frame by using:

getSelection(getFrame());

In some cases, this will require providing a series, group, or both as shown in the following example:

getSelection(getBarRiser(s,g));

Syntax:

void setSelection(tdg.draw.IdentObj id );

void setSelection(tdg.draw.IdentObj id, boolean bAdd );

void setSelection(tdg.draw.IdentObj id, boolean bAdd,
    boolean bSelectRelatedObjects );

void setSelection(java.util.Vector vList );

Example:

perspective1.setSelection(perspective1.getBarRiser(0,0) );
perspective1.setFillColor( new Color(0, 0, 0) );
perspective1.setDepthRadius(0);

Also See:

getSelection(), setNoSelection()

setSeriesAreRows()

This method can be used to store series values and rows or columns and to swap the order of series and group labels.

Syntax:

void setSeriesAreRows(
    boolean newValue,
    boolean swapLabels
)

Input:

newValue: true/false

 

true=

Store series as rows

 

false=

Store series as columns

swapLabels: true/false

 

true=

Swap Series and Group Labels

 

false=

Do not swap series and group labels

Return:

None

setSeriesBorderColor()

This method can be used to set the border color of risers for a specified series in a chart.

Syntax:

void setSeriesBorderColor (
    int s,
    java.awt.Color newValue
);

Input:

s: Series Number

newValue: RGB Color Value

Return:

None

Example:

perspective1.setSeriesBorderColor(4,new Color(0,0,0));
perspective1.setDepthRadius(0);
perspective1.setSeriesFillColor(4,new Color(255,255,255));
perspective1.setSeriesBorderColor(3,new Color(0,0,0));
perspective1.setSeriesFillColor(3,new Color(255,255,255));
perspective1.setSeriesBorderColor(2,new Color(0,0,0));
perspective1.setSeriesFillColor(2,new Color(255,255,255));
perspective1.setSeriesBorderColor(1,new Color(0,0,0));
perspective1.setSeriesFillColor(1,new Color(255,255,255));
perspective1.setSeriesBorderColor(0,new Color(0,0,0));
perspective1.setSeriesFillColor(0,new Color(255,255,255));

Also See:

getBorderColor(), setBorderColor(), getSelectionBorderColor(), getTransparentBorderColor(), setTransparentBorderColor(), isSelectionBorderColorTransparent(), setSeriesFillColor()

setSeriesFillColor()

This method sets the fill color of risers for a specified series in a chart.

Syntax:

void setSeriesFillColor (
    int s,
    java.awt.Color newValue
);

Input:

s: Series Number

newValue: RGB Color Value

Return:

None

Example:

perspective1.setSeriesBorderColor(4,new Color(0,0,0));
perspective1.setDepthRadius(0);
perspective1.setSeriesFillColor(4,new Color(255,255,255));
perspective1.setSeriesBorderColor(3,new Color(0,0,0));
perspective1.setSeriesFillColor(3,new Color(255,255,255));
perspective1.setSeriesBorderColor(2,new Color(0,0,0));
perspective1.setSeriesFillColor(2,new Color(255,255,255));
perspective1.setSeriesBorderColor(1,new Color(0,0,0));
perspective1.setSeriesFillColor(1,new Color(255,255,255));
perspective1.setSeriesBorderColor(0,new Color(0,0,0));
perspective1.setSeriesFillColor(0,new Color(255,255,255));

Also See:

getFillColor(), setFillColor(), getSelectionFillColor(),
getTransparentFillcolor(), setTransparentFillColor(),
isSelectionFillColorTransparent(), setSeriesBorderColor()

setSeriesLabel()

This method sets a label string associated with a series in a chart. If a valid series is not identified with the input parameters id or seriesID, the series label is assigned to the first item in the selection list.

Syntax:

null setSeriesLabel(java.lang.String newValue);

null setSeriesLabel(tdg.draw.IdentObj id, java.lang.String newValue);

null setSeriesLabel(int seriesID, java.lang.String newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

objectID: Object Number

String: series label string

Return:

None

Also See:

getSeriesLabel()

setSeriesType()

This method sets the series type for a specific object, series number, or the first item in the selection list.

Syntax:

void setSeriesType ( int newValue );

void setSeriesType (tdg.draw.IdentObj id, int newValue );

void setSeriesType ( int seriesID, int newValue );

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

objectID: Object Number

newValue: series type (0...3)

 

0=

Riser Unspecified

 

1=

Riser Bar

 

2=

Riser Marker

 

3=

Riser Area

Return:

None

Example:

perspective1.setDataRange(0,0,2,2);
perspective1.setDepthRadius(0);
perspective1.setSeriesType(0,1);
perspective1.setSeriesType(1,2);
perspective1.setSeriesType(2,3);

Also See:

getSeriesType()

setShadowColor()

This method sets the color value of a drop shadow.

Syntax:

void setShadowColor(
     tdg.draw.IdentObj id,
     java.awt.Color newValue
);

Input:

id: IdentObj returned by a getObject() method

color: the value of the color to be applied to the drop shadow id

Return:

None

Also See:

getShadowColor(), getShadowDisplay(), setShadowDisplay(), getShadowXOffset(), setShadowXOffset(), getShadowYOffset(), setShadowYOffset()

setShadowDisplay()

This method applies a drop shadow to an object.

Syntax:

public void setShadowDisplay(boolean newValue);

public void setShadowDisplay(tdg.draw.IdentObj id,
    boolean newValue);

public void setShadowDisplay(int objectID, 
    boolean newValue );

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

newValue: true/false

 

true=

Display drop shadow

 

false=

Do not display drop shadow

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setViewableGroups(3);
perspective1.setViewableSeries(3);
perspective1.setDataScrollerPresenceGroups(0);
perspective1.setFontStyle(perspective1.getSubtitle(),2);
perspective1.setFontStyle(perspective1.getTitle(),7);
perspective1.setGraphType(17);
perspective1.setShadowDisplay(
    perspective1.getO2Label(),true);
perspective1.setShadowDisplay(
    perspective1.getFootnote(),true);

 

Also See:

getShadowColor(), setShadowColor(), getShadowXOffset(), setShadowXOffset(), getShadowYOffset(), setShadowYOffset(), ShadowXOffsetDefault, ShadowYOffsetDefault

setShadowXOffset()

This method sets the offset in the X-direction of a drop shadow.

Syntax:

public void setShadowXOffset(int newValue);

public void setShadowXOffset(tdg.draw.IdentObj id,int newValue);

public void setShadowXOffset(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

newValue: X-direction offset of the drop shadow applied to id, null = no drop shadow applied

Return:

None

Also See:

getShadowXOffset(), getShadowColor(), setShadowColor(), getShadowDisplay(), setShadowDisplay(), getShadowYOffset(), setShadowYOffset(), ShadowXOffsetDefault, ShadowYOffsetDefault

setShadowYOffset()

These methods get/set the offset in the Y-direction of a drop shadow.

Syntax:

public void setShadowYOffset(int newValue);

public void setShadowYOffset(tdg.draw.IdentObj id,int newValue);

public void setShadowYOffset(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

newValue: Y-direction offset of the drop shadow applied to id, null = no drop shadow applied

Return:

None

Also See:

getShadowYOffset(), getShadowColor(), setShadowColor(), getShadowDisplay(), setShadowDisplay(), getShadowXOffset(), setShadowXOffset(), ShadowXOffsetDefault, ShadowYOffsetDefault

setSkipBegin()

When setAutoSkip() selects manual skip mode, this method selects the first label to skip on the O1 axis.

Syntax:

void setSkipBegin(int newValue);

void setSkipBegin(tdg.draw.IdentObj id, int newValue);

void setSkipBegin(int ObjectID, int NewValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label ())

objectID: Object Number

newValue: 0...Number of groups in chart

Return:

None

Example:

perspective1.setAutoSkip(perspective1.getO1Label(),2);
perspective1.setSkipBegin(perspective1.getO1Label(),1);
perspective1.setSkipCount(perspective1.getO1Label(),1);

Also See:

setAutoSkip(), setSkipCount()

setSkipCount()

When setAutoSkip() selects manual skip mode, this method selects the interval of labels to skip after setSkipBegin().

Syntax:

void setSkipCount(int newValue);

void setSkipCount(tdg.draw.IdentObj id, int newValue);

void setSkipCount(int ObjectID, int NewValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

newValue: 0...Number of groups in chart

Return:

None

Example:

perspective1.setAutoSkip(perspective1.getO1Label(),2);
perspective1.setSkipBegin(perspective1.getO1Label(),1);
perspective1.setSkipCount(perspective1.getO1Label(),1);

Also See:

setAutoSkip(), setSkipBegin()

setTextFormatPattern()

This method sets a standard Java number format pattern for a data text or label object.

Syntax:

void setTextFormatPattern(java.lang.String newValue);

void setTextFormatPattern(tdg.draw.IdentObj id, java.lang.String newValue);

void setTextFormatPattern(int objectID, java.lang.String newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

newValue = A pattern string in the following format:

pattern:= subpattern{;subpattern}
subpattern:= {prefix}integer{.fraction}{suffix}
prefix:= '\\u0000'..'\\uFFFD' - specialCharacters
suffix:= '\\u0000'..'\\uFFFD' - specialCharacters
integer:= '#'* '0'* '0'
fraction:= '0'* '#'*

See Chapter 3 for more detailed information about this format pattern

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setDataRange(1,1,2,2);
perspective1.setDataTextDisplay(true);
perspective1.setTextFormatPreset(
    perspective1.getY1Label(),-1);
perspective1.setTextFormatPattern(
    perspective1.getY1Label(),"$##");

Also See:

getTextFormatPattern(), getTextFormatPreset(), setTextFormatPreset(), DataTextFormat, PieFeelerTextFormat, PieRingTotalFormat, X1LabelFormat, Y1LabelFormat, Y2LabelFormat

setTextFormatPreset()

This method selects one of the preset formats for a text object.

Syntax:

void setTextFormatPreset(int newValue);

void setTextFormatPreset(tdg.draw.IdentObj id,int newValue);

int getTextFormatPreset(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

newValue: value of text format (-1...17)

 

Value

Format (Example)

 

-1

Use setTextFormatPattern

 

1=

# (Example: 123 = 123)

 

2=

#% (Example: 123 = 12,300%)

 

3=

#.#% (Example: 123 = 12,300.0%)

 

4=

#.##% (Example: 123 = 12,300.00%)

 

5=

$#.## (Example: 123 = $123.00)

 

6=

$# (Example: 123 = $123)

 

7=

#K (Example: 1,234 = 1K)

 

8=

$#K (Example: 1,234 = $1K)

 

9=

#M (Example: 1,234,567 = 1M)

 

10=

$#M (Example: 1,234,567 = $1M)

 

11=

#B (Example: 1,234,567,891 = 1B)

 

12=

$#B (Example: 1,234,567,891 = $1B)

 

13=

#T (Example: 1,234,567,891,234 = 1T)

 

14=

$#T (Example: 1,234,567,891,234 = $1T)

 

15=

show number with thousand separators no decimals (Example: 1,234=1K)

 

16=

show number with thousand separators two decimals (Example: 1,234=1.23K)

 

17=

General currency format for current Locale

Return:

None

Also See:

getTextFormatPreset(), getTextFormatPattern(), setTextFormatPattern(), DataTextFormat, PieFeelerTextFormat, PieRingTotalFormat, X1LabelFormat, Y1LabelFormat, Y2LabelFormat

setTextJustHoriz()

This method selects the horizontal alignment of a text object within its bounding box.

Syntax:

void setTextJustHoriz(int newValue);

void setTextJustHoriz(tdg.draw.IdentObj id, int newValue);

void setTextJustHoriz(int objectID, int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getFootote())

objectID: Object Number

newValue: Text Justification (0...2)

 

0=

Left

 

1=

Center

 

2=

Right

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setUseSampleData(false);
perspective1.setData(0,0,20);
perspective1.setData(0,1,36);
perspective1.setData(1,0,33);
perspective1.setData(1,1,39);
perspective1.setDataRangeToExtent(); perspective1.setTextJustHoriz(perspective1.getTitle(),0);
perspective1.setTextJustHoriz(
    perspective1.getSubtitle(),1);
perspective1.setTextJustHoriz(
    perspective1.getFootnote(),2);

Also See:

getTextJustHoriz(), getTextJustVert(), setTextJustVert()

setTextJustVert()

This method selects the vertical alignment of a text object within its bounding box.

Syntax:

void setTextJustVert(int newValue);

void setTextJustVert(tdg.draw.IdentObj id,int newValue);

void setTextJustVert(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

newValue Vertical Justification (0...2)

 

0=

Top

 

1=

Center

 

2=

Bottom

Return:

None

Also See:

getTextJustVert(), getTextJustHoriz(), setTextJustHoriz()

setTextRotation()

This method selects the rotation angle of a text object.

Syntax:

void setTextRotation(int newValue);

void setTextRotation(tdg.draw.IdentObj id,int newValue);

void setTextRotation(int objectID,int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getY1Label())

objectID: Object Number

newValue: Text Rotation (0...2)

 

0=

None

 

1=

90 Degrees

 

2=

270 Degrees

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setUseSampleData(false);
perspective1.setData(0,0,20);
perspective1.setData(0,1,36);
perspective1.setData(1,0,33);
perspective1.setData(1,1,39);
perspective1.setDataRangeToExtent();
perspective1.setTextJustHoriz(perspective1.getTitle(),0);
perspective1.setTextJustHoriz(
    perspective1.getSubtitle(),1);
perspective1.setTextJustHoriz(
    perspective1.getFootnote(),2);
perspective1.setTextRotation(perspective1.getY1Label(),1);

Also See:

getTextRotation(), O1LabelRotate, O2LabelRotate, X1LabelRotate, Y1LabelRotate, Y2LabelRotate

setTextString()

This method sets the text string assigned to a text object.

Syntax:

void setTextString(java.lang.String newValue);

void setTextString(tdg.draw.IdentObj id,String newValue);

void setTextString(int objectID,
java.lang.String newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getTitle())

objectID: Object Number

newValue: string assigned to a text object

Return:

None

Example:

perspective1.setDepthRadius(0);
perspective1.setUseSampleData(false);
perspective1.setData(0,0,20);
perspective1.setData(0,1,36);
perspective1.setData(1,0,33);
perspective1.setData(1,1,39);
perspective1.setDataRangeToExtent();
perspective1.setTextString(getFootnote(),
    "THE CHART FOOTNOTE");

Also See:

getTextString(), FootnoteString, O1TitleString, O2TitleString, SubtitleString, TitleString, X1TitleString, Y1TitleString, Y2TitleString

setTextureDisplayMode()

This method sets the texture display mode.

Syntax:

public void setTextureDisplayMode(int newValue);

public void setTextureDisplayMode(tdg.draw.IdentObj id,
    int newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

objectID: Object Number

newValue: Texture display mode (0/1)

 

0=

Stretched

 

1=

Tiles

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(3),3);
perspective1.setFillType(perspective1.getSeries(0),3);
perspective1.setFillType(perspective1.getSeries(2),3);
perspective1.setFillType(perspective1.getSeries(4),3);
perspective1.setFillType(perspective1.getSeries(1),3);
perspective1.setGraphType(32);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(3),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(0),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(2),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(4),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(1),0);
perspective1.setTextureURL(perspective1.getSeries(3),
    "file:/C:/PJE/tiles/Soft_Blue_Marble.gif");
perspective1.setTextureURL(perspective1.getSeries(0),
    "file:/C:/PJE/tiles/Soft_Blue_Marble.gif");
perspective1.setTextureURL(perspective1.getSeries(2),
    "file:/C:/PJE/tiles/Oil.gif");
perspective1.setTextureURL(perspective1.getSeries(4),
    "file:/C:/PJE/tiles/Yellow.gif");
perspective1.setTextureURL(perspective1.getSeries(1),
    "file:/C:/PJE/tiles/Azul_Granite.gif");

 

Also See:

setFillType(), setTextureURL()

setTextureURL()

This method can be used to load a texture image from a URL/file and assign it to object(s) in the chart. Note that the setFillType() method be used to select a texture fill type.

Syntax:

void setTextureURL(java.lang.String szURL)

void setTextureURL(tdg.draw.IdentObj id, java.lang.String szURL)

void setTextureURL(java.lang.String szURL, java.awt.Image theImage)

void setTextureURL(tdg.draw.IdentObj id, java.lang.String szURL, java.awt.Image theImage)

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

theImage:A URL/File Name where the texture resides

szURL: Size of the URL

Return:

None

Example:

perspective1.setFillType(perspective1.getSeries(3),3);
perspective1.setFillType(perspective1.getSeries(0),3);
perspective1.setFillType(perspective1.getSeries(2),3);
perspective1.setFillType(perspective1.getSeries(4),3);
perspective1.setFillType(perspective1.getSeries(1),3);
perspective1.setGraphType(32);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(3),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(0),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(2),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(4),0);
perspective1.setTextureDisplayMode(
    perspective1.getSeries(1),0);
perspective1.setTextureURL(perspective1.getSeries(3),
    "file:/C:/PJE/tiles/Soft_Blue_Marble.gif");
perspective1.setTextureURL(perspective1.getSeries(0),
    "file:/C:/PJE/tiles/Soft_Blue_Marble.gif");
perspective1.setTextureURL(perspective1.getSeries(2),
    "file:/C:/PJE/tiles/Oil.gif");
perspective1.setTextureURL(perspective1.getSeries(4),
    "file:/C:/PJE/tiles/Yellow.gif");
perspective1.setTextureURL(perspective1.getSeries(1),
    "file:/C:/PJE/tiles/Azul_Granite.gif");

Also See:

getFillType(), setFillType(), getTextureDisplayMode(), setTextureDisplayMode()

setTextWrap()

This method enables/disables line wrapping for a text object. When text wrapping is enabled, the charting engine will look for space characters in the text string and draw the text on multiple lines at space character boundaries. When text wrapping is disabled, the text string will always be drawn on a single line

Syntax:

void setTextWrap(boolean newValue);

void setTextWrap(tdg.draw.IdentObj id,boolean newValue);

void setTextWrap(int objectID,boolean newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getO1Label())

objectID: Object Number

boolean: true/false

 

true=

text wrapping is enabled

 

false=

text wrapping disabled

Return:

None

Example:

perspective1.setAutofit(perspective1.getSubtitle(),false);
perspective1.setFontSizeVC(
    perspective1.getSubtitle(),1855);
perspective1.setRect(perspective1.getSubtitle(),
    new Rectangle(-13278,10471,25806,3710));
perspective1.setTextString(perspective1.getSubtitle(),
    "This is a very long Chart SubTitle that
    should be wrapped");
    perspective1.setTextWrap(
perspective1.getSubtitle(), true);
perspective1.setDepthRadius(0);

 

Notes:

If a "\n" is encountered in the label string, the string will be wrapped even if this method is disabled (setTextWrap(getO2Label(), false);).

Also See:

getTextWrap(), O1LabelWrap, O2LabelWrap

setToolTipCallBack()

This method can be used to register a "tooltip callback" object. This object will be called by the Perspective tool tip code. In order to use this feature, you must implement the ToolTipCallBack interface (see ToolTipCallBack.Java).

Syntax:

void setToolTipCallBack(
    ToolTipCallBack toolTipObject
);

Input:

toolTipObject: a tooltip callback object

Return:

None

Also See:

getToolTipCallBack(), isToolTipCallBack(), setDeveloperToolTip(), setDynamicToolTip(),setToolTipOff(), setToolTipOn(), setUserToolTip(), setUserToolTipDefault(), ToolTipDelay, ToolTipDisplay, ToolTipMode

setToolTipOff()

This method turns off the generation of events for tool tips until a triggering event such as dwelling over some other object generates a new tooltip event.

Syntax:

void setToolTipOff();

Input:

None

Return:

None

Also See:

setDynamicToolTip()

setToolTipOn()

This method turns on the generation of events for tool tips.

Syntax:

void setToolTipOn();

Input:

None

Return:

None

Also See:

setToolTipOff()

setTransparentBorderColor()

This method applies a transparent border color to an object.

Syntax:

void setTransparentBorderColor(boolean newValue);

void setTransparentBorderColor(tdg.draw.IdentObj id,
    boolean newValue);

Input:

id: IdentObj returned by a getObject() method

newValue: TRUE = apply transparent border color

Return:

None

Also See:

getTransparentBorderColor(), getBorderColor(), setBorderColor(), getSelectionBorderColor(), isSelectionBorderColorTransparent(), setSeriesBorderColor()

setTransparentFillColor()

This method applies a transparent fill color to an object.

Syntax:

void setTransparentFillColor(boolean newValue);

void setTransparentFillColor(tdg.draw.IdentObj id,
    boolean newValue);

Input:

id: IdentObj returned by a getObject() method

newValue: true/false

 

true=

apply transparent fill color to object

 

false=

do not apply to object

Return:

None

Also See:

getTransparentFillColor(), getFillColor(), setFillColor(), getSelectionFillColor(), isSelectionFillColorTransparent(), setSeriesFillColor()

setURL()

This method sets the Universal Resource Locator for any specific Object. This method and the getURL(), getURLTarget, and setURLTarget() methods can be used to include drill-downs in HTML files. They allow any series/group intersection in the chart to be used as a link reference. When the user selects/clicks on an object in a chart where a setURL() is defined, the HTML file provided as an input parameter to the method will automatically be loaded and displayed at the location specified by the setURLTarget().

Syntax:

void setURL (java.lang.String newValue);

void setURL(tdg.draw.IdentObj id, java.lang.String newValue);

void setURL(int seriesID, java.lang.String newValue);

void setURL(int seriesID, int groupID, java.lang.String newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: Series ID

groupID: Group ID

newValue: URL string

Also See:

getURL(), getURLTarget(), setURLTarget(), setDataFileURL()

setURLTarget()

This method gets the frame target for the URL associated with any specific object. It is used in conjunction with getURL() and setURL() to create drill-downs in an HTML file.

Syntax:

void setURLTarget(java.lang.String newValue);

void setURLTarget(tdg.draw.IdentObj id, java.lang.String newValue);

void setURLTarget(int seriesID, java.lang.String newValue);

void setURLTarget(int seriesID,int groupID,
    java.lang.String newValue);

Input:

id: IdentObj returned by a getObject() method (e.g., getSeries())

seriesID: Series ID

groupID: Group ID

newValue: URL Target string

Also See:

getURLTarget(), getURL(), setURL(), setDataFileURL()

setUserToolTip()

When the ToolTipDisplay property is enabled (true) and the ToolTipMode property selects user information mode (0), the setUserToolTip() method can be used to define a custom tool tip string that will be displayed when the user positions the mouse pointer over a selectable object in a chart.

Syntax:

void setUserToolTip (
    java.langString CustomToolTip
);

Input:

CustomToolTip = Any string of characters which may or may not include the following macros:

[ON] = Object Name

[OID] = Object ID

[R] = New Line

[OIN] = Object Instance

[OD] = Object Description

[SL] = Series Label

[GL] = Group Label

Example: [ON] is ([OID]) [R] Instance # [OIN]

Return:

None

Example:

See ToolTipDemoOne in a Appendix G

Return:

ToolTipDisplay, ToolTipMode, setDeveloperToolTip()

setUserToolTipDefault()

The setUserToolTipDefault() method selects the default developer tool tip strings that are provided with the application. When ToolTipMode selects developer information, the default tool tip string consists of the following: series number, group number, and value.

Example:

Series: 3
Group: 4
Value: 60.0

Syntax:

void setUserToolTipDefault ( );

Input:

None

Return:

None

Example:

perspective1.setGraphType(32);
perspective1.setToolTipDisplay(true);
perspective1.setUserToolTipDefault();
perspective1.setDataRange(0,0,2,2);

Also See:

ToolTipDisplay, ToolTipMode, setDeveloperToolTip()

setZoomIndex()

This function sets the value of the current zoom state.

 

When data zooming is enabled with the zoom properties/methods or via the user interface (setSelectionEnable(5)), Perspective will maintain a Zoom Index that keeps track of the number of times a chart has been zoomed in and the state of zooming. As an example, assume ZoomPercentage is set to 10%, and the user clicks ONCE. The chart is now zoomed to 90% of its original values, and the Zoom Index is now 1. Now the user clicks A SECOND TIME. The chart is now zoomed to 80% of its orignal values, and the zoom index now is 2. Or, actually, the zoom index now has TWO entries: one for the first, 90% state, and a second for the second, 80% state.

 

You can keep adding to the zoom index as the user contines to click. Continuing with the example and the same values, assume the user has clicked eight consecutive times. The Zoom index now contains eight items:

 

1.

First Level: Zoom Factor 90%

 

2.

Second Level: Zoom Factor 80%

 

3.

Third Level: Zoom Factor 70%

 

4.

Fourth Level: Zoom Factor 60%

 

5.

Fifth Level: Zoom Factor 50%

 

6.

Sixth Level: Zoom Factor 40%

 

7.

Seventh Level: Zoom Factor 30%

 

8.

Eighth Level: Zoom Factor 20%

 

Your application can go back and forth in this list. For example, assume you want to switch from the "current" level (the last level the user clicked, the eighth zoom level which currently shows 20% of the original unzooomed state). You could use setZoomIndex(4) to IMMEDIATELY switch to the FOURTH level which had a zoom factor of 60%. You can use setZoomIndex to switch back and forth between any zoom level set.

Syntax:

void setZoomIndex(int index );

Input:

index: the new zoom index value

Return:

None

Also See:

doZoomIn(), doZoomOut(), clearZoomList(), getZoomIndex(), isValidZoomIndex(), "Data Zooming" in Chapter 6.