com.github.mikephil.charting.components

Class AxisBase

java.lang.Object

com.github.mikephil.charting.components.ComponentBase

com.github.mikephil.charting.components.AxisBase

Direct Known Subclasses:

XAxis, YAxis

public abstract class AxisBase
extends ComponentBase

Base-class of all axes (previously called labels).

Field Summary

Fields

Modifier and Type	Field and Description
float	mAxisMaximum don't touch this direclty, use setter
float	mAxisMinimum don't touch this directly, use setter
float	mAxisRange the total range of values this axis covers
protected boolean	mCustomAxisMax flag indicating that the axis-max value has been customized
protected boolean	mCustomAxisMin flag indicating that the axis-min value has been customized
protected boolean	mDrawAxisLine flag that indicates if the line alongside the axis is drawn or not
protected boolean	mDrawGridLines flag indicating if the grid lines for this axis should be drawn
protected boolean	mDrawLabels flag that indicates of the labels of this axis should be drawn or not
protected boolean	mDrawLimitLineBehindData flag indicating the limit lines layer depth
protected java.util.List<LimitLine>	mLimitLines array of limit lines that can be set for the axis

Fields inherited from class com.github.mikephil.charting.components.ComponentBase

mEnabled, mTextColor, mTextSize, mTypeface, mXOffset, mYOffset

Constructor Summary

Constructors

Constructor and Description
AxisBase() default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addLimitLine(LimitLine l) Adds a new LimitLine to this axis.
void	disableGridDashedLine() Disables the grid line to be drawn in dashed mode.
void	enableGridDashedLine(float lineLength, float spaceLength, float phase) Enables the grid line to be drawn in dashed mode, e.g.
int	getAxisLineColor() Returns the color of the axis line (line alongside the axis).
float	getAxisLineWidth() Returns the width of the axis line (line alongside the axis).
float	getAxisMaximum() ###### BELOW CODE RELATED TO CUSTOM AXIS VALUES ######
float	getAxisMinimum()
int	getGridColor() Returns the color of the grid lines for this axis (the horizontal lines coming from each label).
android.graphics.DashPathEffect	getGridDashPathEffect() returns the DashPathEffect that is set for grid line
float	getGridLineWidth() Returns the width of the grid lines that are drawn away from each axis label.
java.util.List<LimitLine>	getLimitLines() Returns the LimitLines of this axis.
abstract java.lang.String	getLongestLabel() Returns the longest formatted label (in terms of characters), this axis contains.
boolean	isAxisMaxCustom() Returns true if the axis max value has been customized (and is not calculated automatically)
boolean	isAxisMinCustom() Returns true if the axis min value has been customized (and is not calculated automatically)
boolean	isDrawAxisLineEnabled() Returns true if the line alongside the axis should be drawn.
boolean	isDrawGridLinesEnabled() Returns true if drawing grid lines is enabled for this axis.
boolean	isDrawLabelsEnabled() Returns true if drawing the labels is enabled for this axis.
boolean	isDrawLimitLinesBehindDataEnabled()
boolean	isGridDashedLineEnabled() Returns true if the grid dashed-line effect is enabled, false if not.
void	removeAllLimitLines() Removes all LimitLines from the axis.
void	removeLimitLine(LimitLine l) Removes the specified LimitLine from the axis.
void	resetAxisMaxValue() By calling this method, any custom maximum value that has been previously set is reseted, and the calculation is done automatically.
void	resetAxisMinValue() By calling this method, any custom minimum value that has been previously set is reseted, and the calculation is done automatically.
void	setAxisLineColor(int color) Sets the color of the border surrounding the chart.
void	setAxisLineWidth(float width) Sets the width of the border surrounding the chart in dp.
void	setAxisMaxValue(float max) Set a custom maximum value for this axis.
void	setAxisMinValue(float min) Set a custom minimum value for this axis.
void	setDrawAxisLine(boolean enabled) Set this to true if the line alongside the axis should be drawn or not.
void	setDrawGridLines(boolean enabled) Set this to true to enable drawing the grid lines for this axis.
void	setDrawLabels(boolean enabled) Set this to true to enable drawing the labels of this axis (this will not affect drawing the grid lines or axis lines).
void	setDrawLimitLinesBehindData(boolean enabled) If this is set to true, the LimitLines are drawn behind the actual data, otherwise on top.
void	setGridColor(int color) Sets the color of the grid lines for this axis (the horizontal lines coming from each label).
void	setGridLineWidth(float width) Sets the width of the grid lines that are drawn away from each axis label.

Methods inherited from class com.github.mikephil.charting.components.ComponentBase

getTextColor, getTextSize, getTypeface, getXOffset, getYOffset, isEnabled, setEnabled, setTextColor, setTextSize, setTypeface, setXOffset, setYOffset

Methods inherited from class java.lang.Object

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

Field Detail

mDrawGridLines

protected boolean mDrawGridLines

flag indicating if the grid lines for this axis should be drawn

mDrawAxisLine

protected boolean mDrawAxisLine

flag that indicates if the line alongside the axis is drawn or not

mDrawLabels

protected boolean mDrawLabels

flag that indicates of the labels of this axis should be drawn or not

mLimitLines

protected java.util.List<LimitLine> mLimitLines

array of limit lines that can be set for the axis

mDrawLimitLineBehindData

protected boolean mDrawLimitLineBehindData

flag indicating the limit lines layer depth

mCustomAxisMin

protected boolean mCustomAxisMin

flag indicating that the axis-min value has been customized

mCustomAxisMax

protected boolean mCustomAxisMax

flag indicating that the axis-max value has been customized

mAxisMaximum

public float mAxisMaximum

don't touch this direclty, use setter

mAxisMinimum

public float mAxisMinimum

don't touch this directly, use setter

mAxisRange

public float mAxisRange

the total range of values this axis covers

Constructor Detail

AxisBase

public AxisBase()

default constructor

Method Detail

setDrawGridLines

public void setDrawGridLines(boolean enabled)

Set this to true to enable drawing the grid lines for this axis.

Parameters:

enabled -

isDrawGridLinesEnabled

public boolean isDrawGridLinesEnabled()

Returns true if drawing grid lines is enabled for this axis.

Returns:

setDrawAxisLine

public void setDrawAxisLine(boolean enabled)

Set this to true if the line alongside the axis should be drawn or not.

Parameters:

enabled -

isDrawAxisLineEnabled

public boolean isDrawAxisLineEnabled()

Returns true if the line alongside the axis should be drawn.

Returns:

setGridColor

public void setGridColor(int color)

Sets the color of the grid lines for this axis (the horizontal lines coming from each label).

Parameters:

color -

getGridColor

public int getGridColor()

Returns the color of the grid lines for this axis (the horizontal lines coming from each label).

Returns:

setAxisLineWidth

public void setAxisLineWidth(float width)

Sets the width of the border surrounding the chart in dp.

Parameters:

width -

getAxisLineWidth

public float getAxisLineWidth()

Returns the width of the axis line (line alongside the axis).

Returns:

setGridLineWidth

public void setGridLineWidth(float width)

Sets the width of the grid lines that are drawn away from each axis label.

Parameters:

width -

getGridLineWidth

public float getGridLineWidth()

Returns the width of the grid lines that are drawn away from each axis label.

Returns:

setAxisLineColor

public void setAxisLineColor(int color)

Sets the color of the border surrounding the chart.

Parameters:

color -

getAxisLineColor

public int getAxisLineColor()

Returns the color of the axis line (line alongside the axis).

Returns:

setDrawLabels

public void setDrawLabels(boolean enabled)

Set this to true to enable drawing the labels of this axis (this will not affect drawing the grid lines or axis lines).

Parameters:

enabled -

isDrawLabelsEnabled

public boolean isDrawLabelsEnabled()

Returns true if drawing the labels is enabled for this axis.

Returns:

addLimitLine

public void addLimitLine(LimitLine l)

Adds a new LimitLine to this axis.

Parameters:

l -

removeLimitLine

public void removeLimitLine(LimitLine l)

Removes the specified LimitLine from the axis.

Parameters:

l -

removeAllLimitLines

public void removeAllLimitLines()

Removes all LimitLines from the axis.

getLimitLines

public java.util.List<LimitLine> getLimitLines()

Returns the LimitLines of this axis.

Returns:

setDrawLimitLinesBehindData

public void setDrawLimitLinesBehindData(boolean enabled)

If this is set to true, the LimitLines are drawn behind the actual data, otherwise on top. Default: false

Parameters:

enabled -

isDrawLimitLinesBehindDataEnabled

public boolean isDrawLimitLinesBehindDataEnabled()

getLongestLabel

public abstract java.lang.String getLongestLabel()

Returns the longest formatted label (in terms of characters), this axis contains.

Returns:

enableGridDashedLine

public void enableGridDashedLine(float lineLength,
                        float spaceLength,
                        float phase)

Enables the grid line to be drawn in dashed mode, e.g. like this "- - - - - -". THIS ONLY WORKS IF HARDWARE-ACCELERATION IS TURNED OFF. Keep in mind that hardware acceleration boosts performance.

Parameters:

lineLength - the length of the line pieces

spaceLength - the length of space in between the pieces

phase - offset, in degrees (normally, use 0)

disableGridDashedLine

public void disableGridDashedLine()

Disables the grid line to be drawn in dashed mode.

isGridDashedLineEnabled

public boolean isGridDashedLineEnabled()

Returns true if the grid dashed-line effect is enabled, false if not.

Returns:

getGridDashPathEffect

public android.graphics.DashPathEffect getGridDashPathEffect()

returns the DashPathEffect that is set for grid line

Returns:

getAxisMaximum

public float getAxisMaximum()

###### BELOW CODE RELATED TO CUSTOM AXIS VALUES ######

getAxisMinimum

public float getAxisMinimum()

resetAxisMaxValue

public void resetAxisMaxValue()

By calling this method, any custom maximum value that has been previously set is reseted, and the calculation is done automatically.

isAxisMaxCustom

public boolean isAxisMaxCustom()

Returns true if the axis max value has been customized (and is not calculated automatically)

Returns:

resetAxisMinValue

public void resetAxisMinValue()

By calling this method, any custom minimum value that has been previously set is reseted, and the calculation is done automatically.

isAxisMinCustom

public boolean isAxisMinCustom()

Returns true if the axis min value has been customized (and is not calculated automatically)

Returns:

setAxisMinValue

public void setAxisMinValue(float min)

Set a custom minimum value for this axis. If set, this value will not be calculated automatically depending on the provided data. Use resetAxisMinValue() to undo this. Do not forget to call setStartAtZero(false) if you use this method. Otherwise, the axis-minimum value will still be forced to 0.

Parameters:

min -

setAxisMaxValue

public void setAxisMaxValue(float max)

Set a custom maximum value for this axis. If set, this value will not be calculated automatically depending on the provided data. Use resetAxisMaxValue() to undo this.

Parameters:

max -