com.github.mikephil.charting.components

Class ComponentBase

java.lang.Object

com.github.mikephil.charting.components.ComponentBase

Direct Known Subclasses:

AxisBase, Description, Legend, LimitLine

public abstract class ComponentBase
extends java.lang.Object

This class encapsulates everything both Axis, Legend and LimitLines have in common.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mEnabled flag that indicates if this axis / legend is enabled or not
protected int	mTextColor the text color to use for the labels
protected float	mTextSize the text size of the labels
protected android.graphics.Typeface	mTypeface the typeface used for the labels
protected float	mXOffset the offset in pixels this component has on the x-axis
protected float	mYOffset the offset in pixels this component has on the Y-axis

Constructor Summary

Constructors

Constructor and Description
ComponentBase()

Method Summary

Modifier and Type	Method and Description
int	getTextColor() Returns the text color that is set for the labels.
float	getTextSize() returns the text size that is currently set for the labels, in pixels
android.graphics.Typeface	getTypeface() returns the Typeface used for the labels, returns null if none is set
float	getXOffset() Returns the used offset on the x-axis for drawing the axis or legend labels.
float	getYOffset() Returns the used offset on the x-axis for drawing the axis labels.
boolean	isEnabled() Returns true if this comonent is enabled (should be drawn), false if not.
void	setEnabled(boolean enabled) Set this to true if this component should be enabled (should be drawn), false if not.
void	setTextColor(int color) Sets the text color to use for the labels.
void	setTextSize(float size) sets the size of the label text in density pixels min = 6f, max = 24f, default 10f
void	setTypeface(android.graphics.Typeface tf) sets a specific Typeface for the labels
void	setXOffset(float xOffset) Sets the used x-axis offset for the labels on this axis.
void	setYOffset(float yOffset) Sets the used y-axis offset for the labels on this axis.

Methods inherited from class java.lang.Object

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

Field Detail

mEnabled

protected boolean mEnabled

flag that indicates if this axis / legend is enabled or not

mXOffset

protected float mXOffset

the offset in pixels this component has on the x-axis

mYOffset

protected float mYOffset

the offset in pixels this component has on the Y-axis

mTypeface

protected android.graphics.Typeface mTypeface

the typeface used for the labels

mTextSize

protected float mTextSize

the text size of the labels

mTextColor

protected int mTextColor

the text color to use for the labels

Constructor Detail

ComponentBase

public ComponentBase()

Method Detail

getXOffset

public float getXOffset()

Returns the used offset on the x-axis for drawing the axis or legend labels. This offset is applied before and after the label.

Returns:

setXOffset

public void setXOffset(float xOffset)

Sets the used x-axis offset for the labels on this axis.

Parameters:

xOffset -

getYOffset

public float getYOffset()

Returns the used offset on the x-axis for drawing the axis labels. This offset is applied before and after the label.

Returns:

setYOffset

public void setYOffset(float yOffset)

Sets the used y-axis offset for the labels on this axis. For the legend, higher offset means the legend as a whole will be placed further away from the top.

Parameters:

yOffset -

getTypeface

public android.graphics.Typeface getTypeface()

returns the Typeface used for the labels, returns null if none is set

Returns:

setTypeface

public void setTypeface(android.graphics.Typeface tf)

sets a specific Typeface for the labels

Parameters:

tf -

setTextSize

public void setTextSize(float size)

sets the size of the label text in density pixels min = 6f, max = 24f, default 10f

Parameters:

size - the text size, in DP

getTextSize

public float getTextSize()

returns the text size that is currently set for the labels, in pixels

Returns:

setTextColor

public void setTextColor(int color)

Sets the text color to use for the labels. Make sure to use getResources().getColor(...) when using a color from the resources.

Parameters:

color -

getTextColor

public int getTextColor()

Returns the text color that is set for the labels.

Returns:

setEnabled

public void setEnabled(boolean enabled)

Set this to true if this component should be enabled (should be drawn), false if not. If disabled, nothing of this component will be drawn. Default: true

Parameters:

enabled -

isEnabled

public boolean isEnabled()

Returns true if this comonent is enabled (should be drawn), false if not.

Returns: