Time Scale Axis Methods

get/setLevelDateFormat(); Get/Set Level Date Format
get/setLevelFillColor(); Get/Set Level Fill Color
get/setLevelHeight(); Get/Set Level Height
get/setLevelInterval(); Get/Set Level Interval
get/setLevelTextFormat(); Get/Set Level Text Format
setLevelBorderColor(); Set Level Border Color
setLevelTextColor(); Set Level Text Color
setTimeScaleAxisDefaults(); Set Time Scale Axis Defaults

get/setLevelDateFormat()

When a Time Scale Axis is defined and setLevelTextFormat() assigns FORMAT_RAW (-1) to a level, these methods get/set a date format string to be used on a specified level.

SYNTAX:

String getLevelDateFormat (int level);
void setLevelDateFormat (int level, String format);
void setLevelDateFormat (IdentObj id, String format);

INPUT:

int; Level (0...2) from which to get the date format.

id; the object ID of a time scale axis level (i.e., getTimeScaleLevel (n);)

format; a string of standard Java SimpleDateFormat codes

G = Era Designation (e.g., AD)
y = Year (e.g., 2004, 04)
M = Month in year (e.g, March, Mar., 03)
w = Week in year (e.g., 1...52)
W = Week in month (e.g., 2)
D = Day in year (e.g., 1...365)
d = Day in month (e.g., 10)
F = Day of week in month (e.g., 2)
E = Day in week (e.g., Tuesday, Tue)
a = AM/PM Marker (e.g., PM)
H = Zero-Based Hour in day (e.g., 0...23)
k = Hour in day (e.g., 1...24)
K = Zero-Based Hour in AM/PM (e.g., 0...11)
h = Hour in AM/PM (e.g., 1...11)
m = Minute in hour (e.g., 30)
s = Second in minute (e.g., 55)
S = Millisecond (e.g., 978)
z = General Time Zone (e.g., Pacific 
Standard Time, PST, GMT-08:00
Z = RFC 822 Time Zone (e.g., -0800)

RETURN:

String; Date format string set by setLevelDateFormat()

NOTES:

A time scale axis can only be defined in clustered bar, stacked bar, line, and scatter charts.

ALSO SEE:

"Data in Time Scale Axis Charts"

get/setLevelFillColor()

When a Time Scale Axis is defined, these methods get/set the fill color of a level.

SYNTAX:

Color getLevelFillColor (IdentObj id)
Color getLevelFillColor (int level)
void setLevelFillColor (IdentObj id, Color color)
void setLevelFillColor (int level, Color color)

INPUT:

id; Object ID of the level from which to get the fill color (i.e., getTimeScaleLevel (n);)

level; Level (0...2) from which to get the fill color.

color; the fill color to be assigned to the specified level (e.g., new Color (255, 0, 0)).

RETURN:

Color; the color assigned to the specified object or level

NOTES:

A time scale axis can only be defined in clustered bar, stacked bar, line, and scatter charts.

ALSO SEE:

"Data in Time Scale Axis Charts"

get/setLevelHeight()

When a Time Scale Axis is defined, these methods get/set the height of a level.

SYNTAX:

int getLevelHeight (int level);
void setLevelHeight (int level, int height);
void setLevelHeight (IdentObj id, int height);

INPUT:

level; Level (0...2) from which to get the level height.

id; the object ID of a time scale axis level (i.e., getTimeScaleLevel (n);)

height; the level height in virtual coordinates

RETURN:

int; the level height set by setLevelHeight()

NOTES:

A time scale axis can only be defined in clustered bar, stacked bar, line, and scatter charts.

ALSO SEE:

"Data in Time Scale Axis Charts"

get/setLevelInterval()

When a Time Scale Axis is defined, these methods get/set the interval of a specified level. The level intervals must be set in decreasing order -- the level zero interval must be less than level one, level one must be less than level two.

SYNTAX:

int getLevelInterval (int level);
void setLevelInterval (int level, int interval);
void setLevelInterval (IdentObj id, int interval);

INPUT:

level; Level (0...2) from which to get the interval.

id; the object ID of a time scale axis level (i.e., getTimeScaleLevel (n);)

interval; 0...8
TIME_INTERVAL_UNDEFINED = 0
TIME_INTERVAL_SECONDS = 1
TIME_INTERVAL_MINUTES = 2
TIME_INTERVAL_HOURS = 3
TIME_INTERVAL_DAYS = 4
TIME_INTERVAL_WEEKS = 5
TIME_INTERVAL_MONTHS = 6
TIME_INTERVAL_QUARTERS = 7
TIME_INTERVAL_YEARS = 8

RETURN:

int; Level interval set by setLevelInterval()

NOTES:

A time scale axis can only be defined in clustered bar, stacked bar, line, and scatter charts.

ALSO SEE:

"Data in Time Scale Axis Charts"

get/setLevelTextFormat()

These methods get/set the format of text that is drawn an a specified level on a time scale axis.

SYNTAX:

int getLevelTextFormat (int level);
void setLevelTextFormat (int level, int format);
void setLevelTextFormat (IdentObj id, int format);

INPUT:

level; Level from which to get the text format (0...2).

id; the object ID of a time scale axis level (i.e., getTimeScaleLevel (n);)

format; -1...2
IIntervalScale.FORMAT_SHORT = 0
IIntervalScale.FORMAT_MEDIUM = 1
IIntervalScale.FORMAT_LONG = 2
IIntervalScale.FORMAT_RAW = -1

RETURN:

int; Level text format number

NOTES:

A time scale axis can only be defined in clustered bar, stacked bar, line, and scatter charts.
The format in which text is drawn depends on the level interval set by setLevelInterval(). The following table shows how each text format is represented for each level:

If FORMAT_RAW (setLevelTextFormat (getTimeScaleLevel (1), -1)) is used, you can specifically define how date and time text is formatted using setLevelDateFormat() and the standard Java SimpleDateFormat codes.

ALSO SEE:

"Data in Time Scale Axis Charts"

setLevelBorderColor()

When a Time Scale Axis is defined, this method applies a border color to a specified level.

SYNTAX:

void setLevelBorderColor (int level, Color color)
void setLevelBorderColor (IdentObj id, Color color)

INPUT:

level; 0...2

id; the object ID of a time scale axis level (i.e., getTimeScaleLevel (n);)

color; the border color to be assigned to the specified level (e.g., new Color (255, 0, 0)).

RETURN:

void

EXAMPLE:

setLevelBorderColor (getTimeScaleLevel (1), new Color (255, 0, 0));
setLevelBorderColor (getTimeScaleLevel (0), new Color (0, 255, 0));
setLevelBorderColor (getTimeScaleLevel (2), new Color (0, 0, 255));

NOTES:

A time scale axis can only be defined in clustered bar, stacked bar, line, and scatter charts.
See UseTimeScaleAxis for the data that was used to create the example chart.

ALSO SEE:

"Data in Time Scale Axis Charts"

setLevelTextColor()

When a Time Scale Axis is defined, these methods get/set the color of text objects at a specified level.

SYNTAX:

void setLevelTextColor (int level, Color color);
void setLevelTextColor (IdentObj id, Color color);

INPUT:

level; 0...2

color; the text color to be assigned to the specified level (e.g., new Color (255, 0, 0)).

id; the object ID of a time scale axis level (i.e., getTimeScaleLevel (n);)

RETURN:

void

EXAMPLE:

setLevelBorderColor (getTimeScaleLevel (1), new Color (255, 0, 0));
setLevelBorderColor (getTimeScaleLevel (0), new Color (0, 255, 0));
setLevelBorderColor (getTimeScaleLevel (2), new Color (0, 0, 255));
setLevelTextColor (getTimeScaleLevel (1), new Color (255, 0, 0));
setLevelTextColor (getTimeScaleLevel (0), new Color (0, 255, 0));
setLevelTextColor (getTimeScaleLevel (2), new Color (0, 0, 255));

NOTES:

A time scale axis can only be defined in clustered bar, stacked bar, line, and scatter charts.
See UseTimeScaleAxis for the data that was used to create the example chart.

ALSO SEE:

"Data in Time Scale Axis Charts"

setTimeScaleAxisDefaults()

This method can be used to set a time scale axis to default values.

SYNTAX:

void setTimeScaleAxisDefaults();

INPUT:

none

RETURN:

void

NOTES:

This method sets a time scale axis to the following default values:

setLevelTextFormat(0,IIntervalScale.FORMAT_SHORT);
setLevelTextFormat(1,IIntervalScale.FORMAT_LONG);
setLevelTextFormat(2,IIntervalScale.FORMAT_LONG);
setLevelInterval(0,Interval.TIME_INTERVAL_UNDEFINED);
setLevelInterval(1,Interval.TIME_INTERVAL_UNDEFINED);
setLevelInterval(2,Interval.TIME_INTERVAL_UNDEFINED);
setFillColor(getTimeScaleLevel(0),new Color(204, 204, 204));
setFillColor(getTimeScaleLevel(1),new Color(221, 221, 221));
setFillColor(getTimeScaleLevel(2),new Color(238, 238, 238));
setLevelTextColor(getTimeScaleLevel(0),Color.black);
setLevelTextColor(getTimeScaleLevel(1),Color.black);
setLevelTextColor(getTimeScaleLevel(2),Color.black);
setTextJustVert(getTimeScaleLevel(0),TextStyleIF.ALIGN_VERT_CENTER);
setTextJustVert(getTimeScaleLevel(1),TextStyleIF.ALIGN_VERT_CENTER);
setTextJustVert(getTimeScaleLevel(2),TextStyleIF.ALIGN_VERT_CENTER);
setLevelHeight(0, 1200);
setLevelHeight(1, 1200);
setLevelHeight(2, 1200);