ilog.views.chart.renderer

Class IlvSingleHiLoRenderer

java.lang.Object

ilog.views.chart.IlvChartRenderer

ilog.views.chart.renderer.IlvSingleChartRenderer

ilog.views.chart.renderer.IlvSingleHiLoRenderer

public class IlvSingleHiLoRenderer
extends IlvSingleChartRenderer

Renders two data sets that contain corresponding points at the same indices.

For every point index, a point is taken from the first data set in the data source, and a point is taken from the second data set in the data source, to form a pair of points. The pairs of points are also called "high/low" items.

This renderer is used in three situations:

• By an IlvHiLoRenderer in CLUSTERED mode. In this case, the pair consists of a "first point" and of a "second point".
• By an IlvHiLoRenderer in CANDLE or OPENCLOSE mode, for the high-low values. In this case, the pair consists of a "low value" and of a "high value". The low value comes first.
• By an IlvHiLoRenderer in CANDLE or OPENCLOSE mode, for the open-close values. In this case, the pair consists of an "open" (or "start") value and of a "close" (or "end") value.

An IlvSingleHiLoRenderer can be of 4 types: BAR, ARROW, MARKED and STICK. The only difference among these modes is the way the renderer is drawn. The following figure shows the different types:

This renderer uses two rendering styles to draw the data points:

• The rise style is used to draw the point pairs for which the first value (from the data set at index 0 in the data source) is less than the second value (from the data set at index 1 in the data source).
• The fall style is used to draw the point pairs for which the first value (data set at index 0 in the data source) is greater than the second value (data set at index 1 in the data source).

CSS example:

ilvSingleHiLoRenderer {
class : "ilog.views.chart.renderer.IlvSingleHiLoRenderer";
annotation : "@#ilvDataLabelAnnotation";
fallStyle : "@#ilvStyle";
name : "<value>";
riseStyle : "@#ilvStyle";
style : "@#ilvStyle";
styles[0] : "@#ilvStyle1";
styles[1] : "@#ilvStyle2";
type : "STICK";
useCategorySpacingAtBorders : "false";
visible : "false";
visibleInLegend : "false";
widthPercent : "3.0";
YAxisIdx : "2";
}

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 HiLo renderer.
IlvStyle	fallStyle Sets the fall style.
java.lang.String	name Sets the name of this renderer.
IlvStyle	riseStyle Sets the rise style.
IlvStyle	style Sets the style used by this renderer.
IlvStyle[]	styles Sets the styles used by this renderer.
int	type Sets the type of this 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.

CSS example: widthPercent : "3.0";

YAxisIdx

public int YAxisIdx

Connects the specified renderer to the specified ordinate axis.

CSS example: YAxisIdx : "2";