com.jjoe64.graphview.helper

Class StaticLabelsFormatter

java.lang.Object

com.jjoe64.graphview.helper.StaticLabelsFormatter

All Implemented Interfaces:

LabelFormatter

public class StaticLabelsFormatter
extends java.lang.Object
implements LabelFormatter

Use this label formatter to show static labels. Static labels are not bound to the data. It is typical used for show text like "low", "middle", "high". You can set the static labels for vertical or horizontal individually and you can define a label formatter that is to be used if you don't define static labels. For example if you only use static labels for horizontal labels, graphview will use the dynamicLabelFormatter for the vertical labels.

Field Summary

Fields

Modifier and Type	Field and Description
protected LabelFormatter	mDynamicLabelFormatter the label formatter that will format the labels for that there are no static labels defined.
protected GraphView	mGraphView reference to the graphview
protected java.lang.String[]	mHorizontalLabels the horizontal labels, ordered form the left to the right if it is null, the labels will be generated via the #dynamicLabelFormatter
protected java.lang.String[]	mVerticalLabels the vertical labels, ordered from bottom to the top if it is null, the labels will be generated via the #dynamicLabelFormatter
protected Viewport	mViewport reference to the viewport

Constructor Summary

Constructors

Constructor and Description
StaticLabelsFormatter(GraphView graphView) creates the formatter without any static labels define your static labels via setHorizontalLabels(String[]) and setVerticalLabels(String[])
StaticLabelsFormatter(GraphView graphView, LabelFormatter dynamicLabelFormatter) creates the formatter without any static labels.
StaticLabelsFormatter(GraphView graphView, java.lang.String[] horizontalLabels, java.lang.String[] verticalLabels) creates the formatter with static labels defined.
StaticLabelsFormatter(GraphView graphView, java.lang.String[] horizontalLabels, java.lang.String[] verticalLabels, LabelFormatter dynamicLabelFormatter) creates the formatter with static labels defined.

Method Summary

Modifier and Type	Method and Description
protected void	adjust() adjusts the number of vertical/horizontal labels
java.lang.String	formatLabel(double value, boolean isValueX) converts a raw number as input to a formatted string for the label.
protected void	init(java.lang.String[] horizontalLabels, java.lang.String[] verticalLabels, LabelFormatter dynamicLabelFormatter)
void	setDynamicLabelFormatter(LabelFormatter dynamicLabelFormatter) Set a label formatter that will be used for the labels that don't have static labels.
void	setHorizontalLabels(java.lang.String[] horizontalLabels)
void	setVerticalLabels(java.lang.String[] verticalLabels)
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

mViewport

protected Viewport mViewport

reference to the viewport

mVerticalLabels

protected java.lang.String[] mVerticalLabels

the vertical labels, ordered from bottom to the top if it is null, the labels will be generated via the #dynamicLabelFormatter

mHorizontalLabels

protected java.lang.String[] mHorizontalLabels

the horizontal labels, ordered form the left to the right if it is null, the labels will be generated via the #dynamicLabelFormatter

mDynamicLabelFormatter

protected LabelFormatter mDynamicLabelFormatter

the label formatter that will format the labels for that there are no static labels defined.

mGraphView

protected final GraphView mGraphView

reference to the graphview

Constructor Detail

StaticLabelsFormatter

public StaticLabelsFormatter(GraphView graphView)

creates the formatter without any static labels define your static labels via setHorizontalLabels(String[]) and setVerticalLabels(String[])

Parameters:

graphView - reference to the graphview

StaticLabelsFormatter

public StaticLabelsFormatter(GraphView graphView,
                             LabelFormatter dynamicLabelFormatter)

creates the formatter without any static labels. define your static labels via setHorizontalLabels(String[]) and setVerticalLabels(String[])

Parameters:

graphView - reference to the graphview

dynamicLabelFormatter - the label formatter that will format the labels for that there are no static labels defined.

StaticLabelsFormatter

public StaticLabelsFormatter(GraphView graphView,
                             java.lang.String[] horizontalLabels,
                             java.lang.String[] verticalLabels)

creates the formatter with static labels defined.

Parameters:

graphView - reference to the graphview

horizontalLabels - the horizontal labels, ordered form the left to the right if it is null, the labels will be generated via the #dynamicLabelFormatter

verticalLabels - the vertical labels, ordered from bottom to the top if it is null, the labels will be generated via the #dynamicLabelFormatter

StaticLabelsFormatter

public StaticLabelsFormatter(GraphView graphView,
                             java.lang.String[] horizontalLabels,
                             java.lang.String[] verticalLabels,
                             LabelFormatter dynamicLabelFormatter)

creates the formatter with static labels defined.

Parameters:

graphView - reference to the graphview

horizontalLabels - the horizontal labels, ordered form the left to the right if it is null, the labels will be generated via the #dynamicLabelFormatter

verticalLabels - the vertical labels, ordered from bottom to the top if it is null, the labels will be generated via the #dynamicLabelFormatter

dynamicLabelFormatter - the label formatter that will format the labels for that there are no static labels defined.

Method Detail

init

protected void init(java.lang.String[] horizontalLabels,
                    java.lang.String[] verticalLabels,
                    LabelFormatter dynamicLabelFormatter)

Parameters:

horizontalLabels - the horizontal labels, ordered form the left to the right if it is null, the labels will be generated via the #dynamicLabelFormatter

verticalLabels - the vertical labels, ordered from bottom to the top if it is null, the labels will be generated via the #dynamicLabelFormatter

dynamicLabelFormatter - the label formatter that will format the labels for that there are no static labels defined.

setDynamicLabelFormatter

public void setDynamicLabelFormatter(LabelFormatter dynamicLabelFormatter)

Set a label formatter that will be used for the labels that don't have static labels. For example if you only use static labels for horizontal labels, graphview will use the dynamicLabelFormatter for the vertical labels.

Parameters:

dynamicLabelFormatter - the label formatter that will format the labels for that there are no static labels defined.

setHorizontalLabels

public void setHorizontalLabels(java.lang.String[] horizontalLabels)

Parameters:

horizontalLabels - the horizontal labels, ordered form the left to the right if it is null, the labels will be generated via the #dynamicLabelFormatter

setVerticalLabels

public void setVerticalLabels(java.lang.String[] verticalLabels)

Parameters:

verticalLabels - the vertical labels, ordered from bottom to the top if it is null, the labels will be generated via the #dynamicLabelFormatter

formatLabel

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

Description copied from interface: LabelFormatter

converts a raw number as input to a formatted string for the label.

Specified by:

formatLabel in interface LabelFormatter

Parameters:

value - raw input number

isValueX - true if it is a value for the x axis false if it is a value for the y axis

Returns:

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 used viewport

adjust

protected void adjust()

adjusts the number of vertical/horizontal labels