public interface Axis extends AxisDescription, EventSource
| 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 |
| 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() |
add, add, add, clear, contains, getMax, getMin, getName, getUnit, isDefined, set, set, set, set, setMax, setMinaddListener, autoNotification, invokeListener, invokeListener, isAutoNotification, removeListener, updateEventListenerBooleanProperty autoGrowRangingProperty
isAutoGrowRanging(),
setAutoGrowRanging(boolean)BooleanProperty autoRangingProperty
isAutoRanging(),
setAutoRanging(boolean)BooleanProperty autoUnitScalingProperty
isAutoUnitScaling(),
setAutoUnitScaling(boolean)BooleanProperty invertAxisProperty
true when the axis labels and data point order should be invertedDoubleProperty maxProperty
DoubleProperty minProperty
StringProperty nameProperty
setName(String)ObjectProperty<Side> sideProperty
getSide(),
setSide(Side)DoubleProperty tickUnitProperty
getTickUnit(),
setTickUnit(double)BooleanProperty timeAxisProperty
true when the axis labels and data point should be plotted according to some time-axis definitionisTimeAxis(),
setTimeAxis(boolean)ObjectProperty<String> unitProperty
setUnit(String)DoubleProperty unitScalingProperty
getUnitScaling(),
setUnitScaling(double)BooleanProperty autoGrowRangingProperty()
isAutoGrowRanging(),
setAutoGrowRanging(boolean)BooleanProperty autoRangingProperty()
isAutoRanging(),
setAutoRanging(boolean)BooleanProperty autoUnitScalingProperty()
isAutoUnitScaling(),
setAutoUnitScaling(boolean)void drawAxis(GraphicsContext gc, double axisWidth, double axisHeight)
gc - the graphic context on which the axis is to be drawnaxisWidth - the axis width in pixel (N.B. padding is being added)axisHeight - the axis height in pixel (N.B. padding is being added)void forceRedraw()
AxisRange getAutoRange()
AxisTransform getAxisTransform()
double getDisplayPosition(double value)
value - The data value to work out display position fordouble getHeight()
double getLength()
getLength in interface AxisDescriptionLogAxisType getLogAxisType()
int getMinorTickCount()
ObservableList<TickMark> getMinorTickMarks()
AxisRange getRange()
Side getSide()
Paint getTickLabelFill()
Font getTickLabelFont()
StringConverter<Number> getTickLabelFormatter()
double getTickLabelGap()
String getTickMarkLabel(double value)
value - The value to format into a tick label stringObservableList<TickMark> getTickMarks()
double getTickUnit()
double getUnitScaling()
AxisRange getUserRange()
double getValueForDisplay(double displayPosition)
displayPosition - A pixel position on this axisdouble getWidth()
double getZeroPosition()
void invalidateRange(List<Number> data)
data - The current set of all data that needs to be plotted on this axisvoid invertAxis(boolean value)
true when the axis labels and data point order should be invertedvalue - true if axis shall be inverted (i.e. drawn from 'max->min', rather than the normal
'min->max')BooleanProperty invertAxisProperty()
true when the axis labels and data point order should be inverteddefault void invokeListener(UpdateEvent updateEvent, boolean executeParallel)
invokeListener in interface EventSourceupdateEvent - the event the listeners are notified withexecuteParallel - true execute event listener via parallel executor serviceboolean isAutoGrowRanging()
boolean isAutoRanging()
boolean isAutoUnitScaling()
boolean isInvertedAxis()
true when the axis labels and data point order should be invertedtrue if axis shall be inverted (i.e. drawn from 'max->min', rather than the normal
'min->max')boolean isLogAxis()
boolean isTimeAxis()
boolean isValueOnAxis(double value)
value - The value to check if its on axisDoubleProperty maxProperty()
DoubleProperty minProperty()
StringProperty nameProperty()
setName(String)void requestAxisLayout()
void setAnimated(boolean value)
value - true if axis range changes will be animated and false otherwisevoid setAutoGrowRanging(boolean value)
value - true if axis shall be updated to the optimal data range and grows it if necessaryvoid setAutoRanging(boolean value)
value - true if axis shall be updated to the optimal data rangevoid setAutoUnitScaling(boolean value)
value - scaling value true -> scale to the nearest SI unit prefixvoid setName(String value)
value - the new axis primary labelvoid setSide(Side newSide)
void setTickUnit(double tickUnit)
void setTimeAxis(boolean value)
true when the axis labels and data point should be plotted according to some time-axis definitionvalue - true if axis shall be drawn with time-axis labelsvoid setUnit(String value)
value - the new axis primary unit namevoid setUnitScaling(double value)
value - the new axis primary unit labelvoid setUnitScaling(MetricPrefix value)
value - the new axis primary unit labelObjectProperty<Side> sideProperty()
getSide(),
setSide(Side)DoubleProperty tickUnitProperty()
getTickUnit(),
setTickUnit(double)BooleanProperty timeAxisProperty()
true when the axis labels and data point should be plotted according to some time-axis definitionisTimeAxis(),
setTimeAxis(boolean)ObjectProperty<String> unitProperty()
setUnit(String)DoubleProperty unitScalingProperty()
getUnitScaling(),
setUnitScaling(double)Copyright © 2019 GSI Helmholtzzentrum für Schwerionenforschung GmbH. All rights reserved.