com.github.mikephil.charting.components

Class XAxis

java.lang.Object

com.github.mikephil.charting.components.ComponentBase

com.github.mikephil.charting.components.AxisBase

com.github.mikephil.charting.components.XAxis

public class XAxis
extends AxisBase

Class representing the x-axis labels settings. Only use the setter methods to modify it. Do not access public variables directly. Be aware that not all features the XLabels class provides are suitable for the RadarChart.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XAxis.XAxisPosition enum for the position of the x-labels relative to the chart

Field Summary

Fields

Modifier and Type	Field and Description
int	mAxisLabelModulus the modulus that indicates if a value at a specified index in an array(list) for the x-axis-labels is drawn or not.
int	mLabelHeight height of the x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers
int	mLabelRotatedHeight height of the (rotated) x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers
int	mLabelRotatedWidth width of the (rotated) x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers
protected float	mLabelRotationAngle This is the angle for drawing the X axis labels (in degrees)
int	mLabelWidth width of the x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers
protected java.util.List<java.lang.String>	mValues the arraylist containing all the x-axis labels
protected XAxisValueFormatter	mXAxisValueFormatter Custom formatter for adjusting x-value strings
int	mYAxisLabelModulus the modulus that indicates if a value at a specified index in an array(list) for the y-axis-labels is drawn or not.

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
XAxis()

Method Summary

Modifier and Type	Method and Description
float	getLabelRotationAngle() returns the angle for drawing the X axis labels (in degrees)
java.lang.String	getLongestLabel() Returns the longest formatted label (in terms of characters), this axis contains.
XAxis.XAxisPosition	getPosition() returns the position of the x-labels
int	getSpaceBetweenLabels() Returns the space (in characters) that should be left out between the x-axis labels
XAxisValueFormatter	getValueFormatter() Returns the custom XAxisValueFormatter that is set for this data object.
java.util.List<java.lang.String>	getValues() Returns the labels for this axis.
boolean	isAvoidFirstLastClippingEnabled() returns true if avoid-first-lastclipping is enabled, false if not
boolean	isAxisModulusCustom() Returns true if a custom axis-modulus has been set that determines the number of labels to skip when drawing.
void	resetLabelsToSkip() Calling this will disable a custom number of labels to be skipped (set by setLabelsToSkip(...)) while drawing the x-axis.
void	setAvoidFirstLastClipping(boolean enabled) if set to true, the chart will avoid that the first and last label entry in the chart "clip" off the edge of the chart or the screen
void	setLabelRotationAngle(float angle) sets the angle for drawing the X axis labels (in degrees)
void	setLabelsToSkip(int count) Sets the number of labels that should be skipped on the axis before the next label is drawn.
void	setPosition(XAxis.XAxisPosition pos) sets the position of the x-labels
void	setSpaceBetweenLabels(int spaceCharacters) Sets the space (in characters) that should be left out between the x-axis labels, default 4.
void	setValueFormatter(XAxisValueFormatter formatter) Sets a custom XAxisValueFormatter for the data object that allows custom-formatting of all x-values before rendering them.
void	setValues(java.util.List<java.lang.String> values) Sets the labels for this axis.

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

mValues

protected java.util.List<java.lang.String> mValues

the arraylist containing all the x-axis labels

mLabelWidth

public int mLabelWidth

width of the x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers

mLabelHeight

public int mLabelHeight

height of the x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers

mLabelRotatedWidth

public int mLabelRotatedWidth

width of the (rotated) x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers

mLabelRotatedHeight

public int mLabelRotatedHeight

height of the (rotated) x-axis labels in pixels - this is automatically calculated by the computeAxis() methods in the renderers

mLabelRotationAngle

protected float mLabelRotationAngle

This is the angle for drawing the X axis labels (in degrees)

mAxisLabelModulus

public int mAxisLabelModulus

the modulus that indicates if a value at a specified index in an array(list) for the x-axis-labels is drawn or not. If index % modulus == 0 DRAW, else dont draw.

mYAxisLabelModulus

public int mYAxisLabelModulus

the modulus that indicates if a value at a specified index in an array(list) for the y-axis-labels is drawn or not. If index % modulus == 0 DRAW, else dont draw. THIS IS ONLY FOR HORIZONTAL BARCHART.

mXAxisValueFormatter

protected XAxisValueFormatter mXAxisValueFormatter

Custom formatter for adjusting x-value strings

Constructor Detail

XAxis

public XAxis()

Method Detail

getPosition

public XAxis.XAxisPosition getPosition()

returns the position of the x-labels

setPosition

public void setPosition(XAxis.XAxisPosition pos)

sets the position of the x-labels

Parameters:

pos -

getLabelRotationAngle

public float getLabelRotationAngle()

returns the angle for drawing the X axis labels (in degrees)

setLabelRotationAngle

public void setLabelRotationAngle(float angle)

sets the angle for drawing the X axis labels (in degrees)

Parameters:

angle - the angle in degrees

setSpaceBetweenLabels

public void setSpaceBetweenLabels(int spaceCharacters)

Sets the space (in characters) that should be left out between the x-axis labels, default 4. This only applies if the number of labels that will be skipped in between drawn axis labels is not custom set.

Parameters:

spaceCharacters -

setLabelsToSkip

public void setLabelsToSkip(int count)

Sets the number of labels that should be skipped on the axis before the next label is drawn. This will disable the feature that automatically calculates an adequate space between the axis labels and set the number of labels to be skipped to the fixed number provided by this method. Call resetLabelsToSkip(...) to re-enable automatic calculation.

Parameters:

count -

resetLabelsToSkip

public void resetLabelsToSkip()

Calling this will disable a custom number of labels to be skipped (set by setLabelsToSkip(...)) while drawing the x-axis. Instead, the number of values to skip will again be calculated automatically.

isAxisModulusCustom

public boolean isAxisModulusCustom()

Returns true if a custom axis-modulus has been set that determines the number of labels to skip when drawing.

Returns:

getSpaceBetweenLabels

public int getSpaceBetweenLabels()

Returns the space (in characters) that should be left out between the x-axis labels

setAvoidFirstLastClipping

public void setAvoidFirstLastClipping(boolean enabled)

if set to true, the chart will avoid that the first and last label entry in the chart "clip" off the edge of the chart or the screen

Parameters:

enabled -

isAvoidFirstLastClippingEnabled

public boolean isAvoidFirstLastClippingEnabled()

returns true if avoid-first-lastclipping is enabled, false if not

Returns:

setValues

public void setValues(java.util.List<java.lang.String> values)

Sets the labels for this axis.

Parameters:

values -

getValues

public java.util.List<java.lang.String> getValues()

Returns the labels for this axis.

Returns:

setValueFormatter

public void setValueFormatter(XAxisValueFormatter formatter)

Sets a custom XAxisValueFormatter for the data object that allows custom-formatting of all x-values before rendering them. Provide null to reset back to the default formatting.

Parameters:

formatter -

getValueFormatter

public XAxisValueFormatter getValueFormatter()

Returns the custom XAxisValueFormatter that is set for this data object.

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: