ilog.views.chart.renderer

Class IlvHiLoChartRenderer

java.lang.Object

ilog.views.chart.IlvChartRenderer

ilog.views.chart.renderer.IlvCompositeChartRenderer

ilog.views.chart.renderer.IlvHiLoChartRenderer

public class IlvHiLoChartRenderer
extends IlvCompositeChartRenderer

A renderer displaying superimposed High/Low renderers. The IlvHiLoChartRenderer class defines 3 representation modes: CLUSTERED, CANDLE and OPENCLOSE.

In CLUSTERED mode, this class creates an instance of IlvSingleHiLoRenderer for every pair (maximum 2) of data sets, in the low/high order. The type of the child renderers is determined according to the type property (see #setType), and should match one of the IlvSingleHiLoRenderer types. Note that the type property only makes sense with the CLUSTERED mode.

In OPENCLOSE mode, the required number of data sets is 4: 2 data sets (the first ones) for the high/low representation plus 2 data sets for the start/end representation, each representation corresponding to an IlvSingleHiLoRenderer instance (of type STICK and MARKED, respectively).

The CANDLE mode only differs from OPENCLOSE mode by the graphic representation used: the high/low representation is of type STICK, the open/close being of type BAR.

The following pictures show the representation of each mode in the following order: CANDLE, OPENCLOSE and CLUSTERED/BAR with 2 children.

CSS example:

ilvHiLoChartRenderer {
class : "ilog.views.chart.renderer.IlvHiLoChartRenderer";
annotation : "@#ilvDataLabelAnnotation";
mode : "CLUSTERED";
name : "<value>";
names[0] : "<value>";
names[1] : "<value>";
overlap : "3.0";
styles[0] : "@#ilvStyle1";
styles[1] : "@#ilvStyle2";
type : "STICK";
useCategorySpacingAtBorders : "false";
visible : "false";
visibleInLegend : "false";
widthPercent : "3.0";
YAxisIdx : "2";
}

See Also:

IlvSingleHiLoRenderer

Property Summary

Properties

Modifier and Type	Property and Description
IlvDataAnnotation	annotation Specifies a global annotation for all the data sets displayed by this renderer.
java.lang.String	class Creates a new High-Low chart, in CLUSTERED BAR mode, with a default width.
int	mode Sets the mode of this renderer.
java.lang.String	name Sets the name of this renderer.
java.lang.String[]	names Sets the list of names of the child renderer pairs.
double	overlap Modifies the overlapping amount.
IlvStyle[]	styles Sets the styles used by the child renderers.
int	type Sets the type of the renderer.
boolean	useCategorySpacingAtBorders Determines whether the category spacing is used also at the left and right borders.
boolean	visible Toggles the visibility of this renderer.
boolean	visibleInLegend Indicates whether the renderer appears in the legend.
double	widthPercent Sets the width of the graphical representation of a data point along the x-axis.
int	YAxisIdx Connects the specified renderer to the specified ordinate axis.

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";

widthPercent

public double widthPercent

Sets the width of the graphical representation of a data point along the x-axis. The size is specified as a percentage of the difference between the x-values of two consecutive data points. It is assumed that all the data points are evenly spaced along the x-axis, and that the resulting size is the same for all the data points. The default implementation propagates the new value to its children.

CSS example: widthPercent : "3.0";

YAxisIdx

public int YAxisIdx

Connects the specified renderer to the specified ordinate axis.

CSS example: YAxisIdx : "2";