ilog.views.chart.graphic

Class IlvGradientRenderingHint

java.lang.Object

ilog.views.chart.graphic.IlvGradientRenderingHint

All Implemented Interfaces:

IlvDataRenderingHint, Serializable

public class IlvGradientRenderingHint
extends Object
implements IlvDataRenderingHint, Serializable

A rendering hint that computes the color of a data point according to a gradient specification.

The default implementation of IlvGradientRenderingHint uses the y-value of a data point to determine its color according to the transition values of the gradient.

Here is a picture showing a gradient rendering hint going from blue for minimum values to red for maximum values.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvGradientRenderingHint(double[] values, Color[] colors) Creates a new gradient rendering hint.

Method Summary

Modifier and Type	Method and Description
protected Color	getColor(IlvDisplayPoint dp) Returns the color to apply to the specified display point.
Color	getGradientColor(int idx) Returns the transition color at the specified index.
double	getGradientValue(int idx) Returns the transition value at the specified index.
IlvStyle	getStyle(IlvDisplayPoint dp, IlvStyle defaultStyle) Returns the rendering style that must be used to display the specified point.
protected double	getValue(IlvDisplayPoint dp) Returns the value that will be used to compute the color of the specified point.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvGradientRenderingHint

public IlvGradientRenderingHint(double[] values,
                                Color[] colors)

Creates a new gradient rendering hint.

Parameters:

values - The transition values of the gradient. The provided array must be sorted in ascending order.

colors - The colors associated with the transition values.

Method Detail

getStyle

public IlvStyle getStyle(IlvDisplayPoint dp,
                         IlvStyle defaultStyle)

Returns the rendering style that must be used to display the specified point.

Specified by:

getStyle in interface IlvDataRenderingHint

Parameters:

dp - The considered display point.

defaultStyle - The default style used to display the point. This style corresponds to the style that would be used if no hint was defined.

Returns:

The rendering style that must be used to display the point.

getColor

protected Color getColor(IlvDisplayPoint dp)

Returns the color to apply to the specified display point.

getGradientValue

public final double getGradientValue(int idx)

Returns the transition value at the specified index.

Parameters:

idx - The considered index.

Returns:

The transition value.

getGradientColor

public final Color getGradientColor(int idx)

Returns the transition color at the specified index.

Parameters:

idx - The considered index.

Returns:

The transition color.

getValue

protected double getValue(IlvDisplayPoint dp)

Returns the value that will be used to compute the color of the specified point. The default implementation returns the y-value of the data point.