Axis (chartfx-chart 8.1.0 API)

All Superinterfaces:

AxisDescription, EventSource

All Known Implementing Classes:

AbstractAxis, AbstractAxisParameter, CategoryAxis, ColorGradientAxis, DefaultNumericAxis, LinearAxis, LogarithmicAxis, NumericAxis
```
public interface Axis
extends AxisDescription, EventSource
```

Property Summary

All Methods Instance Methods Abstract Methods
Type	Property and Description
`BooleanProperty`	`autoGrowRanging` This is true when the axis determines its range from the data automatically
`BooleanProperty`	`autoRanging` This is true when the axis determines its range from the data automatically
`BooleanProperty`	`autoUnitScaling`
`BooleanProperty`	`invertAxis` This is `true` when the axis labels and data point order should be inverted
`DoubleProperty`	`max`
`DoubleProperty`	`min`
`StringProperty`	`name`
`ObjectProperty<Side>`	`side`
`DoubleProperty`	`tickUnit`
`BooleanProperty`	`timeAxis` This is `true` when the axis labels and data point should be plotted according to some time-axis definition
`ObjectProperty<String>`	`unit`
`DoubleProperty`	`unitScaling`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`BooleanProperty`	`autoGrowRangingProperty()` This is true when the axis determines its range from the data automatically
`BooleanProperty`	`autoRangingProperty()` This is true when the axis determines its range from the data automatically
`BooleanProperty`	`autoUnitScalingProperty()`
`void`	`drawAxis(GraphicsContext gc, double axisWidth, double axisHeight)` Function allows custom drawing of axes outside the Axis environment (ie.
`void`	`forceRedraw()` forces redrawing of axis (via layoutChildren()).
`AxisRange`	`getAutoRange()` if available (last) auto-range that has been computed
`AxisTransform`	`getAxisTransform()`
`double`	`getDisplayPosition(double value)` Get the display position along this axis for a given value.
`double`	`getHeight()`
`double`	`getLength()`
`LogAxisType`	`getLogAxisType()`
`int`	`getMinorTickCount()`
`ObservableList<TickMark>`	`getMinorTickMarks()`
`AxisRange`	`getRange()` on auto-ranging this returns getAutoRange(), otherwise the user-specified range getUserRange() (ie.
`Side`	`getSide()`
`Paint`	`getTickLabelFill()`
`Font`	`getTickLabelFont()`
`StringConverter<Number>`	`getTickLabelFormatter()`
`double`	`getTickLabelGap()`
`String`	`getTickMarkLabel(double value)` Get the string label name for a tick mark with the given value
`ObservableList<TickMark>`	`getTickMarks()`
`double`	`getTickUnit()` Gets the value of the property tickUnit.
`double`	`getUnitScaling()`
`AxisRange`	`getUserRange()` user-specified range (ie.
`double`	`getValueForDisplay(double displayPosition)` Get the data value for the given display position on this axis.
`double`	`getWidth()`
`double`	`getZeroPosition()` Get the display position of the zero line along this axis.
`void`	`invalidateRange(List<Number> data)` Called when data has changed and the range may not be valid any more.
`void`	`invertAxis(boolean value)` This is `true` when the axis labels and data point order should be inverted
`BooleanProperty`	`invertAxisProperty()` This is `true` when the axis labels and data point order should be inverted
`default void`	`invokeListener(UpdateEvent updateEvent, boolean executeParallel)` invoke object within update listener list
`boolean`	`isAutoGrowRanging()` This is true when the axis determines its range from the data automatically and grows it if necessary
`boolean`	`isAutoRanging()` This is true when the axis determines its range from the data automatically
`boolean`	`isAutoUnitScaling()`
`boolean`	`isInvertedAxis()` This is `true` when the axis labels and data point order should be inverted
`boolean`	`isLogAxis()` This is true when the axis implements a log scale
`boolean`	`isTimeAxis()` This is true when the axis corresponds to a time axis
`boolean`	`isValueOnAxis(double value)` Checks if the given value is plottable on this axis
`DoubleProperty`	`maxProperty()`
`DoubleProperty`	`minProperty()`
`StringProperty`	`nameProperty()`
`void`	`requestAxisLayout()` Request that the axis is laid out in the next layout pass.
`void`	`setAnimated(boolean value)`
`void`	`setAutoGrowRanging(boolean value)` This is true when the axis determines its range from the data automatically and grows it if necessary
`void`	`setAutoRanging(boolean value)` This is true when the axis determines its range from the data automatically
`void`	`setAutoUnitScaling(boolean value)`
`void`	`setName(String value)`
`void`	`setSide(Side newSide)` Sets the value of the property side.
`void`	`setTickUnit(double tickUnit)` Sets the value of the property tickUnit.
`void`	`setTimeAxis(boolean value)` This is `true` when the axis labels and data point should be plotted according to some time-axis definition
`void`	`setUnit(String value)`
`void`	`setUnitScaling(double value)`
`void`	`setUnitScaling(MetricPrefix value)`
`ObjectProperty<Side>`	`sideProperty()`
`DoubleProperty`	`tickUnitProperty()`
`BooleanProperty`	`timeAxisProperty()` This is `true` when the axis labels and data point should be plotted according to some time-axis definition
`ObjectProperty<String>`	`unitProperty()`
`DoubleProperty`	`unitScalingProperty()`

Methods inherited from interface de.gsi.dataset.AxisDescription
add, add, add, clear, contains, getMax, getMin, getName, getUnit, isDefined, set, set, set, set, setMax, setMin

Methods inherited from interface de.gsi.dataset.event.EventSource
addListener, autoNotification, invokeListener, invokeListener, isAutoNotification, removeListener, updateEventListener

- Property Detail
  - autoGrowRanging
```
BooleanProperty autoGrowRangingProperty
```
    This is true when the axis determines its range from the data automatically
    
    See Also:
    
    isAutoGrowRanging(), setAutoGrowRanging(boolean)
  - autoRanging
```
BooleanProperty autoRangingProperty
```
    This is true when the axis determines its range from the data automatically
    
    See Also:
    
    isAutoRanging(), setAutoRanging(boolean)
  - autoUnitScaling
```
BooleanProperty autoUnitScalingProperty
```
    See Also:
    
    isAutoUnitScaling(), setAutoUnitScaling(boolean)
  - invertAxis
```
BooleanProperty invertAxisProperty
```
    This is true when the axis labels and data point order should be inverted
  - max
```
DoubleProperty maxProperty
```
  - min
```
DoubleProperty minProperty
```
  - name
```
StringProperty nameProperty
```
    See Also:
    
    setName(String)
  - side
```
ObjectProperty<Side> sideProperty
```
    See Also:
    
    getSide(), setSide(Side)
  - tickUnit
```
DoubleProperty tickUnitProperty
```
    See Also:
    
    getTickUnit(), setTickUnit(double)
  - timeAxis
```
BooleanProperty timeAxisProperty
```
    This is true when the axis labels and data point should be plotted according to some time-axis definition
    
    See Also:
    
    isTimeAxis(), setTimeAxis(boolean)
  - unit
```
ObjectProperty<String> unitProperty
```
    See Also:
    
    setUnit(String)
  - unitScaling
```
DoubleProperty unitScalingProperty
```
    See Also:
    
    getUnitScaling(), setUnitScaling(double)
- Method Detail
  - autoGrowRangingProperty
```
BooleanProperty autoGrowRangingProperty()
```
    This is true when the axis determines its range from the data automatically
    
    See Also:
    
    isAutoGrowRanging(), setAutoGrowRanging(boolean)
  - autoRangingProperty
```
BooleanProperty autoRangingProperty()
```
    This is true when the axis determines its range from the data automatically
    
    See Also:
    
    isAutoRanging(), setAutoRanging(boolean)
  - autoUnitScalingProperty
```
BooleanProperty autoUnitScalingProperty()
```
    See Also:
    
    isAutoUnitScaling(), setAutoUnitScaling(boolean)
  - drawAxis
```
void drawAxis(GraphicsContext gc,
              double axisWidth,
              double axisHeight)
```
    Function allows custom drawing of axes outside the Axis environment (ie. on another canvas)
    
    Parameters:
    
    gc - the graphic context on which the axis is to be drawn
    
    axisWidth - the axis width in pixel (N.B. padding is being added)
    
    axisHeight - the axis height in pixel (N.B. padding is being added)
  - forceRedraw
```
void forceRedraw()
```
    forces redrawing of axis (via layoutChildren()). This is used to force an update while the main chart area is being updated (a requestLayout()) would be executed only during the next pulse. This is used explicitly in the Chart class. Outside use of this context should be limited to a minimum... handle with care
  - getAutoRange
```
AxisRange getAutoRange()
```
    if available (last) auto-range that has been computed
    
    Returns:
    
    computed auto-range
  - getAxisTransform
```
AxisTransform getAxisTransform()
```
  - getDisplayPosition
```
double getDisplayPosition(double value)
```
    Get the display position along this axis for a given value. If the value is not in the current range, the returned value will be an extrapolation of the display position. If the value is not valid for this Axis and the axis cannot display such value in any range, Double.NaN is returned
    
    Parameters:
    
    value - The data value to work out display position for
    
    Returns:
    
    display position or Double.NaN if value not valid
  - getHeight
```
double getHeight()
```
  - getLength
```
double getLength()
```
    Specified by:
    
    getLength in interface AxisDescription
    
    Returns:
    
    axis length in pixel
  - getLogAxisType
```
LogAxisType getLogAxisType()
```
    Returns:
    
    given linear and/or logarithmic (+ sub-type, e.g. log10, dB20, ...) axis types
  - getMinorTickCount
```
int getMinorTickCount()
```
  - getMinorTickMarks
```
ObservableList<TickMark> getMinorTickMarks()
```
  - getRange
```
AxisRange getRange()
```
    on auto-ranging this returns getAutoRange(), otherwise the user-specified range getUserRange() (ie. limits based on [lower,upper]Bound)
    
    Returns:
    
    actual range that is being used.
  - getSide
```
Side getSide()
```
    Returns:
    
    the layout side
  - getTickLabelFill
```
Paint getTickLabelFill()
```
    Returns:
    
    the fill for all tick labels
  - getTickLabelFont
```
Font getTickLabelFont()
```
    Returns:
    
    the font for all tick labels
  - getTickLabelFormatter
```
StringConverter<Number> getTickLabelFormatter()
```
  - getTickLabelGap
```
double getTickLabelGap()
```
    Returns:
    
    the gap between tick labels and the tick mark lines
  - getTickMarkLabel
```
String getTickMarkLabel(double value)
```
    Get the string label name for a tick mark with the given value
    
    Parameters:
    
    value - The value to format into a tick label string
    
    Returns:
    
    A formatted string for the given value
  - getTickMarks
```
ObservableList<TickMark> getTickMarks()
```
  - getTickUnit
```
double getTickUnit()
```
    Gets the value of the property tickUnit.
  - getUnitScaling
```
double getUnitScaling()
```
    Returns:
    
    axis primary unit scaling
  - getUserRange
```
AxisRange getUserRange()
```
    user-specified range (ie. limits based on [lower,upper]Bound)
    
    Returns:
    
    user-specified range
  - getValueForDisplay
```
double getValueForDisplay(double displayPosition)
```
    Get the data value for the given display position on this axis. If the axis is a CategoryAxis this will be the nearest value.
    
    Parameters:
    
    displayPosition - A pixel position on this axis
    
    Returns:
    
    the nearest data value to the given pixel position or null if not on axis;
  - getWidth
```
double getWidth()
```
  - getZeroPosition
```
double getZeroPosition()
```
    Get the display position of the zero line along this axis.
    
    Returns:
    
    display position or Double.NaN if zero is not in current range;
  - invalidateRange
```
void invalidateRange(List<Number> data)
```
    Called when data has changed and the range may not be valid any more. This is only called by the chart if isAutoRanging() returns true. If we are auto ranging it will cause layout to be requested and auto ranging to happen on next layout pass.
    
    Parameters:
    
    data - The current set of all data that needs to be plotted on this axis
  - invertAxis
```
void invertAxis(boolean value)
```
    This is true when the axis labels and data point order should be inverted
    
    Parameters:
    
    value - true if axis shall be inverted (i.e. drawn from 'max->min', rather than the normal 'min->max')
  - invertAxisProperty
```
BooleanProperty invertAxisProperty()
```
    This is true when the axis labels and data point order should be inverted
  - invokeListener
```
default void invokeListener(UpdateEvent updateEvent,
                            boolean executeParallel)
```
    invoke object within update listener list
    
    Specified by:
    
    invokeListener in interface EventSource
    
    Parameters:
    
    updateEvent - the event the listeners are notified with
    
    executeParallel - true execute event listener via parallel executor service
  - isAutoGrowRanging
```
boolean isAutoGrowRanging()
```
    This is true when the axis determines its range from the data automatically and grows it if necessary
    
    Returns:
    
    true if axis shall be updated to the optimal data range
  - isAutoRanging
```
boolean isAutoRanging()
```
    This is true when the axis determines its range from the data automatically
    
    Returns:
    
    true if axis shall be updated to the optimal data range
  - isAutoUnitScaling
```
boolean isAutoUnitScaling()
```
    Returns:
    
    whether unit is automatically adjusted to multiples of 1e3 (kilo, mega, ...) or 1e-3 (milli, micro, ...)
  - isInvertedAxis
```
boolean isInvertedAxis()
```
    This is true when the axis labels and data point order should be inverted
    
    Returns:
    
    true if axis shall be inverted (i.e. drawn from 'max->min', rather than the normal 'min->max')
  - isLogAxis
```
boolean isLogAxis()
```
    This is true when the axis implements a log scale
    
    Returns:
    
    true if axis is log scale
  - isTimeAxis
```
boolean isTimeAxis()
```
    This is true when the axis corresponds to a time axis
    
    Returns:
    
    true if axis is a time scale
  - isValueOnAxis
```
boolean isValueOnAxis(double value)
```
    Checks if the given value is plottable on this axis
    
    Parameters:
    
    value - The value to check if its on axis
    
    Returns:
    
    true if the given value is plottable on this axis
  - maxProperty
```
DoubleProperty maxProperty()
```
  - minProperty
```
DoubleProperty minProperty()
```
  - nameProperty
```
StringProperty nameProperty()
```
    See Also:
    
    setName(String)
  - requestAxisLayout
```
void requestAxisLayout()
```
    Request that the axis is laid out in the next layout pass. This replaces requestLayout() as it has been overridden to do nothing so that changes to children's bounds etc do not cause a layout. This was done as a optimisation as the Axis knows the exact minimal set of changes that really need layout to be updated. So we only want to request layout then, not on any child change.
  - setAnimated
```
void setAnimated(boolean value)
```
    Parameters:
    
    value - true if axis range changes will be animated and false otherwise
  - setAutoGrowRanging
```
void setAutoGrowRanging(boolean value)
```
    This is true when the axis determines its range from the data automatically and grows it if necessary
    
    Parameters:
    
    value - true if axis shall be updated to the optimal data range and grows it if necessary
  - setAutoRanging
```
void setAutoRanging(boolean value)
```
    This is true when the axis determines its range from the data automatically
    
    Parameters:
    
    value - true if axis shall be updated to the optimal data range
  - setAutoUnitScaling
```
void setAutoUnitScaling(boolean value)
```
    Parameters:
    
    value - scaling value true -> scale to the nearest SI unit prefix
  - setName
```
void setName(String value)
```
    Parameters:
    
    value - the new axis primary label
  - setSide
```
void setSide(Side newSide)
```
    Sets the value of the property side.
  - setTickUnit
```
void setTickUnit(double tickUnit)
```
    Sets the value of the property tickUnit.
  - setTimeAxis
```
void setTimeAxis(boolean value)
```
    This is true when the axis labels and data point should be plotted according to some time-axis definition
    
    Parameters:
    
    value - true if axis shall be drawn with time-axis labels
  - setUnit
```
void setUnit(String value)
```
    Parameters:
    
    value - the new axis primary unit name
  - setUnitScaling
```
void setUnitScaling(double value)
```
    Parameters:
    
    value - the new axis primary unit label
  - setUnitScaling
```
void setUnitScaling(MetricPrefix value)
```
    Parameters:
    
    value - the new axis primary unit label
  - sideProperty
```
ObjectProperty<Side> sideProperty()
```
    See Also:
    
    getSide(), setSide(Side)
  - tickUnitProperty
```
DoubleProperty tickUnitProperty()
```
    See Also:
    
    getTickUnit(), setTickUnit(double)
  - timeAxisProperty
```
BooleanProperty timeAxisProperty()
```
    This is true when the axis labels and data point should be plotted according to some time-axis definition
    
    See Also:
    
    isTimeAxis(), setTimeAxis(boolean)
  - unitProperty
```
ObjectProperty<String> unitProperty()
```
    See Also:
    
    setUnit(String)
  - unitScalingProperty
```
DoubleProperty unitScalingProperty()
```
    See Also:
    
    getUnitScaling(), setUnitScaling(double)

Interface Axis

Property Summary

Method Summary

Methods inherited from interface de.gsi.dataset.AxisDescription

Methods inherited from interface de.gsi.dataset.event.EventSource

Property Detail

autoGrowRanging

autoRanging

autoUnitScaling

invertAxis

max

min

name

side

tickUnit

timeAxis

unit

unitScaling

Method Detail

autoGrowRangingProperty

autoRangingProperty

autoUnitScalingProperty

drawAxis

forceRedraw

getAutoRange

getAxisTransform

getDisplayPosition

getHeight

getLength

getLogAxisType

getMinorTickCount

getMinorTickMarks

getRange

getSide

getTickLabelFill

getTickLabelFont

getTickLabelFormatter

getTickLabelGap

getTickMarkLabel

getTickMarks

getTickUnit

getUnitScaling

getUserRange

getValueForDisplay

getWidth

getZeroPosition

invalidateRange

invertAxis

invertAxisProperty

invokeListener

isAutoGrowRanging

isAutoRanging

isAutoUnitScaling

isInvertedAxis

isLogAxis

isTimeAxis

isValueOnAxis

maxProperty

minProperty

nameProperty

requestAxisLayout

setAnimated

setAutoGrowRanging

setAutoRanging

setAutoUnitScaling

setName

setSide

setTickUnit

setTimeAxis

setUnit

setUnitScaling

setUnitScaling

sideProperty

tickUnitProperty

timeAxisProperty

unitProperty

unitScalingProperty