Axis (jmathplot 1.0.1 API)

java.lang.Object
- org.math.plot.plotObjects.Axis

All Implemented Interfaces:

BaseDependant, Editable, Plotable
```
public class Axis
extends Object
implements Plotable, BaseDependant, Editable
```
Class use to describe one of the axis of a plot object. BSD License

Author:

Yann RICHET Changed on 6/13/2014 by Jerry Dietrich Contact info ballooninternet@cox.net

Field Summary

Fields
Modifier and Type	Field and Description
`protected Base`	`base`
`protected Color`	`color` Color in which the name of the axis is displayed.
`protected BaseLabel`	`darkLabel`
`protected double[]`	`darkLabel_base_position`
`protected double`	`darkLabelAngle`
`protected Font`	`darkLabelFont`
`protected BaseLine`	`darkLine`
`protected double[]`	`end`
`protected int`	`index`
`protected String`	`label` Axis label
`protected double[]`	`labelsSlicing`
`protected double`	`lightLabelAngle`
`protected Font`	`lightLabelFont`
`protected String[]`	`lightLabelNames`
`protected Label[]`	`lightLabels`
`protected double`	`lightLabels_base_offset`
`protected Line[][]`	`lightLines`
`protected int`	`linear_slicing`
`protected double[]`	`linesSlicing`
`double`	`log10`
`protected int`	`note_precision`
`protected double[]`	`origin`
`protected HashMap<String,Double>`	`stringMap` Mapping of the data on this axis, which is the association between values along this axis as String and double numbers.

Constructor Summary

Constructors
Constructor and Description

Axis(Base b, String aS, Color c, int i)

Constructors
Constructor and Description
`Axis(Base b, String aS, Color c, int i)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`edit(Object plotCanvas)` Opens a dialog window and asks the user for the name of this axis.
`void`	`editnote(AbstractDrawer draw)`
`Color`	`getColor()` Returns the color of the axis' label.
`String`	`getLegend()` Returns the label of the axis.
`double[]`	`getLegendCoord()` Returns the coordinates of the axis label, in the referential of the canvas it is drawn in.
`HashMap<String,Double>`	`getStringMap()` Returns the mapping of the data on this axis, which is the association between values along this axis as String and double numbers.
`boolean`	`getVisible()` Returns the visibility of the whole axis object.
`void`	`init()` Sets the axis to its default initial value.
`double[]`	`isSelected(int[] screenCoordTest, AbstractDrawer draw)`
`static void`	`main(String[] args)`
`void`	`plot(AbstractDrawer draw)`
`void`	`resetBase()` Resets the axis to its default value.
`void`	`setColor(Color c)` Sets the color used to display the axis' label.
`void`	`setEnd(double[] _end)` Problem here?
`void`	`setGridVisible(boolean v)` Sets the visibility of the light lines and their labels.
`void`	`setLabelAngle(double angle)` Sets the angle with which the label will be displayed.
`void`	`setLabelFont(Font f)` Sets the font used to display the label.
`void`	`setLabelPosition(double... _p)` Sets the position of the axis label on the panel.
`void`	`setLabelText(String _t)` Specifies the label of the axis.
`void`	`setLegend(String _label)` Sets the label of this axis.
`void`	`setLightLabelAngle(double angle)` Sets the angle with which the light labels will be displayed.
`void`	`setLightLabelFont(Font f)` Sets the font used for the light labels.
`void`	`setLightLabels()` When called out of the axis class, resets the light labels to their default value.
`void`	`setLightLabelText(String[] _lightLabelnames)` Sets the labels of the light lines.
`void`	`setOrigin(double[] _origin)`
`void`	`setStringMap(HashMap<String,Double> stringMap)` Returns the mapping of the data on this axis, which is the association between values along this axis as String and double numbers.
`void`	`setVisible(boolean v)` Sets the visibility of the whole axis object.

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

- Field Detail
  - stringMap
```
protected HashMap<String,Double> stringMap
```
    Mapping of the data on this axis, which is the association between values along this axis as String and double numbers.
  - linear_slicing
```
protected int linear_slicing
```
  - note_precision
```
protected int note_precision
```
  - index
```
protected int index
```
  - base
```
protected Base base
```
  - color
```
protected Color color
```
    Color in which the name of the axis is displayed.
  - label
```
protected String label
```
    Axis label
  - linesSlicing
```
protected double[] linesSlicing
```
  - labelsSlicing
```
protected double[] labelsSlicing
```
  - origin
```
protected double[] origin
```
  - end
```
protected double[] end
```
  - darkLine
```
protected BaseLine darkLine
```
  - lightLines
```
protected Line[][] lightLines
```
  - darkLabel
```
protected BaseLabel darkLabel
```
  - lightLabels
```
protected Label[] lightLabels
```
  - lightLabelFont
```
protected Font lightLabelFont
```
  - darkLabelFont
```
protected Font darkLabelFont
```
  - lightLabelAngle
```
protected double lightLabelAngle
```
  - darkLabelAngle
```
protected double darkLabelAngle
```
  - lightLabelNames
```
protected String[] lightLabelNames
```
  - lightLabels_base_offset
```
protected double lightLabels_base_offset
```
  - darkLabel_base_position
```
protected double[] darkLabel_base_position
```
  - log10
```
public final double log10
```
- Constructor Detail
  - Axis
```
public Axis(Base b,
            String aS,
            Color c,
            int i)
```
- Method Detail
  - setVisible
```
public void setVisible(boolean v)
```
    Sets the visibility of the whole axis object.
    
    Specified by:
    
    setVisible in interface Plotable
    
    Parameters:
    
    v - Visible if true.
  - getVisible
```
public boolean getVisible()
```
    Returns the visibility of the whole axis object.
    
    Specified by:
    
    getVisible in interface Plotable
    
    Returns:
    
    Visible if true.
  - getStringMap
```
public HashMap<String,Double> getStringMap()
```
    Returns the mapping of the data on this axis, which is the association between values along this axis as String and double numbers.
    
    Returns:
    
    Mapping of the data on this axis.
  - setStringMap
```
public void setStringMap(HashMap<String,Double> stringMap)
```
    Returns the mapping of the data on this axis, which is the association between values along this axis as String and double numbers.
    
    Parameters:
    
    stringMap - Mapping of the data on this axis.
  - setGridVisible
```
public void setGridVisible(boolean v)
```
    Sets the visibility of the light lines and their labels.
    
    Parameters:
    
    v - Visible if true.
  - setColor
```
public void setColor(Color c)
```
    Sets the color used to display the axis' label.
    
    Specified by:
    
    setColor in interface Plotable
    
    Parameters:
    
    c - The color of the axis' label.
  - getColor
```
public Color getColor()
```
    Returns the color of the axis' label.
    
    Specified by:
    
    getColor in interface Plotable
    
    Returns:
    
    The color of the axis' label.
  - setLegend
```
public void setLegend(String _label)
```
    Sets the label of this axis.
    
    Parameters:
    
    _label - The label to be given to the axis.
  - getLegend
```
public String getLegend()
```
    Returns the label of the axis.
    
    Returns:
    
    The label of the axis.
  - getLegendCoord
```
public double[] getLegendCoord()
```
    Returns the coordinates of the axis label, in the referential of the canvas it is drawn in.
    
    Returns:
    
    An array of double (of length 2 or 3 if the dimension of the canvas is 2D or 3D) containing the coordinates.
  - plot
```
public void plot(AbstractDrawer draw)
```
    Specified by:
    
    plot in interface Plotable
  - init
```
public void init()
```
    Sets the axis to its default initial value.
  - resetBase
```
public void resetBase()
```
    Resets the axis to its default value. Same as init().
    
    Specified by:
    
    resetBase in interface BaseDependant
  - setEnd
```
public void setEnd(double[] _end)
```
    Problem here?
    
    Parameters:
    
    _end -
  - setOrigin
```
public void setOrigin(double[] _origin)
```
  - setLightLabels
```
public void setLightLabels()
```
    When called out of the axis class, resets the light labels to their default value.
  - setLightLabelText
```
public void setLightLabelText(String[] _lightLabelnames)
```
    Sets the labels of the light lines. Is the numerical graduation by default.
    
    Parameters:
    
    _lightLabelnames - Array of string containing the labels. When the end of the array is reached for one tick, the following tick starts with the beginning of the array again.
  - setLightLabelFont
```
public void setLightLabelFont(Font f)
```
    Sets the font used for the light labels.
    
    Parameters:
    
    f - Font to use.
  - setLightLabelAngle
```
public void setLightLabelAngle(double angle)
```
    Sets the angle with which the light labels will be displayed.
    
    Parameters:
    
    angle - Angle in degrees, measured clockwise.
  - setLabelText
```
public void setLabelText(String _t)
```
    Specifies the label of the axis.
    
    Parameters:
    
    _t - Label to add to the axis.
  - setLabelFont
```
public void setLabelFont(Font f)
```
    Sets the font used to display the label.
    
    Parameters:
    
    f - Font to use.
  - setLabelAngle
```
public void setLabelAngle(double angle)
```
    Sets the angle with which the label will be displayed.
    
    Parameters:
    
    angle - Angle in degrees, measured clockwise.
  - setLabelPosition
```
public void setLabelPosition(double... _p)
```
    Sets the position of the axis label on the panel.
    
    Parameters:
    
    _p - Position of the label.
  - edit
```
public void edit(Object plotCanvas)
```
    Opens a dialog window and asks the user for the name of this axis.
    
    Specified by:
    
    edit in interface Editable
    
    Parameters:
    
    plotCanvas - The parent window on which the dialog should be displayed.
  - isSelected
```
public double[] isSelected(int[] screenCoordTest,
                           AbstractDrawer draw)
```
    Specified by:
    
    isSelected in interface Editable
    
    Parameters:
    
    screenCoordTest -
    
    draw -
    
    Returns:
  - editnote
```
public void editnote(AbstractDrawer draw)
```
    Specified by:
    
    editnote in interface Editable
    
    Parameters:
    
    draw -
  - main
```
public static void main(String[] args)
```

Class Axis

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

stringMap

linear_slicing

note_precision

index

base

color

label

linesSlicing

labelsSlicing

origin

end

darkLine

lightLines

darkLabel

lightLabels

lightLabelFont

darkLabelFont

lightLabelAngle

darkLabelAngle

lightLabelNames

lightLabels_base_offset

darkLabel_base_position

log10

Constructor Detail

Axis

Method Detail

setVisible

getVisible

getStringMap

setStringMap

setGridVisible

setColor

getColor

setLegend

getLegend

getLegendCoord

plot

init

resetBase

setEnd

setOrigin

setLightLabels

setLightLabelText

setLightLabelFont

setLightLabelAngle

setLabelText

setLabelFont

setLabelAngle

setLabelPosition

edit

isSelected

editnote

main