IlvAxis (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.chart.IlvAxis

All Implemented Interfaces:

Serializable
```
public class IlvAxis
extends Object
implements Serializable
```
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(int) 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(double, double) method. To toggle the automatic calculation of the data range, use the setAutoDataRange(boolean) 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(boolean) 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(ilog.views.chart.IlvAxisTransformer) method lets you modify the transformer associated with an axis.
- A list of AxisListener objects that are notified whenever the axis changes.
Since:

JViews 5.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface IlvAxis.Crossing
Defines the value where two axes cross each other.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`IlvAxis.Crossing` Defines the value where two axes cross each other.

Field Summary

Fields
Modifier and Type	Field and Description
`static IlvAxis.Crossing`	`MAX_VALUE` Predefined crossing, which specifies that an axis crosses at the maximum visible value of another axis.
`static IlvAxis.Crossing`	`MIN_VALUE` Predefined crossing, which specifies that an axis crosses at the minimum visible value of another axis.
`static int`	`X_AXIS` Type for abscissa axis.
`static int`	`Y_AXIS` Type for ordinate axis.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAxisListener(AxisListener listener)` Adds the specified listener to receive events concerning changes on this axis.
`double`	`getDataMax()` Returns the maximum value of data along this axis.
`double`	`getDataMin()` Returns the minimum value of data along this axis.
`IlvDataInterval`	`getDataRange()` Returns the data range along this axis.
`double`	`getSpecifiedDataMax()` Returns the specified maximum value of data along this axis.
`double`	`getSpecifiedDataMin()` Returns the specified minimum value of data along this axis.
`double`	`getSpecifiedVisibleMax()` Returns the specified maximum value along this axis.
`double`	`getSpecifiedVisibleMin()` Returns the specified minimum value along this axis.
`IlvAxisTransformer`	`getTransformer()` Returns the transformer associated with this axis.
`IlvDataInterval`	`getTVisibleRange()` Returns the visible range shown by this axis, optionally transformed by the associated transformer.
`int`	`getType()` Returns the type of this axis.
`double`	`getVisibleMax()` Returns the maximum visible value along this axis.
`double`	`getVisibleMin()` Returns the minimum visible value along this axis.
`IlvDataInterval`	`getVisibleRange()` Returns the visible range shown by this axis.
`boolean`	`isAdjusting()` Tells whether this axis is in an adjustment state.
`boolean`	`isAutoDataMax()` Tells whether the data range maximum value is automatically computed.
`boolean`	`isAutoDataMin()` Tells whether the data range minimum value is automatically computed.
`boolean`	`isAutoDataRange()` Returns `true` if the data range is computed and updated automatically.
`boolean`	`isAutoVisibleRange()` Tells whether the visible range is synchronized with the data range.
`boolean`	`isBounded()` Tells whether the data range along this axis is specified.
`boolean`	`isReversed()` Indicates whether this axis is reversed.
`boolean`	`isXAxis()` Tells whether this axis is an abscissa axis.
`boolean`	`isYAxis()` Tells whether this axis is an ordinate axis.
`void`	`removeAxisListener(AxisListener listener)` Removes the specified listener.
`void`	`setAdjusting(boolean isAdjusting)` Sets the adjustment state of this axis.
`void`	`setAutoDataMax(boolean auto)` Toggles the automatic calculation of the data range maximum value.
`void`	`setAutoDataMin(boolean auto)` Toggles the automatic calculation of the data range minimum value.
`void`	`setAutoDataRange(boolean auto)` Toggles the automatic calculation of the data range.
`void`	`setAutoVisibleRange(boolean auto)` Toggles the automatic mode of the visible range.
`void`	`setDataMax(double max)` Sets the maximum value of the data range.
`void`	`setDataMin(double min)` Sets the minimum value of the data range.
`void`	`setDataRange(double min, double max)` Sets the data range along this axis.
`void`	`setDataRange(IlvDataInterval range)` Sets the data range along this axis.
`void`	`setReversed(boolean reversed)` Sets the `reversed` property of the axis.
`void`	`setTransformer(IlvAxisTransformer transfo)` Sets the transformer applied to this axis.
`void`	`setVisibleMax(double max)` Sets the maximum visible value along this axis.
`void`	`setVisibleMin(double min)` Sets the minimum visible value along this axis.
`void`	`setVisibleRange(double min, double max)` Sets the visible range along this axis.
`void`	`setVisibleRange(IlvDataInterval range)` Sets the visible range along this axis.
`void`	`synchronizeWith(IlvAxis axis, boolean sync)` Synchronizes this axis with another one.
`String`	`toString()` Returns a string representation of this axis.
`void`	`translateVisibleRange(double delta)` Translates the visible range of the specified value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_VALUE
```
public static final IlvAxis.Crossing MAX_VALUE
```
    Predefined crossing, which specifies that an axis crosses at the maximum visible value of another axis.
  - MIN_VALUE
```
public static final IlvAxis.Crossing MIN_VALUE
```
    Predefined crossing, which specifies that an axis crosses at the minimum visible value of another axis.
  - X_AXIS
```
public static final int X_AXIS
```
    Type for abscissa axis.
    
    See Also:
    
    getType(), Constant Field Values
  - Y_AXIS
```
public static final int Y_AXIS
```
    Type for ordinate axis.
    
    See Also:
    
    getType(), Constant Field Values
- Method Detail
  - isXAxis
```
public final boolean isXAxis()
```
    Tells whether this axis is an abscissa axis.
    
    See Also:
    
    getType()
  - isYAxis
```
public final boolean isYAxis()
```
    Tells whether this axis is an ordinate axis.
    
    See Also:
    
    getType()
  - getType
```
public final int getType()
```
    Returns the type of this axis.
    
    Returns:
    
    X_AXIS if this axis is an abscissa axis, or Y_AXIS if it is an ordinate axis.
  - isReversed
```
public final boolean isReversed()
```
    Indicates whether this axis is reversed.
    
    See Also:
    
    setReversed(boolean)
  - setReversed
```
public void setReversed(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.
  - getDataRange
```
public IlvDataInterval getDataRange()
```
    Returns the data range along this axis. This range can be unspecified (for example unbounded)
    
    See Also:
    
    isBounded()
  - getDataMin
```
public final double getDataMin()
```
    Returns the minimum value of data along this axis.
    
    See Also:
    
    isBounded()
  - getDataMax
```
public final double getDataMax()
```
    Returns the maximum value of data along this axis.
    
    See Also:
    
    isBounded()
  - isBounded
```
public final boolean isBounded()
```
    Tells whether the data range along this axis is specified. The data range is unbounded when one of the following conditions is true:
    - Its minimum value is equal to -Double.MAX_VALUE
    - Its maximum value is equal to Double.MAX_VALUE
    See Also:
    
    isBounded()
  - isAutoDataRange
```
public final boolean isAutoDataRange()
```
    Returns true if the data range is computed and updated automatically.
    
    Since:
    
    JViews 8.1
  - setAutoDataRange
```
public void setAutoDataRange(boolean auto)
```
    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".
  - getSpecifiedDataMin
```
public final double getSpecifiedDataMin()
```
    Returns the specified minimum value of data along this axis.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setDataMin(double)
  - getSpecifiedDataMax
```
public final double getSpecifiedDataMax()
```
    Returns the specified maximum value of data along this axis.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setDataMax(double)
  - isAutoDataMin
```
public final boolean isAutoDataMin()
```
    Tells whether the data range minimum value is automatically computed.
    
    See Also:
    
    setAutoDataMin(boolean), setDataMin(double), setDataRange(double, double)
  - setAutoDataMin
```
public void setAutoDataMin(boolean auto)
```
    Toggles the automatic calculation of the data range minimum value.
  - isAutoDataMax
```
public final boolean isAutoDataMax()
```
    Tells whether the data range maximum value is automatically computed.
    
    See Also:
    
    setAutoDataMax(boolean), setDataMax(double), setDataRange(double, double)
  - setAutoDataMax
```
public void setAutoDataMax(boolean auto)
```
    Toggles the automatic calculation of the data range maximum value.
  - setDataRange
```
public void setDataRange(double min,
                         double max)
```
    Sets the data range along this axis. Calling this method toggles off the automatic calculation of the data range.
    
    See Also:
    
    setAutoDataMin(boolean), setAutoDataMax(boolean)
  - setDataRange
```
public void setDataRange(IlvDataInterval range)
```
    Sets the data range along this axis. Calling this method toggles off the automatic calculation of the data range.
    
    See Also:
    
    setAutoDataMin(boolean), setAutoDataMax(boolean)
  - setDataMin
```
public void setDataMin(double min)
```
    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".
    
    See Also:
    
    setAutoDataMin(boolean), getSpecifiedDataMin()
  - setDataMax
```
public void setDataMax(double max)
```
    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".
    
    See Also:
    
    setAutoDataMax(boolean), getSpecifiedDataMax()
  - getVisibleRange
```
public final IlvDataInterval getVisibleRange()
```
    Returns the visible range shown by this axis.
  - getVisibleMin
```
public final double getVisibleMin()
```
    Returns the minimum visible value along this axis.
  - getVisibleMax
```
public final double getVisibleMax()
```
    Returns the maximum visible value along this axis.
  - getTVisibleRange
```
public IlvDataInterval getTVisibleRange()
```
    Returns the visible range shown by this axis, optionally transformed by the associated transformer.
    
    Returns:
    
    The transformed visible range. If the transformation fails (e.g. a IlvAxisTransformerException is raised), the method returns an empty range.
  - isAutoVisibleRange
```
public final boolean isAutoVisibleRange()
```
    Tells whether the visible range is synchronized with the data range.
  - setAutoVisibleRange
```
public void setAutoVisibleRange(boolean auto)
```
    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".
  - getSpecifiedVisibleMin
```
public final double getSpecifiedVisibleMin()
```
    Returns the specified minimum value along this axis.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setVisibleMin(double)
  - getSpecifiedVisibleMax
```
public final double getSpecifiedVisibleMax()
```
    Returns the specified maximum value along this axis.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setVisibleMax(double)
  - setVisibleRange
```
public void setVisibleRange(double min,
                            double max)
```
    Sets the visible range along this axis. Calling this method toggles off the automatic mode of the visible range.
    
    See Also:
    
    setAutoVisibleRange(boolean)
  - setVisibleRange
```
public void setVisibleRange(IlvDataInterval range)
```
    Sets the visible range along this axis. Calling this method toggles off the automatic mode of the visible range.
    
    See Also:
    
    setAutoVisibleRange(boolean)
  - setVisibleMin
```
public void setVisibleMin(double min)
```
    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".
    
    See Also:
    
    setAutoVisibleRange(boolean), getSpecifiedVisibleMin()
  - setVisibleMax
```
public void setVisibleMax(double max)
```
    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".
    
    See Also:
    
    setAutoVisibleRange(boolean), getSpecifiedVisibleMax()
  - translateVisibleRange
```
public void translateVisibleRange(double delta)
```
    Translates the visible range of the specified value. The delta value is truncated so that the visible range stays within the data range. One of the consequence is that calling this method can lead to a result different from:
```
setVisibleRange(visibleMin+delta, visibleMax+delta)
```
    Indeed, setVisibleRange clips the new visible range against the data range, whereas this method adapts the translation amount before modifying the visible range.
  - getTransformer
```
public final IlvAxisTransformer getTransformer()
```
    Returns the transformer associated with this axis.
  - setTransformer
```
public void setTransformer(IlvAxisTransformer transfo)
```
    Sets the transformer applied to this axis.
  - isAdjusting
```
public final boolean isAdjusting()
```
    Tells whether this axis is in an adjustment state.
    
    See Also:
    
    setAdjusting(boolean)
  - setAdjusting
```
public final void setAdjusting(boolean isAdjusting)
```
    Sets the adjustment state of this axis. The adjustment state is used when firing AxisEvent events. This lets the registered listeners know that the received notifications are part of a set of changes.
    
    See Also:
    
    AxisEvent.isAdjusting()
  - addAxisListener
```
public void addAxisListener(AxisListener listener)
```
    Adds the specified listener to receive events concerning changes on this axis.
  - removeAxisListener
```
public void removeAxisListener(AxisListener listener)
```
    Removes the specified listener.
  - toString
```
public String toString()
```
    Returns a string representation of this axis.
    
    Overrides:
    
    toString in class Object
  - synchronizeWith
```
public void synchronizeWith(IlvAxis axis,
                            boolean sync)
```
    Synchronizes this axis with another one. The two axes thereby synchronize their data range and visible range through notification in both directions.
    Note: This is a different synchronization mechanism than the one used by the IlvChart.synchronizeAxis(IlvChart, int, boolean) method.
    
    Parameters:
    
    axis - The target axis. Each axis will listen for modifications made in the data range or the visible range of the other axis.
    
    sync - Whether the axes are to be synchronized or unsynchronized.
    
    Since:
    
    JViews 5.5

Class IlvAxis

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_VALUE

MIN_VALUE

X_AXIS

Y_AXIS

Method Detail

isXAxis

isYAxis

getType

isReversed

setReversed

getDataRange

getDataMin

getDataMax

isBounded

isAutoDataRange

setAutoDataRange

getSpecifiedDataMin

getSpecifiedDataMax

isAutoDataMin

setAutoDataMin

isAutoDataMax

setAutoDataMax

setDataRange

setDataRange

setDataMin

setDataMax

getVisibleRange

getVisibleMin

getVisibleMax

getTVisibleRange

isAutoVisibleRange

setAutoVisibleRange

getSpecifiedVisibleMin

getSpecifiedVisibleMax

setVisibleRange

setVisibleRange

setVisibleMin

setVisibleMax

translateVisibleRange

getTransformer

setTransformer

isAdjusting

setAdjusting

addAxisListener

removeAxisListener

toString

synchronizeWith