com.github.mikephil.charting.highlight

Class ChartHighlighter<T extends BarLineScatterCandleBubbleDataProvider>

java.lang.Object

com.github.mikephil.charting.highlight.ChartHighlighter<T>

All Implemented Interfaces:

IHighlighter

Direct Known Subclasses:

BarHighlighter, CombinedHighlighter

public class ChartHighlighter<T extends BarLineScatterCandleBubbleDataProvider>
extends java.lang.Object
implements IHighlighter

Created by Philipp Jahoda on 21/07/15.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	mChart instance of the data-provider
protected java.util.List<Highlight>	mHighlightBuffer buffer for storing previously highlighted values

Constructor Summary

Constructors

Constructor and Description
ChartHighlighter(T chart)

Method Summary

Modifier and Type	Method and Description
protected java.util.List<Highlight>	buildHighlights(IDataSet set, int dataSetIndex, float xVal, DataSet.Rounding rounding) An array of `Highlight` objects corresponding to the selected xValue and dataSetIndex.
Highlight	getClosestHighlightByPixel(java.util.List<Highlight> closestValues, float x, float y, YAxis.AxisDependency axis, float minSelectionDistance) Returns the Highlight of the DataSet that contains the closest value on the y-axis.
protected BarLineScatterCandleBubbleData	getData()
protected float	getDistance(float x1, float y1, float x2, float y2) Calculates the distance between the two given points.
Highlight	getHighlight(float x, float y) Returns a Highlight object corresponding to the given x- and y- touch positions in pixels.
protected Highlight	getHighlightForX(float xVal, float x, float y) Returns the corresponding Highlight for a given xVal and x- and y-touch position in pixels.
protected float	getHighlightPos(Highlight h)
protected java.util.List<Highlight>	getHighlightsAtXValue(float xVal, float x, float y) Returns a list of Highlight objects representing the entries closest to the given xVal.
protected float	getMinimumDistance(java.util.List<Highlight> closestValues, float pos, YAxis.AxisDependency axis) Returns the minimum distance from a touch value (in pixels) to the closest value (in pixels) that is displayed in the chart.
protected MPPointD	getValsForTouch(float x, float y) Returns a recyclable MPPointD instance.

Methods inherited from class java.lang.Object

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

Field Detail

mChart

protected T extends BarLineScatterCandleBubbleDataProvider mChart

instance of the data-provider

mHighlightBuffer

protected java.util.List<Highlight> mHighlightBuffer

buffer for storing previously highlighted values

Constructor Detail

ChartHighlighter

public ChartHighlighter(T chart)

Method Detail

getHighlight

public Highlight getHighlight(float x,
                              float y)

Description copied from interface: IHighlighter

Returns a Highlight object corresponding to the given x- and y- touch positions in pixels.

Specified by:

getHighlight in interface IHighlighter

Returns:

getValsForTouch

protected MPPointD getValsForTouch(float x,
                                   float y)

Returns a recyclable MPPointD instance. Returns the corresponding xPos for a given touch-position in pixels.

Parameters:

x -

y -

Returns:

getHighlightForX

protected Highlight getHighlightForX(float xVal,
                                     float x,
                                     float y)

Returns the corresponding Highlight for a given xVal and x- and y-touch position in pixels.

Parameters:

xVal -

x -

y -

Returns:

getMinimumDistance

protected float getMinimumDistance(java.util.List<Highlight> closestValues,
                                   float pos,
                                   YAxis.AxisDependency axis)

Returns the minimum distance from a touch value (in pixels) to the closest value (in pixels) that is displayed in the chart.

Parameters:

closestValues -

pos -

axis -

Returns:

getHighlightPos

protected float getHighlightPos(Highlight h)

getHighlightsAtXValue

protected java.util.List<Highlight> getHighlightsAtXValue(float xVal,
                                                          float x,
                                                          float y)

Returns a list of Highlight objects representing the entries closest to the given xVal. The returned list contains two objects per DataSet (closest rounding up, closest rounding down).

Parameters:

xVal - the transformed x-value of the x-touch position

x - touch position

y - touch position

Returns:

buildHighlights

protected java.util.List<Highlight> buildHighlights(IDataSet set,
                                                    int dataSetIndex,
                                                    float xVal,
                                                    DataSet.Rounding rounding)

An array of `Highlight` objects corresponding to the selected xValue and dataSetIndex.

Parameters:

set -

dataSetIndex -

xVal -

rounding -

Returns:

getClosestHighlightByPixel

public Highlight getClosestHighlightByPixel(java.util.List<Highlight> closestValues,
                                            float x,
                                            float y,
                                            YAxis.AxisDependency axis,
                                            float minSelectionDistance)

Returns the Highlight of the DataSet that contains the closest value on the y-axis.

Parameters:

closestValues - contains two Highlight objects per DataSet closest to the selected x-position (determined by rounding up an down)

x -

y -

axis - the closest axis

minSelectionDistance -

Returns:

getDistance

protected float getDistance(float x1,
                            float y1,
                            float x2,
                            float y2)

Calculates the distance between the two given points.

Parameters:

x1 -

y1 -

x2 -

y2 -

Returns:

getData

protected BarLineScatterCandleBubbleData getData()