com.github.mikephil.charting.formatter

Class DefaultValueFormatter

java.lang.Object

com.github.mikephil.charting.formatter.DefaultValueFormatter

All Implemented Interfaces:

IValueFormatter

public class DefaultValueFormatter
extends java.lang.Object
implements IValueFormatter

Default formatter used for formatting values inside the chart. Uses a DecimalFormat with pre-calculated number of digits (depending on max and min value).

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mDecimalDigits
protected java.text.DecimalFormat	mFormat DecimalFormat for formatting

Constructor Summary

Constructors

Constructor and Description
DefaultValueFormatter(int digits) Constructor that specifies to how many digits the value should be formatted.

Method Summary

Modifier and Type	Method and Description
int	getDecimalDigits() Returns the number of decimal digits this formatter uses.
java.lang.String	getFormattedValue(float value, Entry entry, int dataSetIndex, ViewPortHandler viewPortHandler) Called when a value (from labels inside the chart) is formatted before being drawn.
void	setup(int digits) Sets up the formatter with a given number of decimal digits.

Methods inherited from class java.lang.Object

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

Field Detail

mFormat

protected java.text.DecimalFormat mFormat

DecimalFormat for formatting

mDecimalDigits

protected int mDecimalDigits

Constructor Detail

DefaultValueFormatter

public DefaultValueFormatter(int digits)

Constructor that specifies to how many digits the value should be formatted.

Parameters:

digits -

Method Detail

setup

public void setup(int digits)

Sets up the formatter with a given number of decimal digits.

Parameters:

digits -

getFormattedValue

public java.lang.String getFormattedValue(float value,
                                          Entry entry,
                                          int dataSetIndex,
                                          ViewPortHandler viewPortHandler)

Description copied from interface: IValueFormatter

Called when a value (from labels inside the chart) is formatted before being drawn. For performance reasons, avoid excessive calculations and memory allocations inside this method.

Specified by:

getFormattedValue in interface IValueFormatter

Parameters:

value - the value to be formatted

entry - the entry the value belongs to - in e.g. BarChart, this is of class BarEntry

dataSetIndex - the index of the DataSet the entry in focus belongs to

viewPortHandler - provides information about the current chart state (scale, translation, ...)

Returns:

the formatted label ready for being drawn

getDecimalDigits

public int getDecimalDigits()

Returns the number of decimal digits this formatter uses.

Returns: