com.github.mikephil.charting.formatter

Class ValueFormatter

java.lang.Object

com.github.mikephil.charting.formatter.ValueFormatter

All Implemented Interfaces:

IAxisValueFormatter, IValueFormatter

Direct Known Subclasses:

DefaultAxisValueFormatter, DefaultValueFormatter, IndexAxisValueFormatter, LargeValueFormatter, PercentFormatter, StackedValueFormatter

public abstract class ValueFormatter
extends java.lang.Object
implements IAxisValueFormatter, IValueFormatter

Class to format all values before they are drawn as labels.

Constructor Summary

Constructors

Constructor and Description
ValueFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAxisLabel(float value, AxisBase axis) Used to draw axis labels, calls getFormattedValue(float) by default.
java.lang.String	getBarLabel(BarEntry barEntry) Used to draw bar labels, calls getFormattedValue(float) by default.
java.lang.String	getBarStackedLabel(float value, BarEntry stackedEntry) Used to draw stacked bar labels, calls getFormattedValue(float) by default.
java.lang.String	getBubbleLabel(BubbleEntry bubbleEntry) Used to draw bubble size labels, calls getFormattedValue(float) by default.
java.lang.String	getCandleLabel(CandleEntry candleEntry) Used to draw high labels, calls getFormattedValue(float) by default.
java.lang.String	getFormattedValue(float value) Called when drawing any label, used to change numbers into formatted strings.
java.lang.String	getFormattedValue(float value, AxisBase axis) Deprecated.
java.lang.String	getFormattedValue(float value, Entry entry, int dataSetIndex, ViewPortHandler viewPortHandler) Deprecated.
java.lang.String	getPieLabel(float value, PieEntry pieEntry) Used to draw pie value labels, calls getFormattedValue(float) by default.
java.lang.String	getPointLabel(Entry entry) Used to draw line and scatter labels, calls getFormattedValue(float) by default.
java.lang.String	getRadarLabel(RadarEntry radarEntry) Used to draw radar value labels, calls getFormattedValue(float) by default.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueFormatter

public ValueFormatter()

Method Detail

getFormattedValue

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

Deprecated.

DO NOT USE, only for backwards compatibility and will be removed in future versions.

Specified by:

getFormattedValue in interface IAxisValueFormatter

Parameters:

value - the value to be formatted

axis - the axis the value belongs to

Returns:

formatted string label

getFormattedValue

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

Deprecated.

DO NOT USE, only for backwards compatibility and will be removed in future versions.

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:

formatted string label

getFormattedValue

public java.lang.String getFormattedValue(float value)

Called when drawing any label, used to change numbers into formatted strings.

Parameters:

value - float to be formatted

Returns:

formatted string label

getAxisLabel

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

Used to draw axis labels, calls getFormattedValue(float) by default.

Parameters:

value - float to be formatted

axis - axis being labeled

Returns:

formatted string label

getBarLabel

public java.lang.String getBarLabel(BarEntry barEntry)

Used to draw bar labels, calls getFormattedValue(float) by default.

Parameters:

barEntry - bar being labeled

Returns:

formatted string label

getBarStackedLabel

public java.lang.String getBarStackedLabel(float value,
                                           BarEntry stackedEntry)

Used to draw stacked bar labels, calls getFormattedValue(float) by default.

Parameters:

value - current value to be formatted

stackedEntry - stacked entry being labeled, contains all Y values

Returns:

formatted string label

getPointLabel

public java.lang.String getPointLabel(Entry entry)

Used to draw line and scatter labels, calls getFormattedValue(float) by default.

Parameters:

entry - point being labeled, contains X value

Returns:

formatted string label

getPieLabel

public java.lang.String getPieLabel(float value,
                                    PieEntry pieEntry)

Used to draw pie value labels, calls getFormattedValue(float) by default.

Parameters:

value - float to be formatted, may have been converted to percentage

pieEntry - slice being labeled, contains original, non-percentage Y value

Returns:

formatted string label

getRadarLabel

public java.lang.String getRadarLabel(RadarEntry radarEntry)

Used to draw radar value labels, calls getFormattedValue(float) by default.

Parameters:

radarEntry - entry being labeled

Returns:

formatted string label

getBubbleLabel

public java.lang.String getBubbleLabel(BubbleEntry bubbleEntry)

Used to draw bubble size labels, calls getFormattedValue(float) by default.

Parameters:

bubbleEntry - bubble being labeled, also contains X and Y values

Returns:

formatted string label

getCandleLabel

public java.lang.String getCandleLabel(CandleEntry candleEntry)

Used to draw high labels, calls getFormattedValue(float) by default.

Parameters:

candleEntry - candlestick being labeled

Returns:

formatted string label