com.github.mikephil.charting.formatter

Class StackedValueFormatter

java.lang.Object

com.github.mikephil.charting.formatter.StackedValueFormatter

All Implemented Interfaces:

IValueFormatter

public class StackedValueFormatter
extends java.lang.Object
implements IValueFormatter

Created by Philipp Jahoda on 28/01/16.

A formatter specifically for stacked BarChart that allows to specify whether the all stack values or just the top value should be drawn.

Constructor Summary

Constructors

Constructor and Description
StackedValueFormatter(boolean drawWholeStack, java.lang.String appendix, int decimals) Constructor.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

StackedValueFormatter

public StackedValueFormatter(boolean drawWholeStack,
                             java.lang.String appendix,
                             int decimals)

Constructor.

Parameters:

drawWholeStack - if true, all stack values of the stacked bar entry are drawn, else only top

appendix - a string that should be appended behind the value

decimals - the number of decimal digits to use

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