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
protected boolean	mDrawZeroLine flag that indicates if the zero-line should be drawn regardless of other grid lines
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 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 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, mAxisValueFormatter, mCenterAxisLabels, mCenteredEntries, mCustomAxisMax, mCustomAxisMin, mDecimals, mDrawAxisLine, mDrawGridLines, mDrawGridLinesBehindData, mDrawLabels, mDrawLimitLineBehindData, mEntries, mEntryCount, mForceLabels, mGranularity, mGranularityEnabled, mLimitLines, mSpaceMax, mSpaceMin

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 and range values of the axis with the given minimum and maximum values from the chart data.
YAxis.AxisDependency	getAxisDependency()
YAxis.YAxisLabelPosition	getLabelPosition() returns the position of the y-labels
float	getLabelXOffset() returns the horizontal offset of the y-label
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.
int	getZeroLineColor()
float	getZeroLineWidth()
boolean	isDrawBottomYLabelEntryEnabled() returns true if drawing the bottom y-axis label entry is enabled
boolean	isDrawTopYLabelEntryEnabled() returns true if drawing the top y-axis label entry is enabled
boolean	isDrawZeroLineEnabled()
boolean	isInverted() If this returns true, the y-axis is inverted.
boolean	isUseAutoScaleMaxRestriction() Deprecated.
boolean	isUseAutoScaleMinRestriction() Deprecated.
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	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	setLabelXOffset(float xOffset) sets the horizontal offset of the y-label
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	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	setUseAutoScaleMaxRestriction(boolean isEnabled) Deprecated.
void	setUseAutoScaleMinRestriction(boolean isEnabled) Deprecated.
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, disableAxisLineDashedLine, disableGridDashedLine, enableAxisLineDashedLine, enableGridDashedLine, getAxisLineColor, getAxisLineDashPathEffect, getAxisLineWidth, getAxisMaximum, getAxisMaxLabels, getAxisMinimum, getAxisMinLabels, getFormattedLabel, getGranularity, getGridColor, getGridDashPathEffect, getGridLineWidth, getLabelCount, getLimitLines, getLongestLabel, getSpaceMax, getSpaceMin, getValueFormatter, isAxisLineDashedLineEnabled, isAxisMaxCustom, isAxisMinCustom, isCenterAxisLabelsEnabled, isDrawAxisLineEnabled, isDrawGridLinesBehindDataEnabled, isDrawGridLinesEnabled, isDrawLabelsEnabled, isDrawLimitLinesBehindDataEnabled, isForceLabelsEnabled, isGranularityEnabled, isGridDashedLineEnabled, removeAllLimitLines, removeLimitLine, resetAxisMaximum, resetAxisMinimum, setAxisLineColor, setAxisLineDashedLine, setAxisLineWidth, setAxisMaximum, setAxisMaxLabels, setAxisMaxValue, setAxisMinimum, setAxisMinLabels, setAxisMinValue, setCenterAxisLabels, setDrawAxisLine, setDrawGridLines, setDrawGridLinesBehindData, setDrawLabels, setDrawLimitLinesBehindData, setGranularity, setGranularityEnabled, setGridColor, setGridDashedLine, setGridLineWidth, setLabelCount, setLabelCount, setSpaceMax, setSpaceMin, setValueFormatter

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

mInverted

protected boolean mInverted

flag that indicates if the axis is inverted or not

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)

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 -

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 -

getLabelXOffset

public float getLabelXOffset()

returns the horizontal offset of the y-label

setLabelXOffset

public void setLabelXOffset(float xOffset)

sets the horizontal offset of the y-label

Parameters:

xOffset -

isDrawTopYLabelEntryEnabled

public boolean isDrawTopYLabelEntryEnabled()

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

Returns:

isDrawBottomYLabelEntryEnabled

public boolean isDrawBottomYLabelEntryEnabled()

returns true if drawing the bottom 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 -

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 setAxisMinimum(...) / setAxisMaximum(...) 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:

needsOffset

public boolean needsOffset()

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

Returns:

isUseAutoScaleMinRestriction

@Deprecated
public boolean isUseAutoScaleMinRestriction()

Deprecated.

Returns true if autoscale restriction for axis min value is enabled

setUseAutoScaleMinRestriction

@Deprecated
public void setUseAutoScaleMinRestriction(boolean isEnabled)

Deprecated.

Sets autoscale restriction for axis min value as enabled/disabled

isUseAutoScaleMaxRestriction

@Deprecated
public boolean isUseAutoScaleMaxRestriction()

Deprecated.

Returns true if autoscale restriction for axis max value is enabled

setUseAutoScaleMaxRestriction

@Deprecated
public void setUseAutoScaleMaxRestriction(boolean isEnabled)

Deprecated.

Sets autoscale restriction for axis max value as enabled/disabled

calculate

public void calculate(float dataMin,
                      float dataMax)

Description copied from class: AxisBase

Calculates the minimum / maximum and range values of the axis with the given minimum and maximum values from the chart data.

Overrides:

calculate in class AxisBase

Parameters:

dataMin - the min value according to chart data

dataMax - the max value according to chart data