ilog.views.chart.renderer
Class IlvTreemapChartRenderer

ilog.views.chart.IlvChartRenderer
      ilog.views.chart.renderer.IlvSimpleChartRenderer
          ilog.views.chart.renderer.IlvTreemapChartRenderer

public class IlvTreemapChartRenderer
extends IlvSimpleChartRenderer

A renderer displaying treemap charts.

CSS example:

ilvTreemapChartRenderer {
class : "ilog.views.chart.renderer.IlvTreemapChartRenderer";
annotation : "@#ilvDataLabelAnnotation";
annotationClipping : "false";
annotationVisibility : "ALL";
areaColumnName : "<value>";
bottomMarginProportion : "3.0";
clippedAnnotationVisibility : "false";
colorColumnName : "<value>";
colorForNaN : "green";
colorScheme : "CONSTANT";
CSSClassesColumnName : "<value>";
focusParentMarginProportion : "3.0";
labelAlignmentX : "LEFT";
labelAlignmentY : "BOTTOM";
labelColumnName : "<value>";
labelFormat : "@#dateFormat";
leadingMarginProportion : "3.0";
legendLabelFormat : "@#dateFormat";
marginReductionFactor : "3.0";
maximumBottomMargin : "3.0";
maximumFocusParentMargin : "3.0";
maximumLeadingMargin : "3.0";
maximumTopMargin : "3.0";
maximumTrailingMargin : "3.0";
name : "<value>";
packing : "ALTERNATING";
primaryDirection : "RIGHT";
secondaryDirection : "RIGHT";
strokeThreshold : "2";
style : "@#ilvStyle";
styles[0] : "@#ilvStyle1";
styles[1] : "@#ilvStyle2";
topMarginProportion : "3.0";
trailingMarginProportion : "3.0";
useMarginsOnRoot : "false";
visible : "false";
visibleInLegend : "false";
}

Property Summary

IlvDataAnnotation	annotation Specifies a global annotation for all the data sets displayed by this renderer.
boolean	annotationClipping Determines whether annotations are clipped to fit in their corresponding rectangle.
int	annotationVisibility Sets the visibility mode for annotations.
java.lang.String	areaColumnName Determines the column chosen to determine the area of every object, through its name.
double	bottomMarginProportion Sets the bottom margin proportion.
java.lang.String	class Creates a new treemap chart renderer.
boolean	clippedAnnotationVisibility Determines whether annotations that do not fit in their corresponding rectangle can be visible.
java.lang.String	colorColumnName Determines the column chosen to determine the color of every rectangle, through its name.
java.awt.Color	colorForNaN Assigns the color used when a value in the color column is NaN.
ilog.views.chart.renderer.IlvColorScheme	colorScheme Assigns the color scheme.
java.lang.String	CSSClassesColumnName Determines the column chosen to determine the CSS classes of every object, through its name.
double	focusParentMarginProportion Sets the focus parent margin proportion.
int	labelAlignmentX Sets the horizontal alignment of each label within the rectangle to which it belongs.
int	labelAlignmentY Sets the vertical alignment of each label within the rectangle to which it belongs.
java.lang.String	labelColumnName Determines the column chosen to determine the label of every object, as shown by IlvDataLabelAnnotation, through its name.
java.text.Format	labelFormat Sets the format for labels associated with rectangles.
double	leadingMarginProportion Sets the leading margin proportion.
java.text.Format	legendLabelFormat Sets the format of labels associated with colors, in the legend.
double	marginReductionFactor Sets the margin reduction factor.
double	maximumBottomMargin Sets the maximum bottom margin, in pixels.
double	maximumFocusParentMargin Sets the maximum focus parent margin, in pixels.
double	maximumLeadingMargin Sets the maximum leading margin, in pixels.
double	maximumTopMargin Sets the maximum top margin, in pixels.
double	maximumTrailingMargin Sets the maximum trailing margin, in pixels.
java.lang.String	name Sets the name of this renderer.
ilog.views.chart.renderer.IlvTreemapPacking	packing Sets the rectangle packing.
int	primaryDirection Sets the primary direction of arrangement of the rectangles.
int	secondaryDirection Sets the secondary direction of arrangement of the rectangles.
int	strokeThreshold Specifies the minimum size of a rectangle, under which the stroke of a rendering style is not used.
IlvStyle	style Sets the main style used by this renderer.
IlvStyle[]	styles Sets the styles used by this renderer.
double	topMarginProportion Sets the top margin proportion.
double	trailingMarginProportion Sets the trailing margin proportion.
boolean	useMarginsOnRoot Specifies whether the margins also apply to the outermost rectangle, that is, the root of the displayed tree of rectangles.
boolean	visible Toggles the visibility of this renderer.
boolean	visibleInLegend Indicates whether the renderer appears in the legend.

Property Detail

class

public java.lang.String class

Creates a new treemap chart renderer.

CSS example: class : "ilog.views.chart.renderer.IlvTreemapChartRenderer";

annotation

public IlvDataAnnotation annotation

Specifies a global annotation for all the data sets displayed by this renderer. The specified annotation will also be associated with all the data sets that are connected to this renderer.

CSS example: annotation : "@#ilvDataLabelAnnotation";

See implementing class IlvDataLabelAnnotation for an example of implementing an annotation.

annotationClipping

public boolean annotationClipping

Determines whether annotations are clipped to fit in their corresponding rectangle.

CSS example: annotationClipping : "false";

annotationVisibility

public int annotationVisibility

Sets the visibility mode for annotations.

CSS example: annotationVisibility : "ALL";

Allowed values:
ALL		Denotes the visibility mode where all annotations are visible.
9
8
7
6
5
4
3
2
1
0
SMART		Denotes the visibility mode where annotations of inner rectangles are made invisible, according to the following rules: If a rectangle annotation overlaps its parent rectangle annotation, it is hidden. If getClippedAnnotationVisibility() is false and a rectangle annotation extends beyond its rectangle, it is hidden. If a rectangle annotation is hidden, the annotations of its child rectangles (the rectangles inside it) are also hidden, regardless whether they produce overlap or not.
NONE		Denotes the visibility mode where no annotations are visible.

areaColumnName

public java.lang.String areaColumnName

Determines the column chosen to determine the area of every object, through its name.

CSS example: areaColumnName : "<value>";

bottomMarginProportion

public double bottomMarginProportion

Sets the bottom margin proportion.

The value is the proportion relative to a rectangle height. It must be between 0 and 1. Typical values are between 0.01 (1 percent) and 0.05 (5 percent).

CSS example: bottomMarginProportion : "3.0";

clippedAnnotationVisibility

public boolean clippedAnnotationVisibility

Determines whether annotations that do not fit in their corresponding rectangle can be visible. Such annotations would normally have to be clipped; through this method you can hide them.

CSS example: clippedAnnotationVisibility : "false";

colorColumnName

public java.lang.String colorColumnName

Determines the column chosen to determine the color of every rectangle, through its name.

CSS example: colorColumnName : "<value>";

colorForNaN

public java.awt.Color colorForNaN

Assigns the color used when a value in the color column is NaN.

CSS example: colorForNaN : "green";

A color can either be a string representing a color or else an octal or hexadecimal string that starts with the character "#" or else a comma separated "RGB" value where the integer values are in the range 0..255.

colorScheme

public ilog.views.chart.renderer.IlvColorScheme colorScheme

Assigns the color scheme.

CSS example: colorScheme : "CONSTANT";

Allowed values:
CONSTANT		Uses the fill color set in the IlvStyle.
DEPTH		Assigns colors according to the nesting depth of each object, from dark to bright. The bright color is the fill color set in the IlvStyle.
SEQUENTIAL		Assigns colors according to the value of each object at the designated color column, from dark to bright.
SEQUENTIAL_HUE		Assigns colors according to the value of each object at the designated color column, with varying hue but constant brightness.
CYCLIC_SEQUENTIAL_HUE		Assigns colors according to the value of each object at the designated color column, with varying hue but constant brightness, in such a way that the colors for the minimum value and the maximum value are the same. This is suitable when the color column designates a value that is inherently cyclic, such as the time in a day.
QUALITATIVE		Assigns colors according to the value of each object at the designated color column, with good contrast. Especially suitable for columns whose values are enumerated.
DIVERGING_RED_GREEN		Assigns colors according to the value of each object at the designated color column, emphasizing extreme values. Low values are emphasized in red, high values are emphasized in green.
DIVERGING_GREEN_RED		Assigns colors according to the value of each object at the designated color column, emphasizing extreme values. Low values are emphasized in green, high values are emphasized in red. It is the opposite of COLORSCHEME_DIVERGING_RED_GREEN.
DIVERGING_BLUE_YELLOW		Assigns colors according to the value of each object at the designated color column, emphasizing extreme values. Low values are emphasized in blue, high values are emphasized in yellow.
DIVERGING_YELLOW_BLUE		Assigns colors according to the value of each object at the designated color column, emphasizing extreme values. Low values are emphasized in yellow, high values are emphasized in blue. It is the opposite of COLORSCHEME_DIVERGING_BLUE_YELLOW.
AVERAGE_RED_GREEN		Assigns colors according to the value of each object at the designated color column, emphasizing average values. Low values are emphasized in red, high values are emphasized in green.
AVERAGE_GREEN_RED		Assigns colors according to the value of each object at the designated color column, emphasizing average values. Low values are emphasized in green, high values are emphasized in red. It is the opposite of COLORSCHEME_AVERAGE_RED_GREEN.
AVERAGE_BLUE_YELLOW		Assigns colors according to the value of each object at the designated color column, emphasizing average values. Low values are emphasized in blue, high values are emphasized in yellow.
AVERAGE_YELLOW_BLUE		Assigns colors according to the value of each object at the designated color column, emphasizing average values. Low values are emphasized in blue, high values are emphasized in yellow. It is the opposite of COLORSCHEME_AVERAGE_BLUE_YELLOW.

CSSClassesColumnName

public java.lang.String CSSClassesColumnName

Determines the column chosen to determine the CSS classes of every object, through its name.

CSS example: CSSClassesColumnName : "<value>";

focusParentMarginProportion

public double focusParentMarginProportion

Sets the focus parent margin proportion.

The focus parent margin is a border that is drawn when the view displays a portion of the entire model: The parent of the focus object, in the tree model, is drawn around the focus and its subtree.

The value is the proportion relative to a rectangle height. It must be between 0 and 1. Typical values are between 0.01 (1 percent) and 0.05 (5 percent).

CSS example: focusParentMarginProportion : "3.0";

labelAlignmentX

public int labelAlignmentX

Sets the horizontal alignment of each label within the rectangle to which it belongs. The possible values are:

• SwingConstants.LEFT, means left-adjusted within the rectangle,
• SwingConstants.CENTER, means centered horizontally within the rectangle,
• SwingConstants.RIGHT, means right-adjusted within the rectangle,
• SwingConstants.LEADING, means left-adjusted or right-adjusted, according to the locale,
• SwingConstants.TRAILING, means right-adjusted or left-adjusted, according to the locale.

This setting has an effect only when data annotations of type IlvDataLabelAnnotation are used.

CSS example: labelAlignmentX : "LEFT";

Allowed values:
LEFT		Box-orientation constant used to specify the left side of a box.
CENTER		The central position in an area. Used for both compass-direction constants (NORTH, etc.) and box-orientation constants (TOP, etc.).
RIGHT		Box-orientation constant used to specify the right side of a box.
LEADING		Identifies the leading edge of text for use with left-to-right and right-to-left languages. Used by buttons and labels.
TRAILING		Identifies the trailing edge of text for use with left-to-right and right-to-left languages. Used by buttons and labels.

labelAlignmentY

public int labelAlignmentY

Sets the vertical alignment of each label within the rectangle to which it belongs. The possible values are:

• SwingConstants.BOTTOM, means bottom-adjusted within the rectangle,
• SwingConstants.CENTER, means centered vertically within the rectangle,
• SwingConstants.TOP, means top-adjusted within the rectangle.

This setting has an effect only when data annotations of type IlvDataLabelAnnotation are used.

CSS example: labelAlignmentY : "BOTTOM";

Allowed values:
BOTTOM		Box-orientation constant used to specify the bottom of a box.
CENTER		The central position in an area. Used for both compass-direction constants (NORTH, etc.) and box-orientation constants (TOP, etc.).
TOP		Box-orientation constant used to specify the top of a box.

labelColumnName

public java.lang.String labelColumnName

Determines the column chosen to determine the label of every object, as shown by IlvDataLabelAnnotation, through its name.

CSS example: labelColumnName : "<value>";

labelFormat

public java.text.Format labelFormat

Sets the format for labels associated with rectangles.

It specifies how objects or numbers, that are retrieved as values from the label column, are converted to strings.

This setting has an effect only when data annotations of type IlvDataLabelAnnotation are used.

CSS example: labelFormat : "@#dateFormat";

See implementing class DateFormat for an example of implementing a labelFormat.

leadingMarginProportion

public double leadingMarginProportion

Sets the leading margin proportion.

The leading margin is either the left margin or the right margin: it is the right margin if the chart orientation is right-to-left and the primary direction is TRAILING; otherwise it is the left margin.

The value is the proportion relative to a rectangle width. It must be between 0 and 1. Typical values are between 0.01 (1 percent) and 0.05 (5 percent).

CSS example: leadingMarginProportion : "3.0";

See Also:

primaryDirection

legendLabelFormat

public java.text.Format legendLabelFormat

Sets the format of labels associated with colors, in the legend.

It specifies how objects or numbers, that correspond to values of the color column, are converted to strings.

CSS example: legendLabelFormat : "@#dateFormat";

See implementing class DateFormat for an example of implementing a legendLabelFormat.

marginReductionFactor

public double marginReductionFactor

Sets the margin reduction factor.

It describes the margin proportions of a nested rectangle, compared to the margin proportions of the rectangle that contains it.

The value must be >=0. The value 1 (the default) specifies that the margin proportions are independent of the nesting depth. A value between 0 and 1 will make the margins of inner, nested rectangles thinner.

CSS example: marginReductionFactor : "3.0";

maximumBottomMargin

public double maximumBottomMargin

Sets the maximum bottom margin, in pixels.

CSS example: maximumBottomMargin : "3.0";

maximumFocusParentMargin

public double maximumFocusParentMargin

Sets the maximum focus parent margin, in pixels.

CSS example: maximumFocusParentMargin : "3.0";

maximumLeadingMargin

public double maximumLeadingMargin

Sets the maximum leading margin, in pixels.

The leading margin is either the left margin or the right margin: it is the right margin if the chart's orientation is right-to-left and the primary direction is TRAILING; otherwise it is the left margin.

CSS example: maximumLeadingMargin : "3.0";

See Also:

primaryDirection

maximumTopMargin

public double maximumTopMargin

Sets the maximum top margin, in pixels.

CSS example: maximumTopMargin : "3.0";

maximumTrailingMargin

public double maximumTrailingMargin

Sets the maximum trailing margin, in pixels.

The trailing margin is either the right margin or the left margin: it's the left margin if the chart's orientation is right-to-left and the primary direction is TRAILING; otherwise it is the right margin.

CSS example: maximumTrailingMargin : "3.0";

See Also:

primaryDirection

name

public java.lang.String name

Sets the name of this renderer.

CSS example: name : "<value>";

packing

public ilog.views.chart.renderer.IlvTreemapPacking packing

Sets the rectangle packing.

CSS example: packing : "ALTERNATING";

Allowed values:
ALTERNATING		The default type of packing: The rectangles are arranged according to the sort order given by the model, and in alternating directions at the different levels.
SQUARIFIED_CORNER		Type of packing: The rectangles are arranged to be near-squares. Big rectangles are in one corner, the small rectangles are in the opposite corner. This type of packing is suitable when, at the lowest level, there are many small rectangles.
BAR		Type of packing: The rectangles are arranged to have all the same width but different heights. The result resembles a bar chart.

primaryDirection

public int primaryDirection

Sets the primary direction of arrangement of the rectangles. The possible values are:

• SwingConstants.RIGHT, means left-to-right arrangement,
• SwingConstants.LEFT, means right-to-left arrangement,
• SwingConstants.TRAILING, means left-to-right or right-to-left arrangement, according to the locale,
• SwingConstants.TOP, means bottom-to-top arrangement,
• SwingConstants.BOTTOM, means top-to-bottom arrangement.

CSS example: primaryDirection : "RIGHT";

Allowed values:
RIGHT		Box-orientation constant used to specify the right side of a box.
LEFT		Box-orientation constant used to specify the left side of a box.
TRAILING		Identifies the trailing edge of text for use with left-to-right and right-to-left languages. Used by buttons and labels.
TOP		Box-orientation constant used to specify the top of a box.
BOTTOM		Box-orientation constant used to specify the bottom of a box.

secondaryDirection

public int secondaryDirection

Sets the secondary direction of arrangement of the rectangles. The possible values are:

• SwingConstants.RIGHT, means left-to-right arrangement,
• SwingConstants.LEFT, means right-to-left arrangement,
• SwingConstants.TRAILING, means left-to-right or right-to-left arrangement, according to the locale,
• SwingConstants.TOP, means bottom-to-top arrangement,
• SwingConstants.BOTTOM, means top-to-bottom arrangement.

CSS example: secondaryDirection : "RIGHT";

Allowed values:
RIGHT		Box-orientation constant used to specify the right side of a box.
LEFT		Box-orientation constant used to specify the left side of a box.
TRAILING		Identifies the trailing edge of text for use with left-to-right and right-to-left languages. Used by buttons and labels.
TOP		Box-orientation constant used to specify the top of a box.
BOTTOM		Box-orientation constant used to specify the bottom of a box.

strokeThreshold

public int strokeThreshold

Specifies the minimum size of a rectangle, under which the stroke of a rendering style is not used.

The default value is 0.

CSS example: strokeThreshold : "2";

style

public IlvStyle style

Sets the main style used by this renderer. By default, the IlvTreemapChartRenderer class makes use of a single style. If the parameter is null and the renderer has been attached to a chart, sets a default style.

Note: The Bean property style must not be specified together with the Bean property styles.

CSS example: style : "@#ilvStyle";

See implementing class IlvStyle for an example of implementing a style.

styles

public IlvStyle[] styles

Sets the styles used by this renderer.

CSS example:

styles[0] : "@#ilvStyle1";
styles[1] : "@#ilvStyle2";

See implementing class IlvStyle for an example of implementing a styles.

topMarginProportion

public double topMarginProportion

Sets the top margin proportion.

The value is the proportion relative to a rectangle height. It must be between 0 and 1. Typical values are between 0.01 (1 percent) and 0.05 (5 percent).

CSS example: topMarginProportion : "3.0";

trailingMarginProportion

public double trailingMarginProportion

Sets the trailing margin proportion.

The trailing margin is either the right margin or the left margin: it's the left margin if the chart orientation is right-to-left and the primary direction is TRAILING; otherwise it is the right margin.

The value is the proportion relative to a rectangle width. It must be between 0 and 1. Typical values are between 0.01 (1 percent) and 0.05 (5 percent).

CSS example: trailingMarginProportion : "3.0";

See Also:

primaryDirection

useMarginsOnRoot

public boolean useMarginsOnRoot

Specifies whether the margins also apply to the outermost rectangle, that is, the root of the displayed tree of rectangles. The default is true.

CSS example: useMarginsOnRoot : "false";

visible

public boolean visible

Toggles the visibility of this renderer.

CSS example: visible : "false";

visibleInLegend

public boolean visibleInLegend

Indicates whether the renderer appears in the legend.

The default value of this property is true, which means that the renderer will automatically create and add items to the legend.

CSS example: visibleInLegend : "false";