com.github.mikephil.charting.formatter

Class LargeValueFormatter

java.lang.Object

com.github.mikephil.charting.formatter.LargeValueFormatter

All Implemented Interfaces:

IAxisValueFormatter, IValueFormatter

public class LargeValueFormatter
extends java.lang.Object
implements IValueFormatter, IAxisValueFormatter

Predefined value-formatter that formats large numbers in a pretty way. Outputs: 856 = 856; 1000 = 1k; 5821 = 5.8k; 10500 = 10k; 101800 = 102k; 2000000 = 2m; 7800000 = 7.8m; 92150000 = 92m; 123200000 = 123m; 9999999 = 10m; 1000000000 = 1b; Special thanks to Roman Gromov (https://github.com/romangromov) for this piece of code.

Constructor Summary

Constructors

Constructor and Description
LargeValueFormatter()
LargeValueFormatter(java.lang.String appendix) Creates a formatter that appends a specified text to the result string

Method Summary

Modifier and Type	Method and Description
int	getDecimalDigits()
java.lang.String	getFormattedValue(float value, AxisBase axis) Called when a value from an axis is to be formatted before being drawn.
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	setAppendix(java.lang.String appendix) Set an appendix text to be added at the end of the formatted value.
void	setMaxLength(int maxLength)
void	setSuffix(java.lang.String[] suffix) Set custom suffix to be appended after the values.

Methods inherited from class java.lang.Object

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

Constructor Detail

LargeValueFormatter

public LargeValueFormatter()

LargeValueFormatter

public LargeValueFormatter(java.lang.String appendix)

Creates a formatter that appends a specified text to the result string

Parameters:

appendix - a text that will be appended

Method Detail

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

getFormattedValue

public java.lang.String getFormattedValue(float value,
                                          AxisBase axis)

Description copied from interface: IAxisValueFormatter

Called when a value from an axis is to be formatted before being drawn. For performance reasons, avoid excessive calculations and memory allocations inside this method.

Specified by:

getFormattedValue in interface IAxisValueFormatter

Parameters:

value - the value to be formatted

axis - the axis the value belongs to

Returns:

setAppendix

public void setAppendix(java.lang.String appendix)

Set an appendix text to be added at the end of the formatted value.

Parameters:

appendix -

setSuffix

public void setSuffix(java.lang.String[] suffix)

Set custom suffix to be appended after the values. Default suffix: ["", "k", "m", "b", "t"]

Parameters:

suffix - new suffix

setMaxLength

public void setMaxLength(int maxLength)

getDecimalDigits

public int getDecimalDigits()