Miscellaneous Properties

AxisTextAutofitMax

When axis text is automatically fitted (e.g., O1LabelAutofit or Y1LabelAutofit is true) and AxisTextAutofitMode is set to zero, this property defines the maximum size of autofitted axis text in virtual coordinates.

DATA TYPE:

integer

RANGE:

Any integer value. It should be greater than AxisTextAutofitMin.

DEFAULT:

2000

SYNTAX:

void setAxisTextAutofitMax(int newValue);
int getAxisTextAutofitMax();

EXAMPLE:

setViewableSeries (3);
setAxisTextAutofitMin (200);
setAxisTextAutofitMax (2500);
setY1LabelAutofit (true);
setDataScrollerPresenceGroups(0);
setViewableGroups(3);
setDepthRadius(0);

setAxisTextAutofitMax (25000);

ALSO SEE:

AxisTextAutofitMin, AxisTextAutofitMode

AxisTextAutofitMin

When axis text is automatically fitted (e.g., O1LabelAutofit or Y1LabelAutofit is true) and AxisTextAutofitMode is set to zero, this property defines the minimum size of autofitted axis text in virtual coordinates.

DATA TYPE:

integer

RANGE:

Any integer value. It should be less than AxisTextAutofitMax.

DEFAULT:

500

SYNTAX:

void setAxisTextAutofitMin(int newValue);
int getAxisTextAutofitMin();

ALSO SEE:

AxisTextAutofitMax, AxisTextAutofitMode

AxisTextAutofitMode

This property selects the mode in which AxisTextAutofitMin, AxisTextAutofitMax, and AxisTextAutofitPercent properties are used.

DATA TYPE:

integer

RANGE:

0...2; 0 = Normal autofit behavior, within limits of AxisTextAutofitMin and AxisTextAutofitMax, 1 = All axis text matches the Axis with the smallest font size as determined by autofit, 2 = All axis text is maintained within "X percent" of the Axis with the smallest font size as determined by autofit

DEFAULT:

0 (Normal autofit behavior)

SYNTAX:

void setAxisTextAutofitMode(int newValue);
int getAxisTextAutofitMode();

EXAMPLE:

setY1LabelAutofit(true);
setViewableGroups(3);
setDepthRadius(0);
setAxisTextAutofitMode(0);

ALSO SEE:

AxisTextAutofitMin, AxisTextAutofitMax, AxisTextAutofitPercent

AxisTextAutofitPercent

When AxisTextAutofitMode(2) is used, this property selects the percent at which Axis text is maintained within the smallest font size as determined by Autofit. The default value of ten percent is almost identical to AxisTextAutofitMode(1).

DATA TYPE:

integer

RANGE:

0...100%

DEFAULT:

10%

SYNTAX:

void setAxisTextAutofitPercent(int newValue);
int getAxisTextAutofitPercent();

EXAMPLE:

setViewableSeries(3);
setAxisTextAutofitMin(200);
setAxisTextAutofitMax(25000);
setY1LabelAutofit(true);
setDataScrollerPresenceGroups(0);
setAxisTextAutofitPercent(25);
setAxisTextAutofitMode(2);
setViewableGroups(3);
setDepthRadius(0);

setAxisTextAutofitPercent(75);

ALSO SEE:

AxisTextAutofitMin, AxisTextAutofitMax, AxisTextAutofitMode

BiDirectional

This property reverses the text alignment of all objects and the location of legend text next to label markers. This property is provided for international support ONLY! It can be used to make the entire chart read from right-to-left or left-to-right. However, note that BiDirectional(true) does not reverse the values of the associated properties and methods. They retain their original values. For example, getTextJustHoriz() would return zero (left) even though visually the text is aligned right by BiDirectional(true).

DATA TYPE:

boolean

RANGE:

true = Enable Right-to-Left Alignment, false = Select normal Left-to-Right Alignment

DEFAULT:

false

SYNTAX:

void setBiDirectional(boolean newValue);
boolean getBiDirectional();

EXAMPLE:

setDepthRadius(0);
setBiDirectional(true);

setBiDirectional(false);

NOTE:

Use this property with great care! Your application must keep track of the BiDirectional setting and handle the reverse values supplied by associated properties and methods.

Cascade

This property is not intended for use in a normal charting environment. It is strictly designed for a programmer to determine how setting a method or property may affect other properties and methods. When enabled (the default), the normal relationship between properties and methods is observed. When disabled, setting chart characteristics with a method or property will not affect settings by other properties and methods. By default, some properties and methods actually call other properties/methods. When Cascade is set to false, properties/methods will never call other properties/methods. 

DATA TYPE:

boolean

RANGE:

true = Enable cascade mode, false = Disable cascade mode

DEFAULT:

true

SYNTAX:

void setCascade(boolean newValue);
boolean getCascade();

EXAMPLE:

With Cascade(true), setBorderColor() will change the border color of series 3 and override the transparent setting.

setDepthAngle(0);
setDepthRadius(0);
setCascade(true);
setTransparentBorderColor(getSeries(3),true);
setBorderColor(getSeries(3),new 
Color (255,0,0));

With Cascade(false), setBorderColor() will not change the border color of series 3 because the border has been set to transparent.

setDepthAngle(0);
setDepthRadius(0);
setCascade(false);
setTransparentBorderColor(getSeries(3),true);
setBorderColor(getSeries(3),new Color (255,0,0));

CircularChartStartAngle

This property gets/sets the start angle to draw any circular chart (polar, radar, pie).

DATA TYPE:

integer

RANGE:

0...359

DEFAULT:

0

SYNTAX:

void setCircularChartStartAngle(int newValue);
int getCircularChartStartAngle();

EXAMPLE:

setGraphType(65);
setCircularChartStartAngle(359);

CurveFitEquationDisplay

The value assigned to this property determines whether the equation associated with a curve fit line is shown. The curve fit line is drawn by the setCurveFitType() method.

DATA TYPE:

boolean

RANGE:

true = Show equation with the curve fit line, false = Do not show equation

DEFAULT:

true

SYNTAX:

void setCurveFitEquationDisplay(boolean newValue);
boolean getCurveFitEquationDisplay();

ALSO SEE:

CurveFitHighOrderFirst, setCurveFitType()

CurveFitHighOrderFirst

When a curve fit equation is displayed with CurveFitEquationDisplay, this property determines the order of terms for equation text (TRUE: ax + b; FALSE: b + ax)

DATA TYPE:

boolean

RANGE:

true/false; true = ax + b, false = b + ax

DEFAULT:

true

SYNTAX:

void setCurveFitHighOrderFirst(boolean newValue);
boolean getCurveFitHighOrderFirst();

EXAMPLE:

setCurveFitType(1,1);
setCurveFitHighOrderFirst(true);

setCurveFitHighOrderFirst(false);

ALSO SEE:

CurveFitEquationDisplay

CurveFitNumSegments

This property determines the number of interpolated points to calculate to draw a curve fit line. The curve fit line is enabled/disabled with the setCurveFitType() method.

DATA TYPE:

integer

RANGE:

Any integer. Larger values will draw a smoother line.

DEFAULT:

50

SYNTAX:

void setCurveFitNumSegments(int newValue);
int getCurveFitNumSegments();

ALSO SEE:

setCurveFitType()

DefaultFontName

This property defines a default font that will be applied to all text objects in a chart. You can apply different fonts to individual text objects using the setFontName() method.

DATA TYPE:

String

RANGE:

Any font name string.

DEFAULT:

Sans Serif

SYNTAX:

void setDefaultFontName(String newValue);
String getDefaultFontName();

Example::

setDefaultFontName("Comic Sans MS");
setGraphType(41);

DocumentHeightInTwips

This property defines the document height in TWIPs (1/20th point or 1/100th millimeter). The document size set by this property and DocumentWidthInTwips is used is used as a reference to calculate the size of text using absolute font sizes. If no document size is specified, the size of the chart in pixels and the screen resolution are used for conversion (from pixels to points). If no document size is specified (no screen resolution available), the convertion from pixels to points is simpy 1 to 1.

DATA TYPE:

integer

RANGE:

0...10000

DEFAULT:

0(use the size in pixels at the given resolution)

SYNTAX:

void setDocumentHeightInTwips(int newValue);
int getDocumentHeightInTwips();

NOTE:

If DocumentHeightInTwips is non-zero, Perspective will also put the size in pixels in the SVG viewport.

ALSO SEE:

DocumentWidthInTwips, getDocumentHeightInPoints(), getDocumentWidthInPoints(), setFontSizeAbsolute(), setFontSizeInPoints()

DocumentWidthInTwips

This property defines the document width in TWIPs (1/20th point or 1/100th millimeter). The document size set by this property and DocumentHeightInTwips is used is used as a reference to calculate the size of text using absolute font sizes. If no document size is specified, the size of the chart in pixels and the screen resolution are used for conversion (from pixels to points). If no document size is specified (no screen resolution available), the convertion from pixels to points is simpy 1 to 1.

DATA TYPE:

integer

RANGE:

0...10000

DEFAULT:

0(use the size in pixels at the given resolution)

SYNTAX:

void setDocumentWidthInTwips(int newValue);
int getDocumentWidthInTwips();

NOTE:

If DocumentWidthInTwips is non-zero, Perspective will also put the size in pixels in the SVG viewport.

ALSO SEE:

DocumentHeightInTwips, getDocumentHeightInPoints(), getDocumentWidthInPoints(), setFontSizeAbsolute(), setFontSizeInPoints()

HiliteBarResize

This property enables/disables showing a riser's bar value when a bar is resized in a clustered bar chart. When enabled (true), the chart will show the bar value when a bar is resized using the option key. When disabled (false), the bar value is not shown.

DATA TYPE:

boolean

RANGE:

true/false; true = Show riser's bar value, false = Do not show riser's bar value

DEFAULT:

true

SYNTAX:

void setHiliteBarResize(boolean newValue);
boolean setHiliteBarResize();

ManualRedraw

This property controls manual redrawing of the chart when chart properties are changed. When this property is enabled and other chart properties and attributes are changed, the appearance of the chart is not changed. When this property is false, the chart is redrawn with the new attribute when any chart property is changed.

DATA TYPE:

boolean

RANGE:

true / false; true = Do not automatically redraw the chart when attributes are changed, false = Automatically redraw the chart when attributes are changed

DEFAULT:

false

SYNTAX:

void setManualRedraw(boolean newValue);
boolean getManualRedraw();

MoveAxisTitles

This property allows/disallows axis titles to be dragged with the mouse. A axis title string must be defined (e.g., setO1TitleString("O1-Axis Title");).

DATA TYPE:

boolean

RANGE:

true/false; true = allow axis titles to be moved, false = titles cannot be moved.

DEFAULT:

false

SYNTAX:

void setMoveAxisTitles(boolean newValue);
boolean getMoveAxisTitles();

NestedLabels

This property enables/disables the the nested labels callback interface. If this property is enabled, you must create your own version of the callback which must implement ALL of the abstract methods defined in TDGNestedLabel.Java:

int getNumLevels();
// Get # of levels of nested labels.
int getNumLabelsOnLevel(int nLevel);
//Get # of labels at nLevel.
Vector getAllLabels(int nLevel);
Get all labels at nLevel.
String getLabel(int nGroup, int nLevel);
// Get string at nGroup/nLevel
int getLabelGrouping(int nGroup, int nLevel);
// Get # of labels grouped at nLevel.

In addition to creating these methods, you must use the getO1LabelCallback() method to define the callback.

DATA TYPE:

boolean

RANGE:

true/false; true = enable nested labels, false = disable nested labels

DEFAULT:

false

SYNTAX:

void setNestedLabels(boolean newValue);
boolean getNestedLabels();

NOTE:

Use getO1LabelCallback() to determine if a callback has been assigned with setO1LabelCallback.

ALSO SEE:

get/setO1LabelCallback()

OutputSVG

This property enables (true) / disables (false) output in Scalable Vector Graphics (SVG) format by the sendSVGToStream() method.

DATA TYPE:

boolean

RANGE:

true / false; true = Allow output in SVG format, false = Do not allow output in SVG format

DEFAULT:

true

SYNTAX:

void setOutputSVG(boolean newValue);
boolean getOutputSVG();

ALSO SEE:

DocumentHeightInTwips, DocumentWidthInTwips, sendSVGToStream()

PrimitiveAntialiasing

This property enables/disables smoother drawing of chart objects using Java 2D. Your development environment must include JRE 1.2 (or later) in order to use this property.

DATA TYPE:

boolean

RANGE:

true (enable) / false (disable)

DEFAULT:

false

SYNTAX:

void setPrimitiveAntialiasing(boolean newValue);
boolean getPrimitiveAntialiasing();

ALSO SEE:

TextAntialiasing to improve the quality of text objects

ReshapeEnable

This property enables (true) / disables (false) the user's ability to move and resize title, subtitle, footnote, chart frame, and legend box objects in a chart.

DATA TYPE:

boolean

RANGE:

true / false; true = User can move/resize objects, false = Objects cannot be moved/resized by the user interface

DEFAULT:

true

SYNTAX:

void setReshapeEnable(boolean newValue);
boolean getReshapeEnable();

ALSO SEE:

ResizeBarMode, SelectionEnable, SelectionEnableMove

ResizeBarMode

This property enables/disables resize bar mode. When it is enabled, the user interface will allow resizing of bars. The user can change the size of bars by using the control key and the mouse to stretch or reduce their size. This action will also change the internal data value assigned to the bar. The getDataValue() method can be used to get the new data value. If data callbacks are being used to provide data input to the chart (see Chapter 6), any resize operation will be reset to the value provided by the data call back. When this property is disabled, the user cannot resize bars. This property is only applicable to 2D and 2.5D bar charts, it is not supported for 3D risers.

DATA TYPE:

boolean

RANGE:

true / false; true = User interface can resize bars, false = Do not allow resizing of bars

DEFAULT:

true

SYNTAX:

void setResizeBarMode(boolean newValue);
boolean getResizeBarMode();

NOTE:

DepthRadius must be set to zero in order for this property to enable the user interface to resize bars.

ALSO SEE:

ReshapeEnable, SelectionEnable, SelectionEnableMove, DepthRadius

ReverseGroups

This property enables (true) / disables (false) drawing of groups in reverse order.

DATA TYPE:

boolean

RANGE:

true / false; true = Draw groups in reverse order, false = Draw groups in normal order

DEFAULT:

false

SYNTAX:

setReverseGroups(boolean newValue);
boolean getReverseGroups();

ALSO SEE:

ReverseSeries

ReverseSeries

This property enables (true) / disables (false) drawing of series in reverse order.

DATA TYPE:

boolean

RANGE:

true / false; true = Draw series in reverse order, false = Draw series in normal order

DEFAULT:

false

SYNTAX:

void setReverseSeries(boolean newValue);
boolean getReverseSeries();

ALSO SEE:

ReverseGroups

SelectionEnable

This property defines the user's ability to select objects in a chart and the operations that can be performed when one or more objects are selected.

DATA TYPE:

integer

RANGE:

0...5;

DEFAULT:

3

SYNTAX:

void setSelectionEnable(int newValue);
int getSelectionEnable();

ALSO SEE:

SelectionEnableMove

SelectionEnableMove

This property enables (true) / disables (false) a chart user's ability to select and move individual moveable objects (title, subtitle, footnote, chart frame, and legend box) in a chart.

DATA TYPE:

boolean

RANGE:

true / false; true = User can select and move objects, false = Objects can be selected but not moved

DEFAULT:

true

SYNTAX:

void setSelectionEnableMove(boolean newValue);
boolean getSelectionEnableMove();

ALSO SEE:

SelectionEnable

ShadowXOffsetDefault

This property sets the default value for the X-Offset of a drop shadow.

DATA TYPE:

integer

RANGE:

-20...20

DEFAULT:

2

SYNTAX:

void setShadowXOffsetDefault(int newValue);
int getShadowXOffsetDefault();

ALSO SEE:

get/setShadowXOffset(), get/setShadowYOffset(), setShadowColor(), setShadowDisplay()

ShadowYOffsetDefault

This property sets the default value for the Y-Offset of a drop shadow.

DATA TYPE:

integer

RANGE:

-20...20

DEFAULT:

2

SYNTAX:

void setShadowYOffsetDefault(int newValue);
int getShadowYOffsetDefault();

ALSO SEE:

get/setShadowXOffset(), get/setShadowYOffset(), setShadowColor(), setShadowDisplay()

SizeToContainer

This property controls chart resizing.

DATA TYPE:

boolean

RANGE:

true / false; true = set chart size to size of container, false = do not set chart size to size of container

DEFAULT:

true

SYNTAX:

void setSizeToContainer(boolean newValue);
boolean getSizeToContainer();

SmoothLines

This property enables (true) / disables (false) drawing of smooth lines in line charts.

DATA TYPE:

boolean

RANGE:

true / false; true = draw smooth lines, false = draw lines normally

DEFAULT:

false

SYNTAX:

void setSmoothLines(boolean newValue);
boolean get SmoothLines();

TextAntialiasing

This property controls smoother drawing of chart text objects using Java 2D. Your development environment must include JRE 1.2 (or later).

DATA TYPE:

boolean

RANGE:

true / false; true = Enable text antialiasing, false = Disable text antialiasing

DEFAULT:

false

SYNTAX:

void setTextAntialiasing(boolean newValue);
boolean getTextAntialiasing();

ALSO SEE:

PrimitiveAntialiasing

TextAutofitMax

This property sets the maximum font size in virtual coordinates that automatic fitting will use to fit/size chart labels and legend text. It does not affect the chart title, subtitle, and footnote.

DATA TYPE:

integer

RANGE:

Any integer value

DEFAULT:

1600

SYNTAX:

void setTextAutofitMax(int newValue);
int setTextAutofitMax();

TextAutofitMin

This property sets the minimum font size in virtual coordinates that automatic fitting will use to size chart labels and legend text. It does not affect the chart title, subtitle, and footnote.

DATA TYPE:

integer

RANGE:

Any integer value

DEFAULT:

50

SYNTAX:

void setTextAutofitMin(int newValue);
int setTextAutofitMin();

UseOffScreen

This property controls whether the chart will be drawn directly to the graphics device (true) or using an off-screen image buffer (false). Set this property to false when the drawing speed of the chart seems very slow. When this property is false, it can increase the drawing speed by a factor of three in some situations.

DATA TYPE:

boolean

RANGE:

true / false; true = Draw directly to graphics device, false = Use off screen image buffer

DEFAULT:

true

SYNTAX:

void setUseOffScreen(boolean newValue);
boolean getUseOffScreen();