YAxis (MPChartLib v2.1.6 API)

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
`float`	`mAxisMaximum`
`float`	`mAxisMinimum`
`float`	`mAxisRange` the total range of values this axis covers
`protected float`	`mCustomAxisMax` custom maximum value this axis represents
`protected float`	`mCustomAxisMin` custom minimum value this axis represents
`int`	`mDecimals` the number of decimal digits to use
`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 boolean`	`mInverted` flag that indicates if the axis is inverted or not
`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 boolean`	`mStartAtZero` if true, the y-label entries will always start at zero
`protected YAxisValueFormatter`	`mYAxisValueFormatter` custom formatter that is used instead of the auto-formatter if set

Fields inherited from class com.github.mikephil.charting.components.AxisBase
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)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`YAxis.AxisDependency`	`getAxisDependency()`
`float`	`getAxisMaxValue()`
`float`	`getAxisMinValue()`
`java.lang.String`	`getFormattedLabel(int index)` Returns the formatted y-label at the specified index.
`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`	`getRequiredHeightSpace(android.graphics.Paint p)`
`float`	`getRequiredWidthSpace(android.graphics.Paint p)`
`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.
`boolean`	`isDrawTopYLabelEntryEnabled()` returns true if drawing the top y-axis label entry is enabled
`boolean`	`isForceLabelsEnabled()` Returns true if focing the y-label count is enabled.
`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`	`isStartAtZeroEnabled()` returns true if the chart is set to start at zero, false otherwise
`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`	`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`	`setAxisMaxValue(float max)` Set a custom maximum value for this axis.
`void`	`setAxisMinValue(float min)` Set a custom minimum value for this axis.
`void`	`setDrawTopYLabelEntry(boolean enabled)` set this to true to enable drawing the top y-label entry.
`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`	`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 enabled)` enable this to force the y-axis labels to always start at zero
`void`	`setValueFormatter(YAxisValueFormatter f)` Sets the formatter to be used for formatting the axis labels.

Methods inherited from class com.github.mikephil.charting.components.AxisBase
addLimitLine, disableGridDashedLine, enableGridDashedLine, getAxisLineColor, getAxisLineWidth, getGridColor, getGridDashPathEffect, getGridLineWidth, getLimitLines, isDrawAxisLineEnabled, isDrawGridLinesEnabled, isDrawLabelsEnabled, isDrawLimitLinesBehindDataEnabled, isGridDashedLineEnabled, removeAllLimitLines, removeLimitLine, setAxisLineColor, setAxisLineWidth, 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
  - mStartAtZero
```
protected boolean mStartAtZero
```
    if true, the y-label entries will always start at zero
  - mForceLabels
```
protected boolean mForceLabels
```
    if true, the set number of y-labels will be forced
  - mCustomAxisMin
```
protected float mCustomAxisMin
```
    custom minimum value this axis represents
  - mCustomAxisMax
```
protected float mCustomAxisMax
```
    custom maximum value this axis represents
  - 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
  - mAxisMaximum
```
public float mAxisMaximum
```
  - mAxisMinimum
```
public float mAxisMinimum
```
  - mAxisRange
```
public float mAxisRange
```
    the total range of values this axis covers
- Constructor Detail
  - YAxis
```
public YAxis()
```
  - YAxis
```
public YAxis(YAxis.AxisDependency position)
```
- Method Detail
  - getAxisDependency
```
public YAxis.AxisDependency getAxisDependency()
```
  - 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
```
public void setStartAtZero(boolean enabled)
```
    enable this to force the y-axis labels to always start at zero
    
    Parameters:
    
    enabled -
  - isStartAtZeroEnabled
```
public boolean isStartAtZeroEnabled()
```
    returns true if the chart is set to start at zero, false otherwise
    
    Returns:
  - getAxisMinValue
```
public float getAxisMinValue()
```
  - 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 -
  - 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.
  - getAxisMaxValue
```
public float getAxisMaxValue()
```
  - 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 -
  - 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.
  - 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:
  - getRequiredWidthSpace
```
public float getRequiredWidthSpace(android.graphics.Paint p)
```
  - getRequiredHeightSpace
```
public float getRequiredHeightSpace(android.graphics.Paint p)
```
  - 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:

Class YAxis

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

mYAxisValueFormatter

mEntries

mEntryCount

mDecimals

mShowOnlyMinMax

mInverted

mStartAtZero

mForceLabels

mCustomAxisMin

mCustomAxisMax

mSpacePercentTop

mSpacePercentBottom

mAxisMaximum

mAxisMinimum

mAxisRange

Constructor Detail

YAxis

YAxis

Method Detail

getAxisDependency

getLabelPosition

setPosition

isDrawTopYLabelEntryEnabled

setDrawTopYLabelEntry

setLabelCount

getLabelCount

isForceLabelsEnabled

setShowOnlyMinMax

isShowOnlyMinMaxEnabled

setInverted

isInverted

setStartAtZero

isStartAtZeroEnabled

getAxisMinValue

setAxisMinValue

resetAxisMinValue

getAxisMaxValue

setAxisMaxValue

resetAxisMaxValue

setSpaceTop

getSpaceTop

setSpaceBottom

getSpaceBottom

getRequiredWidthSpace

getRequiredHeightSpace

getLongestLabel

getFormattedLabel

setValueFormatter

getValueFormatter

needsDefaultFormatter

needsOffset