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(int x, float value, int dataIndex, int dataSetIndex) constructor
Highlight(int x, float value, int dataIndex, int dataSetIndex, int stackIndex) Constructor, only used for stacked-barchart.
Highlight(int x, float value, int dataIndex, int dataSetIndex, int stackIndex, Range range) Constructor, only used for stacked-barchart.
Highlight(int x, int dataSetIndex) Constructor, only used for stacked-barchart.

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)
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
Range	getRange() Returns the range of values the selected value of a stacked bar is in.
int	getStackIndex() Only needed if a stacked-barchart entry was highlighted.
float	getValue() returns the y-value of the highlighted value
int	getXIndex() returns the index of the highlighted value on the x-axis
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(int x,
                 float value,
                 int dataIndex,
                 int dataSetIndex)

constructor

Parameters:

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

value - the y-value of the highlighted value

dataIndex - the index of the Data the highlighted value belongs to

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

Highlight

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

Constructor, only used for stacked-barchart.

Parameters:

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

value - the y-value of the highlighted value

dataIndex - the index of the Data the highlighted value belongs to

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

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

Highlight

public Highlight(int x,
                 float value,
                 int dataIndex,
                 int dataSetIndex,
                 int stackIndex,
                 Range range)

Constructor, only used for stacked-barchart.

Parameters:

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

value - the y-value of the highlighted value

dataIndex - the index of the Data the highlighted value belongs to

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

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

range - the range the selected stack-value is in

Highlight

public Highlight(int x,
                 int dataSetIndex)

Constructor, only used for stacked-barchart.

Parameters:

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

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

Method Detail

getXIndex

public int getXIndex()

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

Returns:

getValue

public float getValue()

returns the y-value of the highlighted value

Returns:

getDataIndex

public int getDataIndex()

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

Returns:

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:

getRange

public Range getRange()

Returns the range of values the selected value of a stacked bar is in. (this is only relevant for stacked-barchart)

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