ilog.views.chart.graphic

Class IlvThresholdIndicator

java.lang.Object

ilog.views.chart.IlvChartOwnedDrawable

ilog.views.chart.IlvChartDecoration

ilog.views.chart.graphic.IlvDataIndicator

ilog.views.chart.graphic.IlvThresholdIndicator

All Implemented Interfaces:

IlvChart3DSupport, IlvChartDrawable, Serializable

public class IlvThresholdIndicator
extends IlvDataIndicator

An IlvDataIndicator subclass that defines threshold lines and ranges. An IlvThresholdIndicator instance defines maximum and minimum values on given data sets as well as provides a graphical representation of these limit values. These limit values are actually data set properties and thus can be used through the styling API to define a dynamic styling on a series depending on the threshold values (see below for an example).

Depending on the type of the threshold indicator, the properties for the limit values are:

• xThresholdMin
• xThresholdMax
• yThresholdMin
• yThresholdMax

In addition to these features, an IlvThresholdIndicator supports direct user interactions in order to modify the limit values:

• click within the indicator and drag the mouse to modify its range definition
• click an indicator border and drag the mouse to modify the corresponding limit value.

Here is an example of a series styling. The following rules change the color of the series named "dataSet1" depending on whether the datapoint value lies inside the threshold range indicator.

chart {
  decorations: @|decorations(@#xIndic);
}

Subobject#xIndic {
  class:'ilog.views.chart.graphic.IlvThresholdIndicator(axisIndex, range, text, properties)';
  axisIndex: -1;
  range:\"[5;7]\";
  text:'';
  properties:"xThresholdMin,xThresholdMax";
  series:'dataSet1';
}

point[\"@|@x-@xThresholdMin\">0][\"@|@x-@xThresholdMax\"<0] {
  color1: #ff0000;
}

Since:

JViews 6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.chart.graphic.IlvDataIndicator

WINDOW, X_RANGE, X_VALUE, Y_RANGE, Y_VALUE

Constructor Summary

Constructors

Constructor and Description
IlvThresholdIndicator(int axisIndex, double value, String text, String[] property) Creates a threshold for the specified value with the specified text.
IlvThresholdIndicator(int axisIndex, IlvDataInterval range, String text, String[] properties) Creates a threshold for the specified range with the specified text.
IlvThresholdIndicator(int yAxisIdx, IlvDataWindow dataWindow, String text, String[] properties) Creates a threshold for the specified data window with the specified text.

Method Summary

Modifier and Type	Method and Description
protected void	chartConnected(IlvChart oldChart, IlvChart newChart) Called when the indicator is added to or removed from a chart.
String[]	getProperties() Returns the name of the properties of this threshold indicator.
String[]	getSeries() Returns the series associated with this threshold indicator.
boolean	isAnnotationVisible() Returns whether the scale annotations are visible.
boolean	isInteractive() Returns whether user interactions are enabled for this threshold.
void	setAnnotationVisible(boolean anno) Sets whether the scale annotations are visible.
void	setDataWindow(double xmin, double xmax, double ymin, double ymax) Modifies the data window displayed by this indicator.
void	setInteractive(boolean enable) Sets whether user interactions are enabled for this threshold.
void	setRange(IlvDataInterval range) Sets the range displayed by this indicator.
void	setSeries(String[] series) Sets the series associated with this threshold indicator.
void	setValue(double value) Sets the value displayed by the indicator.

Methods inherited from class ilog.views.chart.graphic.IlvDataIndicator

afterDraw, baseTextDirectionChanged, beforeDraw, componentOrientationChanged, computeLabelLocation, contains, draw, getAxisIndex, getBounds, getDataWindow, getDrawStyle, getLabelRenderer, getRange, getShape, getStyle, getText, getType, getValue, has3DSupport, setDataWindow, setLabelRenderer, setStyle, setText, setVisible, updateBoundsCache

Methods inherited from class ilog.views.chart.IlvChartDecoration

getChart, getDrawOrder, isVisible, repaint, setDrawOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvThresholdIndicator

public IlvThresholdIndicator(int axisIndex,
                             double value,
                             String text,
                             String[] property)

Creates a threshold for the specified value with the specified text.

Parameters:

axisIndex - The index of the considered axis: -1 for the x-axis, or the index of a given y-axis. The type of this indicator is set to X_VALUE or Y_VALUE accordingly.

value - The considered value.

text - The text to display. May be null if no text is drawn.

property - The property name of the threshold value. The expected size is one element.

Throws:

IllegalArgumentException - if the properties array has not the expected size.

See Also:

IlvDataIndicator.getType()

IlvThresholdIndicator

public IlvThresholdIndicator(int axisIndex,
                             IlvDataInterval range,
                             String text,
                             String[] properties)

Creates a threshold for the specified range with the specified text.

Parameters:

axisIndex - The index of the considered axis: -1 for the x-axis, or the index of a given y-axis. The type of this indicator is set to X_RANGE or Y_RANGE accordingly.

range - The considered range.

text - The text to display. May be null if no text is drawn.

properties - The property names of the threshold. The expected size is two elements. The first element in the array is the minimum threshold, the second element is the maximum threshold.

Throws:

IllegalArgumentException - if the properties array has not the expected size.

See Also:

IlvDataIndicator.getType()

IlvThresholdIndicator

public IlvThresholdIndicator(int yAxisIdx,
                             IlvDataWindow dataWindow,
                             String text,
                             String[] properties)

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

Parameters:

yAxisIdx - The index of the considered y-axis.

dataWindow - The considered data window.

text - The text to display. May be null if no text is drawn.

properties - The property names of the threshold. The expected size is four elements. The first element in the array is the minimum threshold along the x-axis, the second element is the maximum threshold along the x-axis, the third element is the minimum threshold along the y-axis, the fourth element is the maximum threshold along the y-axis.

Throws:

IllegalArgumentException - if the properties array has not the expected size.

See Also:

IlvDataIndicator.getType()

Method Detail

getProperties

public final String[] getProperties()

Returns the name of the properties of this threshold indicator. The returned array contains in the given order:

• the property name of the threshold value for a VALUE indicator.
• the properties names of the minimum and maximum threshold for a RANGE indicator.
• the properties names of the minimum x threshold, the maximum x threshold, the minimum y threshold, and the maximum y threshold for a WINDOW indicator.

isAnnotationVisible

public final boolean isAnnotationVisible()

Returns whether the scale annotations are visible.

setAnnotationVisible

public void setAnnotationVisible(boolean anno)

Sets whether the scale annotations are visible. The default value is true.

See Also:

isAnnotationVisible()

isInteractive

public final boolean isInteractive()

Returns whether user interactions are enabled for this threshold.

See Also:

setInteractive(boolean)

setInteractive

public void setInteractive(boolean enable)

Sets whether user interactions are enabled for this threshold. The default value is false.

setValue

public void setValue(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.

Overrides:

setValue in class IlvDataIndicator

Throws:

UnsupportedOperationException - The type of the indicator is different from X_VALUE or Y_VALUE.

setRange

public void setRange(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.

Overrides:

setRange in class IlvDataIndicator

Throws:

UnsupportedOperationException - The type of the indicator is different from X_RANGE or Y_RANGE.

setDataWindow

public void setDataWindow(double xmin,
                          double xmax,
                          double ymin,
                          double ymax)

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

Overrides:

setDataWindow in class IlvDataIndicator

Throws:

UnsupportedOperationException - The type of the indicator is not WINDOW.

chartConnected

protected void chartConnected(IlvChart oldChart,
                              IlvChart newChart)

Called when the indicator is added to or removed from a chart.

Overrides:

chartConnected in class IlvDataIndicator

Parameters:

oldChart - The chart with which the decoration was associated, or null if the decoration is added to a new chart.

newChart - The chart to which the decoration is added, or null if the decoration is removed from its current chart.

Throws:

IndexOutOfBoundsException - If the index of the y-axis is not valid.

See Also:

IlvChartOwnedDrawable.getChart()

getSeries

public String[] getSeries()

Returns the series associated with this threshold indicator.

setSeries

public void setSeries(String[] series)

Sets the series associated with this threshold indicator. When a dataset is associated with this threshold, the following dataset properties are defined, depending on the threshold type:

• xThresholdMin
• xThresholdMax
• yThresholdMin
• yThresholdMax