com.github.mikephil.charting.components

Class LimitLine

java.lang.Object

com.github.mikephil.charting.components.ComponentBase

com.github.mikephil.charting.components.LimitLine

public class LimitLine
extends ComponentBase

The limit line is an additional feature for all Line-, Bar- and ScatterCharts. It allows the displaying of an additional line in the chart that marks a certain maximum / limit on the specified axis (x- or y-axis).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LimitLine.LimitLabelPosition enum that indicates the position of the LimitLine label

Field Summary

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

mEnabled, mTextColor, mTextSize, mTypeface, mXOffset, mYOffset

Constructor Summary

Constructors

Constructor and Description
LimitLine(float limit) Constructor with limit.
LimitLine(float limit, java.lang.String label) Constructor with limit and label.

Method Summary

Methods

Modifier and Type	Method and Description
void	disableDashedLine() Disables the line to be drawn in dashed mode.
void	enableDashedLine(float lineLength, float spaceLength, float phase) Enables the line to be drawn in dashed mode, e.g.
android.graphics.DashPathEffect	getDashPathEffect() returns the DashPathEffect that is set for this LimitLine
java.lang.String	getLabel() Returns the label that is drawn next to the limit line.
LimitLine.LimitLabelPosition	getLabelPosition() Returns the position of the LimitLine label (value).
float	getLimit() Returns the limit that is set for this line.
int	getLineColor() Returns the color that is used for this LimitLine
float	getLineWidth() returns the width of limit line
android.graphics.Paint.Style	getTextStyle() Returns the color of the value-text that is drawn next to the LimitLine.
boolean	isDashedLineEnabled() Returns true if the dashed-line effect is enabled, false if not.
void	setLabel(java.lang.String label) Sets the label that is drawn next to the limit line.
void	setLabelPosition(LimitLine.LimitLabelPosition pos) Sets the position of the LimitLine value label (either on the right or on the left edge of the chart).
void	setLineColor(int color) Sets the linecolor for this LimitLine.
void	setLineWidth(float width) set the line width of the chart (min = 0.2f, max = 12f); default 2f NOTE: thinner line == better performance, thicker line == worse performance
void	setTextStyle(android.graphics.Paint.Style style) Sets the color of the value-text that is drawn next to the LimitLine.

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

Constructor Detail

LimitLine

public LimitLine(float limit)

Constructor with limit.

Parameters:

limit - - the position (the value) on the y-axis (y-value) or x-axis (xIndex) where this line should appear

LimitLine

public LimitLine(float limit,
         java.lang.String label)

Constructor with limit and label.

Parameters:

limit - - the position (the value) on the y-axis (y-value) or x-axis (xIndex) where this line should appear

label - - provide "" if no label is required

Method Detail

getLimit

public float getLimit()

Returns the limit that is set for this line.

Returns:

setLineWidth

public void setLineWidth(float width)

set the line width of the chart (min = 0.2f, max = 12f); default 2f NOTE: thinner line == better performance, thicker line == worse performance

Parameters:

width -

getLineWidth

public float getLineWidth()

returns the width of limit line

Returns:

setLineColor

public void setLineColor(int color)

Sets the linecolor for this LimitLine. Make sure to use getResources().getColor(...)

Parameters:

color -

getLineColor

public int getLineColor()

Returns the color that is used for this LimitLine

Returns:

enableDashedLine

public void enableDashedLine(float lineLength,
                    float spaceLength,
                    float phase)

Enables the line to be drawn in dashed mode, e.g. like this "- - - - - -"

Parameters:

lineLength - the length of the line pieces

spaceLength - the length of space inbetween the pieces

phase - offset, in degrees (normally, use 0)

disableDashedLine

public void disableDashedLine()

Disables the line to be drawn in dashed mode.

isDashedLineEnabled

public boolean isDashedLineEnabled()

Returns true if the dashed-line effect is enabled, false if not. Default: disabled

Returns:

getDashPathEffect

public android.graphics.DashPathEffect getDashPathEffect()

returns the DashPathEffect that is set for this LimitLine

Returns:

setTextStyle

public void setTextStyle(android.graphics.Paint.Style style)

Sets the color of the value-text that is drawn next to the LimitLine. Default: Paint.Style.FILL_AND_STROKE

Parameters:

style -

getTextStyle

public android.graphics.Paint.Style getTextStyle()

Returns the color of the value-text that is drawn next to the LimitLine.

Returns:

setLabelPosition

public void setLabelPosition(LimitLine.LimitLabelPosition pos)

Sets the position of the LimitLine value label (either on the right or on the left edge of the chart). Not supported for RadarChart.

Parameters:

pos -

getLabelPosition

public LimitLine.LimitLabelPosition getLabelPosition()

Returns the position of the LimitLine label (value).

Returns:

setLabel

public void setLabel(java.lang.String label)

Sets the label that is drawn next to the limit line. Provide "" if no label is required.

Parameters:

label -

getLabel

public java.lang.String getLabel()

Returns the label that is drawn next to the limit line.

Returns: