ilog.views.chart.graphic
Class IlvDataIndicator

ilog.views.chart.IlvChartDecoration
      ilog.views.chart.graphic.IlvDataIndicator

Direct Known Subclasses:

IlvThresholdIndicator

public class IlvDataIndicator
extends IlvChartDecoration

Represents a graphical indicator of data values.

An IlvDataIndicator can be used to represent different types of data values, each one with its own graphical representation. Here is the possible type of values that can be marked :

• A value along the x-axis.
• A value along the y-axis.
• A data range along the x-axis.
• A data range along the y-axis.
• A data window.

And here are two pictures showing the graphical representations associated with the different types of data values, for a Cartesian chart and a radar chart:

CSS example:

ilvDataIndicator {
class : "ilog.views.chart.graphic.IlvDataIndicator(axisIndex,dataWindow,text)";
axisIndex : "2";
dataWindow : "@#ilvDataWindow";
drawOrder : "2";
labelRenderer : "@#ilvLabelRenderer";
range : "@#ilvDataInterval";
style : "@#ilvStyle";
text : "<value>";
value : "3.0";
visible : "false";
}

Property Summary

int	axisIndex Sets the index of the axis to which this indicator is attached.
java.lang.String	class Creates an indicator for the specified data window with the specified text.
IlvDataWindow	dataWindow Modifies the data window displayed by this indicator.
int	drawOrder Sets the drawing order of this decoration.
IlvLabelRenderer	labelRenderer Sets the renderer of the text displayed by this indicator.
IlvDataInterval	range Sets the range displayed by this indicator.
IlvStyle	style Specifies the rendering style of this indicator.
java.lang.String	text Sets the text associated with this indicator.
double	value Sets the value displayed by the indicator.
boolean	visible Toggles the visibility of this decoration.

Property Detail

class

public java.lang.String class

Creates an indicator for the specified data window with the specified text. The type of this indicator is set to WINDOW.

CSS example: class : "ilog.views.chart.graphic.IlvDataIndicator(axisIndex,dataWindow,text)";

axisIndex

public int axisIndex

Sets the index of the axis to which this indicator is attached.

CSS example: axisIndex : "2";

dataWindow

public IlvDataWindow dataWindow

Modifies the data window displayed by this indicator. This method can only be used if the type of the indicator is WINDOW.

CSS example: dataWindow : "@#ilvDataWindow";

See implementing class IlvDataWindow for an example of implementing a dataWindow.

drawOrder

public int drawOrder

Sets the drawing order of this decoration.

CSS example: drawOrder : "2";

labelRenderer

public IlvLabelRenderer labelRenderer

Sets the renderer of the text displayed by this indicator.

CSS example: labelRenderer : "@#ilvLabelRenderer";

See implementing class IlvLabelRenderer for an example of implementing a labelRenderer.

range

public IlvDataInterval range

Sets the range displayed by this indicator. This method can only be used if the type of the indicator is X_RANGE or Y_RANGE.

CSS example: range : "@#ilvDataInterval";

See implementing class IlvDataInterval for an example of implementing a range.

style

public IlvStyle style

Specifies the rendering style of this indicator.

CSS example: style : "@#ilvStyle";

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

text

public java.lang.String text

Sets the text associated with this indicator. Depending on the indicator type, the text is rendered using the fill color of the drawing style for the X_VALUE or Y_VALUE types, or with the stroke color of the drawing style in the other cases.

CSS example: text : "<value>";

value

public double value

Sets the value displayed by the indicator. This method can only be used if the type of the indicator is X_VALUE or Y_VALUE.

CSS example: value : "3.0";

visible

public boolean visible

Toggles the visibility of this decoration.

CSS example: visible : "false";