ilog.views.chart

Class IlvAxis

java.lang.Object

ilog.views.chart.IlvAxis

public class IlvAxis
extends java.lang.Object

Defines a coordinate axis. The IlvAxis instances are created by the IlvChart class for each coordinate axis. These instances can be retrieved using the IlvChart#getXAxis and IlvChart#getYAxis methods. The following figure represents the x- and y-axis of a chart:

An IlvAxis object holds the following information:

• The data range, which specifies the limits of the data values along this axis. This range can be unbounded, which means that the minimum and maximum data are undefined. The data range can be explicitly specified, or automatically computed by the chart according to the data projected along the axis. To explicitly specify the data range, use the #setDataRange method. To toggle the automatic calculation of the data range, use the #setAutoDataRange method.
• The visible range, which specifies the visible data interval along this axis. The axis ensures that the visible range is always contained in the data range; in other words, that it satisfies the following constraint:

   dataMin <= visibleMin <= visibleMax <= dataMax

  The visible range can be synchronized with the data range, using the #setAutoVisibleRange method. In that case, the visible range is updated each time the data range is modified.
• An optional transformation that will be applied to every data value along this axis before they are projected. Transformations are implemented by subclasses of the IlvAxisTransformer class. The #setTransformer method lets you modify the transformer associated with an axis.
• A list of AxisListener objects that are notified whenever the axis changes.

CSS example:

ilvAxis {
class : "ilog.views.chart.IlvAxis";
autoDataRange : "false";
autoVisibleRange : "false";
dataMax : "3.0";
dataMin : "3.0";
reversed : "false";
transformer : "@#ilvAffineAxisTransformer";
visibleMax : "3.0";
visibleMin : "3.0";
}

Property Summary

Properties

Modifier and Type	Property and Description
boolean	autoDataRange Toggles the automatic calculation of the data range.
boolean	autoVisibleRange Toggles the automatic mode of the visible range.
java.lang.String	class Default constructor.
double	dataMax Sets the maximum value of the data range.
double	dataMin Sets the minimum value of the data range.
boolean	reversed Sets the reversed property of the axis.
IlvAxisTransformer	transformer Sets the transformer applied to this axis.
double	visibleMax Sets the maximum visible value along this axis.
double	visibleMin Sets the minimum visible value along this axis.

Method Summary

Methods inherited from class java.lang.Object

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

Property Detail

class

public java.lang.String class

Default constructor.

CSS example: class : "ilog.views.chart.IlvAxis";

autoDataRange

public boolean autoDataRange

Toggles the automatic calculation of the data range.

Note: The bean property "autoDataRange" must not be specified together with the bean properties "dataMin" or "dataMax".

CSS example: autoDataRange : "false";

autoVisibleRange

public boolean autoVisibleRange

Toggles the automatic mode of the visible range. When the automatic mode is enabled, the visible range is synchronized with the data range.

Note: The bean property "autoVisibleRange" must not be specified together with the bean properties "visibleMin" or "visibleMax".

CSS example: autoVisibleRange : "false";

dataMax

public double dataMax

Sets the maximum value of the data range. Calling this method toggles off the automatic calculation of the data range maximum value.

Note: The bean property "dataMin" must not be specified together with the bean property "autoDataRange".

CSS example: dataMax : "3.0";

dataMin

public double dataMin

Sets the minimum value of the data range. Calling this method toggles off the automatic calculation of the data range minimum value.

Note: The bean property "dataMin" must not be specified together with the bean property "autoDataRange".

CSS example: dataMin : "3.0";

reversed

public boolean reversed

Sets the reversed property of the axis. The values along a reversed axis are considered in reverse order. This means for example that the minimum and maximum value will be swapped during data projection.

CSS example: reversed : "false";

transformer

public IlvAxisTransformer transformer

Sets the transformer applied to this axis.

CSS example: transformer : "@#ilvAffineAxisTransformer";

See implementing class IlvAffineAxisTransformer for an example of implementing a transformer.

visibleMax

public double visibleMax

Sets the maximum visible value along this axis. Calling this method toggles off the automatic mode of the visible range.

Note: The bean property "visibleMax" must not be specified together with the bean property "autoVisibleRange".

CSS example: visibleMax : "3.0";

See Also:

autoVisibleRange

visibleMin

public double visibleMin

Sets the minimum visible value along this axis. Calling this method toggles off the automatic mode of the visible range.

Note: The bean property "visibleMin" must not be specified together with the bean property "autoVisibleRange".

CSS example: visibleMin : "3.0";

See Also:

autoVisibleRange