Automatic Chart Layout

get/setPlaceAlign(); Get/Set Alignment of Text Objects
get/setPlaceMargin(); Get/Set Margins
get/setPlaceMaxNumWordWrapLines(); Get/Set Maximum Number of Word Wrap Lines
get/setPlaceMinFontSize(); Get/Set Minimum Font Size
get/setPlacePosition(); Get/Set Position
get/setPlaceRect(); Get/Set Rectangle
get/setPlaceResize(); Get/Set Resize
get/setPlaceRotate(); Get/Set Rotation
get/setPlaceSkip(); Get/Set Label Skipping
get/setPlaceTruncateCount(); Get/Set Text Truncation
get/setPlaceWordWrap(); Get/Set Word Wrap

get/setPlaceAlign()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set whether or not horizontal alignment of a specified text object is allowed. The default value is 1 (allow horizontal alignment of all text objects).

SYNTAX:

int getPlaceAlign (IdentObj id);
void setPlaceAlign (IdentObj id, int newValue)

INPUT:

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

newValue; 0...1. 0 = Do not allow horizontal of the specified text object. 1 = Allow horizontal of the specified text object

RETURN:

int; 0...1. 0 = Do not allow horizontal alignment of the specified chart object, 1 = Allow horizontal alignment of the specified chart object

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that realignment is needed to produce a better chart layout.

ALSO SEE:

Place

get/setPlaceMargin()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set a margin around the entire chart as defined by the rectangle parameter. The default is new Rectangle (-15500, -15500, 24000, 31000).

SYNTAX:

Rectangle getPlaceMargin();
void setPlaceMargin (Rectangle newValue);

INPUT:

newValue; 4 values specifying x, y, width, & height of rectangle in virtual coordinates (e.g, new Rectangle (-15500, -15500, 24000, 31000).

RETURN:

Rectangle; a rectangle object that defines the margin around a chart.

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).

ALSO SEE:

Place

get/setPlaceMaxNumWordWrapLines()

When the automatic chart layout manager is enabled with setPlace (true) and word wrapping is enabled with setPlaceWordWrap (1), these methods get/set the maximum number of lines that can be used when a specified text object is word wrapped.

SYNTAX:

int getPlaceMaxNumWordWrapLines (IdentObj id);
void setPlaceMaxNumWordWrapLines (IdentObj id, int newValue);

INPUT:

id; object ID of a text object returned by a getObject() method (e.g., get O1Label())

newValue; maximum number of lines to use for word wrapping

RETURN:

int; The maximum number of word wrap lines (0...10). The default value is (3)

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that word wrapping is needed to produce a better chart layout.

ALSO SEE:

Place, get/setPlaceWordWrap()

get/setPlaceMinFontSize()

When the automatic chart layout manager is enabled with setPlace (true) and resizing of a text object is enabled with setPlaceResize (1), these methods get/set the minimum font size (in points) that can be used to resize a specified text object.

SYNTAX:

int getPlaceMinFontSize (IdentObj id);
void setPlaceMinFontSize (IdentObj id, int newValue);

INPUT:

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

newValue; minimum font size in points (4...96). The default value is 4.

RETURN:

int; minimum font size (4...96). The default value is 4.

EXAMPLE:

restoreDefaults();
setGroupLabel (getGroup (0), "Long group0 label");
setGroupLabel (getGroup (1), "Longer group1 label");
setGroupLabel (getGroup (2), "Longer, Longer group2 label");
setGroupLabel (getGroup (3), "Longer, Longer, Longer group3 label");
setGroupLabel (getGroup (4), "Longer, Longer, Longer, Longer, group4 label");
setDisplay (getY1Title(), true);
setDisplay (getO1Title(), true);
setTextString (getY1Title(), "Y1");
setTextString (getO1Title(), "O1");
setPlaceSkip (getO1Label(), 0);
setFontSizeAbsolute (getO1Label(), true);
setFontSize (getO1Label(), 10);
setPlaceMinFontSize (getO1Label(), 10);
setPlaceRect (getPlaceVertO1LabelsTitle(), new Rectangle (-14000, -15500, 29000, 24000));
setPlaceRotate (getO1Label(), 1);
setTextJustVert (getO1Label(), 0);
setDataRange (0, 0, 1, 4);
setPlace (true);
setDepthRadius (0);
setFootnoteDisplay (false);

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that font resizing is needed to produce a better chart layout.

ALSO SEE:

Place, get/setPlaceResize()

get/setPlacePosition()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set how chart objects can be repositioned. In the current implementation, only the legend object can be repositioned.

SYNTAX:

int getPlacePosition (IdentObj id);
void setPlacePosition (IdentObj id, int newValue);

INPUT:

id; object ID returned by a getObject() method. In the current implementation, only the legend object can be repositioned (e.g., getLegendArea()).

newValue; 0...4. 0 = Automatic (Not Implemented), 1 = Bottom, 2 = Right (Not Implemented), 3 = Free Floating (Not Implemented), 4 = Right Center

RETURN:

int; 0...4. 0 = Automatic (Not Implemented), 1 = Bottom, 2 = Right (Not Implemented), 3 = Free Floating (Not Implemented), 4 = Right Center

EXAMPLE:

setDepthRadius (0);
setPlacePosition (getLegendArea(), 1);
setPlace (true);

setDepthRadius (0);
setPlacePosition (getLegendArea(), 4);
setPlace (true);

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that repositioning is needed to produce a better chart layout.
In the current implementation, this method only works with the legend area object (getLegendArea()).
If setPlacePosition (getLegendArea(), true) is used, the LegendAutomatic property will also be set to true.

ALSO SEE:

Place

get/setPlaceRect()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set a rectangle to be used for initial placement of objects in a chart. In the current implementation, only object IDs return by getPlaceVertO1LabelsTitle() or getPlaceHorzO1LabelsTitle() can be used.

SYNTAX:

Rectangle getPlaceRect (IdentObj id);
void setPlaceRect (IdentObj id, Rectangle newValue);

INPUT:

id; object ID returned by getPlaceVertO1LabelsTitle() or getPlaceHorzO1LabelsTitle()

newValue; 4 values specifying x, y, width, & height of rectangle in virtual coordinates (e.g, new Rectangle (-15500, -15500, 24000, 31000).

RETURN:

Rectangle; rectangle set by setPlaceRect()

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).

ALSO SEE:

Place

get/setPlaceResize()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set whether or not an object can be moved or resized. The default value is 1 (allow resizing of all chart objects).

SYNTAX:

int getPlaceResize (IdentObj id);
void setPlaceResize (IdentObj id, int newValue)

INPUT:

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

newValue; 0...1. 0 = Do not allow resizing of chart objects, 1 = Allow resizing of chart objects

RETURN:

int; 0...1. 0 = Do not allow resizing of chart objects, 1 = Allow resizing of chart objects

EXAMPLE:

setDepthRadius (0);
setPlaceResize (getFrame(), 1);
setPlace (true);

setDepthRadius (0);
setPlaceResize (getFrame(), 0);
setPlace (true);

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that resizing is needed to produce a better chart layout.

ALSO SEE:

Place

get/setPlaceRotate()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set rotation of a specified text object. The default value is 1 (allow rotation of all text objects).

SYNTAX:

int getPlaceRotate (IdentObj id);
void setPlaceRotate (IdentObj id, int newValue);

INPUT:

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

newValue; 0...1. 0 = Do not allow rotation of object (s), 1 = Allow rotation of object (s)

RETURN:

int; 0...1. 0 = Do not allow rotation of object (s), 1 = Allow rotation of object (s)

EXAMPLE:

setDepthRadius (0);
setGroupLabel (getGroup (0), "Long Group0 Label");
setGroupLabel (getGroup (1), "Longer Group1 Label");
setGroupLabel (getGroup (2), "Longer, Longer Group2 Label");
setGroupLabel (getGroup (3), "Longer, Longer Group3 Label");
setDataRange (0, 0, 2, 3);
setPlaceRotate (getO1Label(), 1);
setPlaceWordWrap (getO1Label(), 0);
setPlace (true);

setDepthRadius (0);
setGroupLabel (getGroup (0), "Long Group0 Label");
setGroupLabel (getGroup (1), "Longer Group1 Label");
setGroupLabel (getGroup (2), "Longer, Longer Group2 Label");
setGroupLabel (getGroup (3), "Longer, Longer, Longer Group3 Label");
setDataRange (0, 0, 2, 3);
setPlaceWordWrap (getO1Label(), 1);
setPlaceRotate (getO1Label(), 0);
setPlace (true);

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that rotation is needed to produce a better chart layout.

ALSO SEE:

Place

get/setPlaceSkip()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set label skipping on the primary ordinal axis. The default value is 1 (allow skipping for all axis labels).

SYNTAX:

int getPlaceSkip (IdentObj id);
void setPlaceSkip (IdentObj id, int newValue);

INPUT:

id; object ID of primary ordinal axis labels (i.e., getO1Label());

newValue; 0...1. 0 = Do not allow label skipping, 1 = Allow label skipping

RETURN:

int; 0...1. 0 = Do not allow label skipping, 1 = Allow label skipping

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that label skipping is needed to produce a better chart layout.

ALSO SEE:

Place

get/setPlaceTruncateCount()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set the maximum number of characters allowed for a text object. When a text object is longer than the specified number of characters elipses (...) will be appended to the truncated text to indicate the text has been truncated. The elipses count for 3 characters. In the example below, group labels "Group 0", "Group 1", etc., are truncated to "Gro..." because the maximum label character count is 6.

SYNTAX:

int getPlaceTruncateCount (IdentObj id);
void setPlaceTruncateCount (IdentObj id, int newValue);

INPUT:

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

newValue; maximum number of characters allowed

RETURN:

int; 0...1096. The default value is (0).

EXAMPLE:

setDepthAngle (0);
setDepthRadius (0);
setFillColor (getO1Label(), new Color (255, 0, 0));
setPlace (true);
setPlaceTruncateCount (getO1Label(), 6);

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that truncation is needed to produce a better chart layout.
Data is truncated permanently in the Perspective for Java data manager when this method sets a truncate count.

ALSO SEE:

Place

get/setPlaceWordWrap()

When the automatic chart layout manager is enabled with setPlace (true), these methods get/set whether or not long text objects can be word wrapped. The default value is 1 (allow word wrap for all text objects).

SYNTAX:

int getPlaceWordWrap (IdentObj id);
void setPlaceWordWrap (IdentObj id, int newValue);

INPUT:

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

newValue; 0...1. The default value is 1. 0 = Do not allow word wrap, 1 = Allow word wrap

RETURN:

int; 0...1. The default value is 1. 0 = Do not allow word wrap, 1 = Allow word wrap

EXAMPLE 1:

setDepthRadius (0);
setGroupLabel (getGroup (0), "This is a very long group label0");
setGroupLabel (getGroup (1), "This is a very long group label1");
setGroupLabel (getGroup (2), "This is a very long group label2");
setGroupLabel (getGroup (3), "This is a very long group label3");
setGroupLabel (getGroup (4), "This is a very long group label4");
setPlaceWordWrap (getO1Label(), 0);
setPlace (true);

setDepthRadius (0);
setGroupLabel (getGroup (0), "This is a very long group label0");
setGroupLabel (getGroup (1), "This is a very long group label1");
setGroupLabel (getGroup (2), "This is a very long group label2");
setGroupLabel (getGroup (3), "This is a very long group label3");
setGroupLabel (getGroup (4), "This is a very long group label4");
setPlaceWordWrap (getO1Label(), 1);
setPlace (true);

NOTES:

All getPlace...() and setPlace...() methods are only valid when the automatic chart layout manager has been enabled with setPlace (true).
The value assigned to the specified object will only be used if the automatic chart layout manager determines that word wrapping is needed to produce a better chart layout.

ALSO SEE:

Place