Axis

java.lang.Object
- graph.Axis

```
public class Axis
extends Object
```
This class controls the look and feel of axes. It is designed to be used in conjunction with the Graph2D class and DataSet class for plotting 2D graphs. To work with the other classes a system of registration is used. The axes have to be attached to the controlling Graph2D class and the DataSet's have to be attached to both the Graph2D class and the Axis class. This way the 3 main classes Graph2D, Axis and DataSet know of each others existence. This does not mean the classes cannot be used independently, they can but in this mode nothing is automated, the user must code everything manually

Field Summary

Fields
Modifier and Type	Field and Description
`Color`	`axiscolor` Color of the Axis.
`static int`	`BOTTOM` Constant flagging Axis position on the graph.
`Dimension`	`data_window` Before the Axis can be positioned correctly and drawn the data window needs to be calculated and passed to the Axis.
`boolean`	`drawgrid` If true draw a grid positioned on major ticks over the graph
`boolean`	`drawzero` If true draw a line positioned on the Zero label tick mark.
`boolean`	`force_end_labels` Rescale the axis so that labels fall at the end of the Axis.
`Graph2D`	`g2d` The graph canvas this axis is attached to (if it is attached to any)
`Color`	`gridcolor` Color of the grid
`static int`	`LEFT` Constant flagging Axis position on the graph.
`int`	`major_tic_size` Size in pixels of the major tick marks
`double`	`maximum` Maximum data value of the axis.
`double`	`minimum` Minimum data value of the axis.
`int`	`minor_tic_count` Number of minor tick marks between major tick marks
`int`	`minor_tic_size` Size in pixels of the minor tick marks
`boolean`	`redraw` Default value true.
`static int`	`RIGHT` Constant flagging Axis position on the graph.
`static int`	`TOP` Constant flagging Axis position on the graph.
`Color`	`zerocolor` Color of the line at the Zero label

Constructor Summary

Constructors
Constructor and Description

Axis()
Instantiate the class.

Axis(int p)
Instantiate the class.

Constructors
Constructor and Description
`Axis()` Instantiate the class.
`Axis(int p)` Instantiate the class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`attachDataSet(DataSet d)` Attach a DataSet for the Axis to manage.
`void`	`detachAll()` Detach All attached dataSets.
`void`	`detachDataSet(DataSet d)` Detach an attached DataSet
`void`	`drawAxis(org.freehep.graphics2d.VectorGraphics g)` Draw the axis using the passed Graphics context.
`int`	`getAxisPos()` Return the position of the Axis.
`int`	`getAxisWidth(org.freehep.graphics2d.VectorGraphics g)` Return the width of the axis.
`double`	`getDataMax()` Return the maximum value of All datasets attached to the axis.
`double`	`getDataMin()` Return the minimum value of All datasets attached to the axis.
`double`	`getDouble(int i)` Return the data value equivalent of the passed pixel position.
`int`	`getInteger(double v)` Return the pixel equivalent of the passed data value.
`boolean`	`isVertical()` If the Axis is Vertical return true.
`boolean`	`positionAxis(int xmin, int xmax, int ymin, int ymax)` Position the axis at the passed coordinates.
`void`	`resetRange()` Reset the range of the axis (the minimum and maximum values) to the default data values.
`void`	`setExponentColor(Color c)` Set the color of the exponent
`void`	`setExponentFont(Font f)` Set the font of the exponent
`void`	`setLabelColor(Color c)` Set the color of the labels
`void`	`setLabelFont(Font f)` Set the font of the labels.
`void`	`setManualRange(boolean b)` Is the range of the axis to be set automatically (based on the data) or manually by setting the values Axis.minimum and Axis.maximum?
`void`	`setPosition(int p)` Set the axis position.
`void`	`setTitleColor(Color c)` Set the color of the title
`void`	`setTitleFont(Font f)` Set the font of the title
`void`	`setTitleRotation(int a)` Set the title rotation angle.
`void`	`setTitleText(String s)` Set the title of the axis

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

- Field Detail
  - LEFT
```
public static final int LEFT
```
    Constant flagging Axis position on the graph. Left side => Vertical
    
    See Also:
    
    Constant Field Values
  - RIGHT
```
public static final int RIGHT
```
    Constant flagging Axis position on the graph. Right side => Vertical
    
    See Also:
    
    Constant Field Values
  - TOP
```
public static final int TOP
```
    Constant flagging Axis position on the graph. Top side => Horizontal
    
    See Also:
    
    Constant Field Values
  - BOTTOM
```
public static final int BOTTOM
```
    Constant flagging Axis position on the graph. Bottom side => Horizontal
    
    See Also:
    
    Constant Field Values
  - drawgrid
```
public boolean drawgrid
```
    If true draw a grid positioned on major ticks over the graph
  - drawzero
```
public boolean drawzero
```
    If true draw a line positioned on the Zero label tick mark.
  - gridcolor
```
public Color gridcolor
```
    Color of the grid
  - zerocolor
```
public Color zerocolor
```
    Color of the line at the Zero label
  - redraw
```
public boolean redraw
```
    Default value true. Normally never changed. If set false the Axis draw method exits without drawing the axis.
    
    See Also:
    
    Axis#drawAxis()
  - force_end_labels
```
public boolean force_end_labels
```
    Rescale the axis so that labels fall at the end of the Axis. Default value false.
  - major_tic_size
```
public int major_tic_size
```
    Size in pixels of the major tick marks
  - minor_tic_size
```
public int minor_tic_size
```
    Size in pixels of the minor tick marks
  - minor_tic_count
```
public int minor_tic_count
```
    Number of minor tick marks between major tick marks
  - axiscolor
```
public Color axiscolor
```
    Color of the Axis.
  - minimum
```
public double minimum
```
    Minimum data value of the axis. This is the value used to scale data into the data window. This is the value to alter to force a rescaling of the data window.
  - maximum
```
public double maximum
```
    Maximum data value of the axis. This is the value used to scale data into the data window. This is the value to alter to force a rescaling of the data window.
  - data_window
```
public Dimension data_window
```
    Before the Axis can be positioned correctly and drawn the data window needs to be calculated and passed to the Axis.
  - g2d
```
public Graph2D g2d
```
    The graph canvas this axis is attached to (if it is attached to any)
    
    See Also:
    
    Graph2D
- Constructor Detail
  - Axis
```
public Axis()
```
    Instantiate the class. The defalt type is a Horizontal axis positioned at the bottom of the graph.
  - Axis
```
public Axis(int p)
```
    Instantiate the class. Setting the position.
    
    Parameters:
    
    p - Set the axis position. Must be one of Axis.BOTTOM, Axis.TOP, Axis.LEFT, Axis.RIGHT, Axis.HORIZONTAL or Axis.VERTICAL. If one of the latter two are used then Axis.BOTTOM or Axis.LEFT is assumed.
- Method Detail
  - setPosition
```
public void setPosition(int p)
```
    Set the axis position.
    
    Parameters:
    
    p - Must be one of Axis.BOTTOM, Axis.TOP, Axis.LEFT, Axis.RIGHT, Axis.HORIZONTAL or Axis.VERTICAL. If one of the latter two are used then Axis.BOTTOM or Axis.LEFT is assumed.
  - attachDataSet
```
public void attachDataSet(DataSet d)
```
    Attach a DataSet for the Axis to manage.
    
    Parameters:
    
    d - dataSet to attach
    
    See Also:
    
    DataSet
  - detachDataSet
```
public void detachDataSet(DataSet d)
```
    Detach an attached DataSet
    
    Parameters:
    
    d - dataSet to detach
    
    See Also:
    
    DataSet
  - detachAll
```
public void detachAll()
```
    Detach All attached dataSets.
  - getDataMin
```
public double getDataMin()
```
    Return the minimum value of All datasets attached to the axis.
    
    Returns:
    
    Data minimum
  - getDataMax
```
public double getDataMax()
```
    Return the maximum value of All datasets attached to the axis.
    
    Returns:
    
    Data maximum
  - getInteger
```
public int getInteger(double v)
```
    Return the pixel equivalent of the passed data value. Using the position of the axis and the maximum and minimum values convert the data value into a pixel value
    
    Parameters:
    
    v - data value to convert
    
    Returns:
    
    equivalent pixel value
    
    See Also:
    
    graph.Axis#getDouble( )
  - getDouble
```
public double getDouble(int i)
```
    Return the data value equivalent of the passed pixel position. Using the position of the axis and the maximum and minimum values convert the pixel position into a data value
    
    Parameters:
    
    i - pixel value
    
    Returns:
    
    equivalent data value
    
    See Also:
    
    graph.Axis#getInteger( )
  - resetRange
```
public void resetRange()
```
    Reset the range of the axis (the minimum and maximum values) to the default data values.
  - getAxisPos
```
public int getAxisPos()
```
    Return the position of the Axis.
    
    Returns:
    
    One of Axis.LEFT, Axis.RIGHT, Axis.TOP, or Axis.BOTTOM.
  - isVertical
```
public boolean isVertical()
```
    If the Axis is Vertical return true.
  - getAxisWidth
```
public int getAxisWidth(org.freehep.graphics2d.VectorGraphics g)
```
    Return the width of the axis.
    
    Parameters:
    
    g - graphics context.
  - positionAxis
```
public boolean positionAxis(int xmin,
                            int xmax,
                            int ymin,
                            int ymax)
```
    Position the axis at the passed coordinates. The coordinates should match the type of axis.
    
    Parameters:
    
    xmin - The minimum X pixel
    
    xmax - The maximum X pixel. These should be equal if the axis is vertical
    
    ymin - The minimum Y pixel
    
    ymax - The maximum Y pixel. These should be equal if the axis is horizontal
    
    Returns:
    
    true if there are no inconsistencies.
  - drawAxis
```
public void drawAxis(org.freehep.graphics2d.VectorGraphics g)
```
    Draw the axis using the passed Graphics context.
    
    Parameters:
    
    g - Graphics context for drawing
  - setTitleText
```
public void setTitleText(String s)
```
    Set the title of the axis
    
    Parameters:
    
    s - string containing text.
  - setTitleColor
```
public void setTitleColor(Color c)
```
    Set the color of the title
    
    Parameters:
    
    c - Color of the title.
  - setTitleFont
```
public void setTitleFont(Font f)
```
    Set the font of the title
    
    Parameters:
    
    c - Title font.
  - setTitleRotation
```
public void setTitleRotation(int a)
```
    Set the title rotation angle. Only multiples of 90 degrees allowed.
    
    Parameters:
    
    a - Title rotation angle in degrees.
  - setLabelColor
```
public void setLabelColor(Color c)
```
    Set the color of the labels
    
    Parameters:
    
    c - Color of the labels.
  - setLabelFont
```
public void setLabelFont(Font f)
```
    Set the font of the labels.
    
    Parameters:
    
    f - font.
  - setExponentColor
```
public void setExponentColor(Color c)
```
    Set the color of the exponent
    
    Parameters:
    
    c - Color.
  - setExponentFont
```
public void setExponentFont(Font f)
```
    Set the font of the exponent
    
    Parameters:
    
    f - font.
  - setManualRange
```
public void setManualRange(boolean b)
```
    Is the range of the axis to be set automatically (based on the data) or manually by setting the values Axis.minimum and Axis.maximum?
    
    Parameters:
    
    b - boolean value.

Class Axis

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEFT

RIGHT

TOP

BOTTOM

drawgrid

drawzero

gridcolor

zerocolor

redraw

force_end_labels

major_tic_size

minor_tic_size

minor_tic_count

axiscolor

minimum

maximum

data_window

g2d

Constructor Detail

Axis

Axis

Method Detail

setPosition

attachDataSet

detachDataSet

detachAll

getDataMin

getDataMax

getInteger

getDouble

resetRange

getAxisPos

isVertical

getAxisWidth

positionAxis

drawAxis

setTitleText

setTitleColor

setTitleFont

setTitleRotation

setLabelColor

setLabelFont

setExponentColor

setExponentFont

setManualRange