com.github.mikephil.charting.highlight

Class Highlight

java.lang.Object

com.github.mikephil.charting.highlight.Highlight

public class Highlight
extends java.lang.Object

Contains information needed to determine the highlighted value.

Constructor Summary

Constructors

Constructor and Description
Highlight(float x, float y, float xPx, float yPx, int dataSetIndex, int stackIndex, YAxis.AxisDependency axis) Constructor, only used for stacked-barchart.
Highlight(float x, float y, float xPx, float yPx, int dataSetIndex, YAxis.AxisDependency axis) constructor
Highlight(float x, float y, int dataSetIndex)
Highlight(float x, float y, int dataSetIndex, int dataIndex)
Highlight(float x, int dataSetIndex, int stackIndex)

Method Summary

Modifier and Type	Method and Description
boolean	equalTo(Highlight h) Returns true if this highlight object is equal to the other (compares xIndex and dataSetIndex)
YAxis.AxisDependency	getAxis() Returns the axis the highlighted value belongs to.
int	getDataIndex() the index of the data object - in case it refers to more than one
int	getDataSetIndex() returns the index of the DataSet the highlighted value is in
float	getDrawX() Returns the x-position in pixels where this highlight object was last drawn.
float	getDrawY() Returns the y-position in pixels where this highlight object was last drawn.
int	getStackIndex() Only needed if a stacked-barchart entry was highlighted.
float	getX() returns the x-value of the highlighted value
float	getXPx() returns the x-position of the highlight in pixels
float	getY() returns the y-value of the highlighted value
float	getYPx() returns the y-position of the highlight in pixels
boolean	isStacked()
void	setDataIndex(int mDataIndex)
void	setDraw(float x, float y) Sets the x- and y-position (pixels) where this highlight was last drawn.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Highlight

public Highlight(float x,
                 float y,
                 int dataSetIndex,
                 int dataIndex)

Highlight

public Highlight(float x,
                 float y,
                 int dataSetIndex)

Highlight

public Highlight(float x,
                 int dataSetIndex,
                 int stackIndex)

Highlight

public Highlight(float x,
                 float y,
                 float xPx,
                 float yPx,
                 int dataSetIndex,
                 YAxis.AxisDependency axis)

constructor

Parameters:

x - the x-value of the highlighted value

y - the y-value of the highlighted value

dataSetIndex - the index of the DataSet the highlighted value belongs to

Highlight

public Highlight(float x,
                 float y,
                 float xPx,
                 float yPx,
                 int dataSetIndex,
                 int stackIndex,
                 YAxis.AxisDependency axis)

Constructor, only used for stacked-barchart.

Parameters:

x - the index of the highlighted value on the x-axis

y - the y-value of the highlighted value

dataSetIndex - the index of the DataSet the highlighted value belongs to

stackIndex - references which value of a stacked-bar entry has been selected

Method Detail

getX

public float getX()

returns the x-value of the highlighted value

Returns:

getY

public float getY()

returns the y-value of the highlighted value

Returns:

getXPx

public float getXPx()

returns the x-position of the highlight in pixels

getYPx

public float getYPx()

returns the y-position of the highlight in pixels

getDataIndex

public int getDataIndex()

the index of the data object - in case it refers to more than one

Returns:

setDataIndex

public void setDataIndex(int mDataIndex)

getDataSetIndex

public int getDataSetIndex()

returns the index of the DataSet the highlighted value is in

Returns:

getStackIndex

public int getStackIndex()

Only needed if a stacked-barchart entry was highlighted. References the selected value within the stacked-entry.

Returns:

isStacked

public boolean isStacked()

getAxis

public YAxis.AxisDependency getAxis()

Returns the axis the highlighted value belongs to.

Returns:

setDraw

public void setDraw(float x,
                    float y)

Sets the x- and y-position (pixels) where this highlight was last drawn.

Parameters:

x -

y -

getDrawX

public float getDrawX()

Returns the x-position in pixels where this highlight object was last drawn.

Returns:

getDrawY

public float getDrawY()

Returns the y-position in pixels where this highlight object was last drawn.

Returns:

equalTo

public boolean equalTo(Highlight h)

Returns true if this highlight object is equal to the other (compares xIndex and dataSetIndex)

Parameters:

h -

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object