ilog.tgo.graphic

Class IltChartMapping

java.lang.Object

ilog.tgo.graphic.IltImageMapping

ilog.tgo.graphic.IltChartMapping

public class IltChartMapping
extends IltImageMapping

This class stores the configuration used to create an IltChart decoration.

Since:

JTGO 2.0

Constructor Summary

Constructors

Constructor and Description
IltChartMapping() Default constructor.
IltChartMapping(Image minImage, Image maxImage) Creates a chart with the given images.
IltChartMapping(Image minImage, Image maxImage, int xAxis, int yAxis, IltColorModifier modifier) Creates a chart with the given properties.
IltChartMapping(String minImage, String maxImage) Creates a chart with the given images.
IltChartMapping(String minImage, String maxImage, int xAxis, int yAxis, IltColorModifier modifier) Creates a chart with the given properties.

Method Summary

Modifier and Type	Method and Description
IltColorModifier	getColorModifier() Returns the color modifier for this chart.
int	getValuesCount() Returns the number of values that can be represented by this chart.
int	getXAxisDirection() Returns the direction of the x axis.
int	getYAxisDirection() Returns the direction of the y axis.
void	setColorModifier(IltColorModifier modifier) Sets the color modifier for this chart.
void	setDirections(int xAxis, int yAxis) Sets the direction of the x and y axis.
int	setXAxisDirection() Sets the direction of the x axis.
int	setYAxisDirection() Sets the direction of the y axis.

Methods inherited from class ilog.tgo.graphic.IltImageMapping

getMaxImage, getMinImage, setMaxImage, setMaxImage, setMinImage, setMinImage

Methods inherited from class java.lang.Object

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

Constructor Detail

IltChartMapping

public IltChartMapping(String minImage,
                       String maxImage)

Creates a chart with the given images.

IltChartMapping

public IltChartMapping(String minImage,
                       String maxImage,
                       int xAxis,
                       int yAxis,
                       IltColorModifier modifier)

Creates a chart with the given properties.

Parameters:

minImage - Image which represents the chart with the minimum value.

maxImage - Image which represents the chart completely filled.

xAxis - Position of the x axis; possible values are: IlvDirection.Left, IlvDirection.Right, IlvDirection.Top or IlvDirection.Bottom.

yAxis - Position of the y axis; possible values are: IlvDirection.Left, IlvDirection.Right, IlvDirection.Top or IlvDirection.Bottom.

modifier - Color modifier responsible for defining the color used to fill the chart.

IltChartMapping

public IltChartMapping(Image minImage,
                       Image maxImage)

Creates a chart with the given images.

IltChartMapping

public IltChartMapping()

Default constructor.

IltChartMapping

public IltChartMapping(Image minImage,
                       Image maxImage,
                       int xAxis,
                       int yAxis,
                       IltColorModifier modifier)

Creates a chart with the given properties.

Parameters:

minImage - Image which represents the chart with the minimum value.

maxImage - Image which represents the chart completely filled.

xAxis - Position of the x axis; possible values are: IlvDirection.Left, IlvDirection.Right, IlvDirection.Top or IlvDirection.Bottom.

yAxis - Position of the y axis; possible values are: IlvDirection.Left, IlvDirection.Right, IlvDirection.Top or IlvDirection.Bottom.

modifier - color Modifier responsible for defining the color used to fill the chart.

Method Detail

setDirections

public void setDirections(int xAxis,
                          int yAxis)

Sets the direction of the x and y axis. The default x axis direction is IlvDirection.Right. The default y axis direction is IlvDirection.Top.
Note: The axes directions must be orthogonal.

Parameters:

xAxis - A direction; only IlvDirection.Left, IlvDirection.Right, IlvDirection.Top and IlvDirection.Bottom are valid.

yAxis - A direction; only IlvDirection.Left, IlvDirection.Right, IlvDirection.Top and IlvDirection.Bottom are valid.

getXAxisDirection

public int getXAxisDirection()

Returns the direction of the x axis.

setXAxisDirection

public int setXAxisDirection()

Sets the direction of the x axis.

getYAxisDirection

public int getYAxisDirection()

Returns the direction of the y axis.

setYAxisDirection

public int setYAxisDirection()

Sets the direction of the y axis.

setColorModifier

public void setColorModifier(IltColorModifier modifier)

Sets the color modifier for this chart.

Parameters:

modifier - An IltColorModifier or null for none.

See Also:

IltColorModifier, IltColorModifier.Standard

getColorModifier

public IltColorModifier getColorModifier()

Returns the color modifier for this chart.

getValuesCount

public int getValuesCount()

Returns the number of values that can be represented by this chart.
Note: As a chart decoration is generally created by an IltLimitedNumericState, the value of this state is used as the data to be represented in this chart. The value of this state should therefore be an array of numbers. The appropriate size for this array can be retrieved using this method.