com.github.mikephil.charting.components

Class YAxis

java.lang.Object

com.github.mikephil.charting.components.ComponentBase

com.github.mikephil.charting.components.AxisBase

com.github.mikephil.charting.components.YAxis

public class YAxis
extends AxisBase

Class representing the y-axis labels settings and its entries. Only use the setter methods to modify it. Do not access public variables directly. Be aware that not all features the YLabels class provides are suitable for the RadarChart. Customizations that affect the value range of the axis need to be applied before setting data for the chart.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YAxis.AxisDependency Enum that specifies the axis a DataSet should be plotted against, either LEFT or RIGHT.
static class	YAxis.YAxisLabelPosition enum for the position of the y-labels relative to the chart

Field Summary

Fields

Modifier and Type	Field and Description
int	mDecimals the number of decimal digits to use
protected boolean	mDrawZeroLine flag that indicates if the zero-line should be drawn regardless of other grid lines
float[]	mEntries the actual array of entries
int	mEntryCount the number of entries the legend contains
protected boolean	mForceLabels if true, the set number of y-labels will be forced
protected float	mGranularity the minimum interval between axis values
protected boolean	mGranularityEnabled When true, axis labels are controlled by the `granularity` property.
protected boolean	mInverted flag that indicates if the axis is inverted or not
protected float	mMaxWidth the maximum width that the axis can take (in dp).
protected float	mMinWidth the minimum width that the axis should take (in dp).
protected boolean	mShowOnlyMinMax if true, the y-labels show only the minimum and maximum value
protected float	mSpacePercentBottom axis space from the smallest value to the bottom in percent of the total axis range
protected float	mSpacePercentTop axis space from the largest value to the top in percent of the total axis range
protected YAxisValueFormatter	mYAxisValueFormatter custom formatter that is used instead of the auto-formatter if set
protected int	mZeroLineColor Color of the zero line
protected float	mZeroLineWidth Width of the zero line in pixels

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

mAxisMaximum, mAxisMinimum, mAxisRange, mCustomAxisMax, mCustomAxisMin, mDrawAxisLine, mDrawGridLines, mDrawLabels, mDrawLimitLineBehindData, mLimitLines

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

mEnabled, mTextColor, mTextSize, mTypeface, mXOffset, mYOffset

Constructor Summary

Constructors

Constructor and Description
YAxis()
YAxis(YAxis.AxisDependency position)

Method Summary

Modifier and Type	Method and Description
void	calculate(float dataMin, float dataMax) Calculates the minimum, maximum, granularity and range values of the YAxis with the given minimum and maximum values from the chart data.
YAxis.AxisDependency	getAxisDependency()
java.lang.String	getFormattedLabel(int index) Returns the formatted y-label at the specified index.
float	getGranularity()
int	getLabelCount() Returns the number of label entries the y-axis should have
YAxis.YAxisLabelPosition	getLabelPosition() returns the position of the y-labels
java.lang.String	getLongestLabel() Returns the longest formatted label (in terms of characters), this axis contains.
float	getMaxWidth()
float	getMinWidth()
float	getRequiredHeightSpace(android.graphics.Paint p) This is for HorizontalBarChart vertical spacing.
float	getRequiredWidthSpace(android.graphics.Paint p) This is for normal (not horizontal) charts horizontal spacing.
float	getSpaceBottom() Returns the bottom axis space in percent of the full range.
float	getSpaceTop() Returns the top axis space in percent of the full range.
YAxisValueFormatter	getValueFormatter() Returns the formatter used for formatting the axis labels.
int	getZeroLineColor()
float	getZeroLineWidth()
boolean	isDrawTopYLabelEntryEnabled() returns true if drawing the top y-axis label entry is enabled
boolean	isDrawZeroLineEnabled()
boolean	isForceLabelsEnabled() Returns true if focing the y-label count is enabled.
boolean	isGranularityEnabled()
boolean	isInverted() If this returns true, the y-axis is inverted.
boolean	isShowOnlyMinMaxEnabled() Returns true if showing only min and max value is enabled.
boolean	needsDefaultFormatter() If this component has no YAxisValueFormatter or is only equipped with the default one (no custom set), return true.
boolean	needsOffset() Returns true if this axis needs horizontal offset, false if no offset is needed.
void	setDrawTopYLabelEntry(boolean enabled) set this to true to enable drawing the top y-label entry.
void	setDrawZeroLine(boolean mDrawZeroLine) Set this to true to draw the zero-line regardless of weather other grid-lines are enabled or not.
void	setGranularity(float granularity) Set a minimum interval for the axis when zooming in.
void	setGranularityEnabled(boolean enabled) Enabled/disable granularity control on axis value intervals.
void	setInverted(boolean enabled) If this is set to true, the y-axis is inverted which means that low values are on top of the chart, high values on bottom.
void	setLabelCount(int count, boolean force) sets the number of label entries for the y-axis max = 25, min = 2, default: 6, be aware that this number is not fixed (if force == false) and can only be approximated.
void	setMaxWidth(float maxWidth) Sets the maximum width that the axis can take (in dp).
void	setMinWidth(float minWidth) Sets the minimum width that the axis should take (in dp).
void	setPosition(YAxis.YAxisLabelPosition pos) sets the position of the y-labels
void	setShowOnlyMinMax(boolean enabled) If enabled, the YLabels will only show the minimum and maximum value of the chart.
void	setSpaceBottom(float percent) Sets the bottom axis space in percent of the full range.
void	setSpaceTop(float percent) Sets the top axis space in percent of the full range.
void	setStartAtZero(boolean startAtZero) Deprecated.
void	setValueFormatter(YAxisValueFormatter f) Sets the formatter to be used for formatting the axis labels.
void	setZeroLineColor(int color) Sets the color of the zero line
void	setZeroLineWidth(float width) Sets the width of the zero line in dp

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

addLimitLine, disableGridDashedLine, enableGridDashedLine, getAxisLineColor, getAxisLineWidth, getAxisMaximum, getAxisMinimum, getGridColor, getGridDashPathEffect, getGridLineWidth, getLimitLines, isAxisMaxCustom, isAxisMinCustom, isDrawAxisLineEnabled, isDrawGridLinesEnabled, isDrawLabelsEnabled, isDrawLimitLinesBehindDataEnabled, isGridDashedLineEnabled, removeAllLimitLines, removeLimitLine, resetAxisMaxValue, resetAxisMinValue, setAxisLineColor, setAxisLineWidth, setAxisMaxValue, setAxisMinValue, setDrawAxisLine, setDrawGridLines, setDrawLabels, setDrawLimitLinesBehindData, setGridColor, setGridLineWidth

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

mYAxisValueFormatter

protected YAxisValueFormatter mYAxisValueFormatter

custom formatter that is used instead of the auto-formatter if set

mEntries

public float[] mEntries

the actual array of entries

mEntryCount

public int mEntryCount

the number of entries the legend contains

mDecimals

public int mDecimals

the number of decimal digits to use

mShowOnlyMinMax

protected boolean mShowOnlyMinMax

if true, the y-labels show only the minimum and maximum value

mInverted

protected boolean mInverted

flag that indicates if the axis is inverted or not

mForceLabels

protected boolean mForceLabels

if true, the set number of y-labels will be forced

mDrawZeroLine

protected boolean mDrawZeroLine

flag that indicates if the zero-line should be drawn regardless of other grid lines

mZeroLineColor

protected int mZeroLineColor

Color of the zero line

mZeroLineWidth

protected float mZeroLineWidth

Width of the zero line in pixels

mSpacePercentTop

protected float mSpacePercentTop

axis space from the largest value to the top in percent of the total axis range

mSpacePercentBottom

protected float mSpacePercentBottom

axis space from the smallest value to the bottom in percent of the total axis range

mMinWidth

protected float mMinWidth

the minimum width that the axis should take (in dp).

default: 0.0

mMaxWidth

protected float mMaxWidth

the maximum width that the axis can take (in dp). use Inifinity for disabling the maximum default: Float.POSITIVE_INFINITY (no maximum specified)

mGranularityEnabled

protected boolean mGranularityEnabled

When true, axis labels are controlled by the `granularity` property. When false, axis values could possibly be repeated. This could happen if two adjacent axis values are rounded to same value. If using granularity this could be avoided by having fewer axis values visible.

mGranularity

protected float mGranularity

the minimum interval between axis values

Constructor Detail

YAxis

public YAxis()

YAxis

public YAxis(YAxis.AxisDependency position)

Method Detail

getAxisDependency

public YAxis.AxisDependency getAxisDependency()

getMinWidth

public float getMinWidth()

Returns:

the minimum width that the axis should take (in dp).

setMinWidth

public void setMinWidth(float minWidth)

Sets the minimum width that the axis should take (in dp).

Parameters:

minWidth -

getMaxWidth

public float getMaxWidth()

Returns:

the maximum width that the axis can take (in dp).

setMaxWidth

public void setMaxWidth(float maxWidth)

Sets the maximum width that the axis can take (in dp).

Parameters:

maxWidth -

isGranularityEnabled

public boolean isGranularityEnabled()

Returns:

true if granularity is enabled

setGranularityEnabled

public void setGranularityEnabled(boolean enabled)

Enabled/disable granularity control on axis value intervals. If enabled, the axis interval is not allowed to go below a certain granularity. Default: false

Parameters:

enabled -

getGranularity

public float getGranularity()

Returns:

the minimum interval between axis values

setGranularity

public void setGranularity(float granularity)

Set a minimum interval for the axis when zooming in. The axis is not allowed to go below that limit. This can be used to avoid label duplicating when zooming in.

Parameters:

granularity -

getLabelPosition

public YAxis.YAxisLabelPosition getLabelPosition()

returns the position of the y-labels

setPosition

public void setPosition(YAxis.YAxisLabelPosition pos)

sets the position of the y-labels

Parameters:

pos -

isDrawTopYLabelEntryEnabled

public boolean isDrawTopYLabelEntryEnabled()

returns true if drawing the top y-axis label entry is enabled

Returns:

setDrawTopYLabelEntry

public void setDrawTopYLabelEntry(boolean enabled)

set this to true to enable drawing the top y-label entry. Disabling this can be helpful when the top y-label and left x-label interfere with each other. default: true

Parameters:

enabled -

setLabelCount

public void setLabelCount(int count,
                          boolean force)

sets the number of label entries for the y-axis max = 25, min = 2, default: 6, be aware that this number is not fixed (if force == false) and can only be approximated.

Parameters:

count - the number of y-axis labels that sould be displayed

force - if enabled, the set label count will be forced, meaning that the exact specified count of labels will be drawn and evenly distributed alongside the axis - this might cause labels to have uneven values

getLabelCount

public int getLabelCount()

Returns the number of label entries the y-axis should have

Returns:

isForceLabelsEnabled

public boolean isForceLabelsEnabled()

Returns true if focing the y-label count is enabled. Default: false

Returns:

setShowOnlyMinMax

public void setShowOnlyMinMax(boolean enabled)

If enabled, the YLabels will only show the minimum and maximum value of the chart. This will ignore/override the set label count.

Parameters:

enabled -

isShowOnlyMinMaxEnabled

public boolean isShowOnlyMinMaxEnabled()

Returns true if showing only min and max value is enabled.

Returns:

setInverted

public void setInverted(boolean enabled)

If this is set to true, the y-axis is inverted which means that low values are on top of the chart, high values on bottom.

Parameters:

enabled -

isInverted

public boolean isInverted()

If this returns true, the y-axis is inverted.

Returns:

setStartAtZero

@Deprecated
public void setStartAtZero(boolean startAtZero)

Deprecated.

This method is deprecated. Use setAxisMinValue(...) / setAxisMaxValue(...) instead.

Parameters:

startAtZero -

setSpaceTop

public void setSpaceTop(float percent)

Sets the top axis space in percent of the full range. Default 10f

Parameters:

percent -

getSpaceTop

public float getSpaceTop()

Returns the top axis space in percent of the full range. Default 10f

Returns:

setSpaceBottom

public void setSpaceBottom(float percent)

Sets the bottom axis space in percent of the full range. Default 10f

Parameters:

percent -

getSpaceBottom

public float getSpaceBottom()

Returns the bottom axis space in percent of the full range. Default 10f

Returns:

isDrawZeroLineEnabled

public boolean isDrawZeroLineEnabled()

setDrawZeroLine

public void setDrawZeroLine(boolean mDrawZeroLine)

Set this to true to draw the zero-line regardless of weather other grid-lines are enabled or not. Default: false

Parameters:

mDrawZeroLine -

getZeroLineColor

public int getZeroLineColor()

setZeroLineColor

public void setZeroLineColor(int color)

Sets the color of the zero line

Parameters:

color -

getZeroLineWidth

public float getZeroLineWidth()

setZeroLineWidth

public void setZeroLineWidth(float width)

Sets the width of the zero line in dp

Parameters:

width -

getRequiredWidthSpace

public float getRequiredWidthSpace(android.graphics.Paint p)

This is for normal (not horizontal) charts horizontal spacing.

Parameters:

p -

Returns:

getRequiredHeightSpace

public float getRequiredHeightSpace(android.graphics.Paint p)

This is for HorizontalBarChart vertical spacing.

Parameters:

p -

Returns:

getLongestLabel

public java.lang.String getLongestLabel()

Description copied from class: AxisBase

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

Specified by:

getLongestLabel in class AxisBase

Returns:

getFormattedLabel

public java.lang.String getFormattedLabel(int index)

Returns the formatted y-label at the specified index. This will either use the auto-formatter or the custom formatter (if one is set).

Parameters:

index -

Returns:

setValueFormatter

public void setValueFormatter(YAxisValueFormatter f)

Sets the formatter to be used for formatting the axis labels. If no formatter is set, the chart will automatically determine a reasonable formatting (concerning decimals) for all the values that are drawn inside the chart. Use chart.getDefaultValueFormatter() to use the formatter calculated by the chart.

Parameters:

f -

getValueFormatter

public YAxisValueFormatter getValueFormatter()

Returns the formatter used for formatting the axis labels.

Returns:

needsDefaultFormatter

public boolean needsDefaultFormatter()

If this component has no YAxisValueFormatter or is only equipped with the default one (no custom set), return true.

Returns:

needsOffset

public boolean needsOffset()

Returns true if this axis needs horizontal offset, false if no offset is needed.

Returns:

calculate

public void calculate(float dataMin,
                      float dataMax)

Calculates the minimum, maximum, granularity and range values of the YAxis with the given minimum and maximum values from the chart data.

Parameters:

dataMin - the y-min value according to chart data

dataMax - the y-max value according to chart data