com.jjoe64.graphview

Class DefaultLabelFormatter

java.lang.Object

com.jjoe64.graphview.DefaultLabelFormatter

All Implemented Interfaces:

LabelFormatter

Direct Known Subclasses:

DateAsXAxisLabelFormatter

public class DefaultLabelFormatter
extends java.lang.Object
implements LabelFormatter

The label formatter that will be used by default. It will use the NumberFormat from Android and sets the maximal fraction digits depending on the range between min and max value of the current viewport. It is recommended to use this label formatter as base class to implement a custom formatter.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.text.NumberFormat[]	mNumberFormatter number formatter for x and y values
protected Viewport	mViewport reference to the viewport of the graph.

Constructor Summary

Constructors

Constructor and Description
DefaultLabelFormatter() uses the default number format for the labels
DefaultLabelFormatter(java.text.NumberFormat xFormat, java.text.NumberFormat yFormat) use custom number format

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatLabel(double value, boolean isValueX) Formats the raw value to a nice looking label, depending on the current range of the viewport.
void	setViewport(Viewport viewport) will be called in order to have a reference to the current viewport.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mNumberFormatter

protected java.text.NumberFormat[] mNumberFormatter

number formatter for x and y values

mViewport

protected Viewport mViewport

reference to the viewport of the graph. Will be used to calculate the current range of values.

Constructor Detail

DefaultLabelFormatter

public DefaultLabelFormatter()

uses the default number format for the labels

DefaultLabelFormatter

public DefaultLabelFormatter(java.text.NumberFormat xFormat,
                             java.text.NumberFormat yFormat)

use custom number format

Parameters:

xFormat - the number format for the x labels

yFormat - the number format for the y labels

Method Detail

setViewport

public void setViewport(Viewport viewport)

Description copied from interface: LabelFormatter

will be called in order to have a reference to the current viewport. This is useful if you need the bounds to generate your labels. You store this viewport in as member variable and access it e.g. in the LabelFormatter.formatLabel(double, boolean) method.

Specified by:

setViewport in interface LabelFormatter

Parameters:

viewport - the viewport of the graph

formatLabel

public java.lang.String formatLabel(double value,
                                    boolean isValueX)

Formats the raw value to a nice looking label, depending on the current range of the viewport.

Specified by:

formatLabel in interface LabelFormatter

Parameters:

value - raw value

isValueX - true if it's a x value, otherwise false

Returns:

the formatted value as string