OFC Charts 3.1


com.oxymel.ofc.charts
Class VerticalNumberAxis

java.lang.Object
  |
  +--com.oxymel.ofc.charts.Axis
        |
        +--com.oxymel.ofc.charts.VerticalAxisCommon
              |
              +--com.oxymel.ofc.charts.VerticalAxis
                    |
                    +--com.oxymel.ofc.charts.VerticalNumberAxis

public class VerticalNumberAxis
extends VerticalAxis

This class manages vertical graduated axis. The graduations are numbers and there is a possibility to make the intermediary graduation marks visible, by default they are not.


Field Summary
static int AXIS_POSITION_CENTER
          Axis position "center" indicates that VerticalNumberAxis is positioned at the "0" of the HorizontalNumberAxis (value = 0).
static int AXIS_POSITION_LEFT
          Axis position "left" indicates that VerticalNumberAxis is positioned at the "lowest point" of the HorizontalNumberAxis (value = 1).
static int AXIS_POSITION_RIGHT
          Axis position "right" indicates that VerticalNumberAxis is positioned at the "highest point" of the HorizontalNumberAxis (value = 2).
 
Fields inherited from class com.oxymel.ofc.charts.VerticalAxis
LABEL_POSITION_HORIZONTAL_RIGHT_CENTER, LABEL_POSITION_HORIZONTAL_TOP, LABEL_POSITION_VERTICAL_LEFT_CENTER, LABEL_POSITION_VERTICAL_RIGHT_CENTER, VALUES_WRITE_MODE_HORIZONTAL_ALIGN, VALUES_WRITE_MODE_VERTICAL_ALIGN
 
Constructor Summary
VerticalNumberAxis(java.lang.String label)
          Constructor
 
Method Summary
 int getAxisPosition()
          Retrun the position of the Y axis on the X axis
 void moveValueWithNbPixels(int valueToMove, int nbPixelsOfMove)
          Sets which value to offset, the number of pixels and the direction.
 void setAxisPosition(int axisPosition)
          Sets the position of the Y axis on the X axis : 0 : Center, default value 1 : Left 2 : Right
 void setIntermediaryGapIndicatorVisible(boolean isIntermediaryGapIndicatorVisible)
          Sets the intermediary gap indicator visibility, not visible by default
 void setMinMaxValue(int minValue, int maxValue)
          Sets a given minimum and maximum graduation value for the axis.
 
Methods inherited from class com.oxymel.ofc.charts.VerticalAxis
disableArrow, getLabel, setArrowLength, setFullAxisColor, setLabelPosition, setVisible
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AXIS_POSITION_CENTER

public static int AXIS_POSITION_CENTER
Axis position "center" indicates that VerticalNumberAxis is positioned at the "0" of the HorizontalNumberAxis (value = 0).

AXIS_POSITION_LEFT

public static int AXIS_POSITION_LEFT
Axis position "left" indicates that VerticalNumberAxis is positioned at the "lowest point" of the HorizontalNumberAxis (value = 1).

AXIS_POSITION_RIGHT

public static int AXIS_POSITION_RIGHT
Axis position "right" indicates that VerticalNumberAxis is positioned at the "highest point" of the HorizontalNumberAxis (value = 2).
Constructor Detail

VerticalNumberAxis

public VerticalNumberAxis(java.lang.String label)
Constructor
Parameters:
label - Axis Label
Method Detail

setIntermediaryGapIndicatorVisible

public void setIntermediaryGapIndicatorVisible(boolean isIntermediaryGapIndicatorVisible)
Sets the intermediary gap indicator visibility, not visible by default
Parameters:
isIntermediaryGapIndicatorVisible - If true intermediary gap indicator are visible

setMinMaxValue

public void setMinMaxValue(int minValue,
                           int maxValue)
Sets a given minimum and maximum graduation value for the axis.
These settings are not mandatory, by default the OFC-Charts component computes these values according to the input data, in order to produce a graphic which occupies the maximum of the reserved space.
But sometimes it makes sense to fix the scale in order to produces several graphics, corresponding to different sets of input data, respecting the same scale. In such case -several graphics-, the minimum and maximum can be respectively, the minimum and maximum of all the input data. To get a proper result it is recommended to give the min and max so that none of the input data are out of these bounds.
Parameters:
minValue - minimum value
maxValue - maximum value

setAxisPosition

public void setAxisPosition(int axisPosition)
Sets the position of the Y axis on the X axis :
Parameters:
axisPosition - axis position

getAxisPosition

public int getAxisPosition()
Retrun the position of the Y axis on the X axis

moveValueWithNbPixels

public void moveValueWithNbPixels(int valueToMove,
                                  int nbPixelsOfMove)
Sets which value to offset, the number of pixels and the direction.
Parameters:
valueToMove - value to offset. Can be :
  • NumberAxis.MOVE_ORIGIN_VALUE : to offset the origin of the axis
  • NumberAxis.MOVE_FIRST_VALUE : to offset the lowest value on the axis
  • NumberAxis.MOVE_LAST_VALUE : to offset the highest value on the axis
    nbPixelsOfMove - the number of pixels. The sign specifies the direction of the offset

OFC Charts 3.1


Copyright © 2005 Oxymel SA All Rights Reserved.