Package de.gsi.chart.axes
Interface AxisLabelFormatter
-
- All Known Implementing Classes:
AbstractFormatter,DefaultFormatter,DefaultLogFormatter,DefaultTimeFormatter,SimpleFormatter
public interface AxisLabelFormatter- Author:
- rstein
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.NumberfromString(java.lang.String string)Converts the string provided into an object defined by the specific converter.TickUnitSuppliergetTickUnitSupplier()Returns the value of thetickUnitSupplierProperty().voidsetTickUnitSupplier(TickUnitSupplier supplier)Sets the value of thetickUnitSupplierProperty().javafx.beans.property.ObjectProperty<TickUnitSupplier>tickUnitSupplierProperty()Strategy to compute major tick unit when auto-range is on or when axis bounds change.java.lang.StringtoString(java.lang.Number val)Converts the object provided into its string form.voidupdateFormatter(java.util.List<java.lang.Double> newMajorTickMarks, double unitScaling)Called just before new TickMarks are computed
-
-
-
Method Detail
-
fromString
java.lang.Number fromString(java.lang.String string)
Converts the string provided into an object defined by the specific converter. Format of the string and type of the resulting object is defined by the specific converter.- Parameters:
string- the string to be converted back into a number- Returns:
- an object representation of the string passed in.
-
getTickUnitSupplier
TickUnitSupplier getTickUnitSupplier()
Returns the value of thetickUnitSupplierProperty().- Returns:
- the TickUnitSupplier
-
setTickUnitSupplier
void setTickUnitSupplier(TickUnitSupplier supplier)
Sets the value of thetickUnitSupplierProperty().- Parameters:
supplier- the tick unit supplier. Ifnull, the default one will be used
-
tickUnitSupplierProperty
javafx.beans.property.ObjectProperty<TickUnitSupplier> tickUnitSupplierProperty()
Strategy to compute major tick unit when auto-range is on or when axis bounds change. By default initialised toDefaultTickUnitSupplier.See
TickUnitSupplierfor more information about the expected behaviour of the strategy.- Returns:
- tickUnitSupplier property
-
toString
java.lang.String toString(java.lang.Number val)
Converts the object provided into its string form. Format of the returned string is defined by the specific converter.- Parameters:
val- the number to be converted- Returns:
- a string representation of the object passed in.
-
updateFormatter
void updateFormatter(java.util.List<java.lang.Double> newMajorTickMarks, double unitScaling)Called just before new TickMarks are computed- Parameters:
newMajorTickMarks- for which the labels should be computedunitScaling- scaling applied to the raw data set units
-
-