Axis Labels

get/setAutoSkip()

These method get/set the label skipping mode for primary ordinal (O1) axis labels. If setAutoSkip() selects manual label skip (2), use setSkipBegin() to define the first label to skip and setSkipCount() to define the skip interval. If setAutoSkip() 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:

int getAutoSkip();
int getAutoSkip (IdentObj id);
void setAutoSkip (int newValue);
void setAutoSkip (IdentObj id, int newValue);

INPUT:

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

newValue; 0 = No label skipping, 1 = Automatic label skip, 2 = Manual skip

RETURN:

int: 0 = No label skipping, 1 = Automatic label skip, 2 = Manual skip

EXAMPLE:

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

NOTES:

ALSO SEE:

O1LabelAutoSkip

get/setExcludeMaxLabel()

These methods get/set a boolean that indicates whether or not the maximum label is excluded from an axis.

SYNTAX:

boolean getExcludeMaxLabel();
boolean getExcludeMaxLabel (IdentObj id);
void setExcludeMaxLabel (boolean newValue);
void setExcludeMaxLabel (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Exclude maximum label, false = Include maximum label

RETURN:

boolean; true = Maximum label is excluded, false = Maximum label is included

EXAMPLE:

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

NOTES:

ALSO SEE:

get/setExcludeMinLabel(), O1/O2ExcludeMaxLabel, X1/Y1/Y2ExcludeMaxLabel.

get/setExcludeMinLabel()

These methods get/set a boolean that indicates whether or not the minimum label is excluded from an axis.

SYNTAX:

boolean getExcludeMinLabel();
boolean getExcludeMinLabel (IdentObj id);
void setExcludeMinLabel (boolean newValue);
void setExcludeMinLabel (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Exclude minimum label, false = Include minimum label

RETURN:

boolean; true = Minimum label is excluded, false = Minimum label is included

EXAMPLE:

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

NOTES:

ALSO SEE:

get/setExcludeMaxLabel, O1/O2ExcludeMinLabel, X1/Y1/Y2ExcludeMinLabel.

get/setLabelStagger()

These methods get/set staggered labels on an axis.

SYNTAX:

boolean getLabelStagger();
boolean getLabelStagger (IdentObj id);
void setLabelStagger (boolean newValue);
void setLabelStagger (IdentObj id, boolean newValue);

INPUT:

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

newValue; true = Stagger Labels, false = Draw Labels normally

RETURN:

boolean; true = Labels are staggered, false = Labels are not staggered

EXAMPLE:

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

NOTES:

ALSO SEE:

O1LabelStagger, X1/Y1/Y2LabelStagger

get/setSkipBegin()

When setAutoSkip() selects manual skip mode, these methods get/set the first label to be skipped.

SYNTAX:

int getSkipBegin();
int getSkipBegin (IdentObj id);
void setSkipBegin (int newValue);
void setSkipBegin (IdentObj id, int newValue);

INPUT:

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

newValue; 0...Number of groups in chart

RETURN:

int; First label to skip when manual skip mode is enabled

EXAMPLE:

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

NOTES:

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

ALSO SEE:

get/setSkipCount(), O1LabelAutoSkip

get/setSkipCount()

When setAutoSkip() selects manual skip mode, these methods get/set the interval of labels to skip after setSkipBegin().

SYNTAX:

int getSkipCount();
int getSkipCount (IdentObj id);
void setSkipCount (int newValue);
void setSkipCount (IdentObj id, int newValue);

INPUT:

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

newValue; 0...Number of groups in chart

RETURN:

int; Label skip interval

EXAMPLE:

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

NOTES:

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

ALSO SEE:

get/setSkipBegin(), get/setAutoSkip()

get/setTextFormatPattern()

These methods get/set a standard Java number format pattern for numeric data text or a numeric label object.

SYNTAX:

String getTextFormatPattern();
string getTextFormatPattern (IdentObj id);
void setTextFormatPattern (String newValue);
void setTextFormatPattern (IdentObj id, String newValue);

INPUT:

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

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'* '#'*

Where:

X*

0 or more instances of X

(X|Y) 

either X or Y.

X..Y

any character from X up to Y, inclusive.

S - T

characters in S, except those in T

The first subpattern is for positive numbers. The second (optional) subpattern is for negative numbers. In both cases, a comma (, ) can occur inside the integer portion. The special characters used in the parts of the subpattern are:

0

a digit

#

a digit, zero shows as absent

.

a period (.) is a placeholder for decimal separator

,

a comma (, ) is a placeholder for grouping separator

;

a semicolon (;) separates formats

-

a minus sign/dash (-) is the default negative prefix

%

divide by 100 and show as percentage

x

any other characters can be used in the prefix or suffix

'

a single quote (') is used to quote special characters in a prefix or suffix

If there is no explicit negative subpattern, a minus sign (-) is prefixed to the positive form (i.e, "0.00" alone is equivalent to "0.00;-0.00"). Illegal formats, such as "#.#.#" or mixing '_' and '*' in the same format, will cause a ParseException. The ParseException string will show where the error occurred. The grouping separator is commonly used for thousands, but in some countries for ten-thousands. The interval is a constant number of digits between the grouping characters, such as 100, 000, 000 or 1, 0000, 0000. If you supply a pattern with multiple grouping characters, the interval between the last one and the end of the integer is the one that is used. So "#, ##, ###, ####" == "######, ####" == "##, ####, ####". This class only handles localized digits where the 10 digits are contiguous in Unicode, from 0 to 9.

RETURN:

String; a pattern string

NOTES:

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

ALSO SEE:

get/setTextFormatPreset()

get/setTextFormatPreset()

These methods get/set a preset number format for a numeric text object.

SYNTAX:

int getTextFormatPreset();
int getTextFormatPreset (IdentObj id);
void setTextFormatPreset (int newValue);
void setTextFormatPreset (IdentObj id, int newValue);

INPUT:

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

newValue; -1...21.

Value

Description

-1

Use the pattern defined by setTextFormatPattern()

0/1 =

# (e.g., 123 = 123)

2 =

#% (e.g., 123 = 12, 300%)

3 =

#.#% (e.g., 123 = 12, 300.0%)

4 =

#.##% (e.g., 123 = 12, 300.00%)

5 =

$#.## (e.g., 123 = $123.00)

6 =

$# (e.g., 123 = $123)

7 =

#K (Show K for values over 999) (e.g., 1, 234 = 1K)

8 =

$#K (Show K for values over 999) (e.g., 1, 234 = $1K)

9 =

#M (Show M for millions) (e.g., 1, 234, 567 = 1M)

10 =

$#M (Show M for millions) (e.g., 1, 234, 567 = $1M)

11 =

#B (Show B for billions) (e.g., 1, 234, 567, 891 = 1B)

12 =

$#B (Show B for billions) (e.g., 1, 234, 567, 891 = $1B)

13 =

#T (Show T for trillions) (e.g., 1, 234, 567, 891, 234 = 1T)

14 =

$#T (Show T for trillions) (e.g., 1, 234, 567, 891, 234 = $1T)

15 =

Number with thousands separators, no decimal places (e.g., 1, 234 = 1K)

16 =

Number with thousands separators, two decimal places (e.g., 1, 234 = 1.23K)

17 =

General currency format for current Locale

18 =

Short Date Format: MM/DD/YY (e.g., 10/01/03)

19 =

Medium Date Format: Mon. DD, YYYY (e.g., Oct. 01, 2003)

20 =

Long Date Format: Month DD, YYYY (e.g., October 01, 2003)

21 =

Full Date Format: Day, Month DD, YYYY (e.g., Wednesday, October 01, 2003)

RETURN:

int; -1...21

NOTES:

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

ALSO SEE:

get/setTextFormatPattern()