de.gsi.chart.axes

Interface AxisLabelFormatter

All Known Implementing Classes:

AbstractFormatter, DefaultFormatter, DefaultLogFormatter, DefaultTimeFormatter, SimpleFormatter

public interface AxisLabelFormatter

Author:

rstein

Property Summary

Type	Property and Description
ObjectProperty<TickUnitSupplier>	tickUnitSupplier Strategy to compute major tick unit when auto-range is on or when axis bounds change.

Method Summary

Modifier and Type	Method and Description
Number	fromString(String string) Converts the string provided into an object defined by the specific converter.
TickUnitSupplier	getTickUnitSupplier() Returns the value of the tickUnitSupplierProperty().
void	setTickUnitSupplier(TickUnitSupplier supplier) Sets the value of the tickUnitSupplierProperty().
ObjectProperty<TickUnitSupplier>	tickUnitSupplierProperty() Strategy to compute major tick unit when auto-range is on or when axis bounds change.
String	toString(Number val) Converts the object provided into its string form.
void	updateFormatter(List<Double> newMajorTickMarks, double unitScaling) Called just before new TickMarks are computed

Property Detail

tickUnitSupplier

ObjectProperty<TickUnitSupplier> tickUnitSupplierProperty

Strategy to compute major tick unit when auto-range is on or when axis bounds change. By default initialised to DefaultTickUnitSupplier.

See TickUnitSupplier for more information about the expected behaviour of the strategy.

See Also:

getTickUnitSupplier(), setTickUnitSupplier(TickUnitSupplier)

Method Detail

fromString

Number fromString(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 the tickUnitSupplierProperty().

Returns:

the TickUnitSupplier

setTickUnitSupplier

void setTickUnitSupplier(TickUnitSupplier supplier)

Sets the value of the tickUnitSupplierProperty().

Parameters:

supplier - the tick unit supplier. If null, the default one will be used

tickUnitSupplierProperty

ObjectProperty<TickUnitSupplier> tickUnitSupplierProperty()

Strategy to compute major tick unit when auto-range is on or when axis bounds change. By default initialised to DefaultTickUnitSupplier.

See TickUnitSupplier for more information about the expected behaviour of the strategy.

See Also:

getTickUnitSupplier(), setTickUnitSupplier(TickUnitSupplier)

toString

String toString(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(List<Double> newMajorTickMarks,
                     double unitScaling)

Called just before new TickMarks are computed

Parameters:

newMajorTickMarks - for which the labels should be computed

unitScaling - scaling applied to the raw data set units