Class ChartHighlighter<T>

Created by philipp on 10/06/16.

Type Parameters

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

mChart mHighlightBuffer

Methods

buildHighlights getChartData getClosestHighlightByPixel getData getDistance getHighlight getHighlightForX getHighlightPos getHighlightsAtXValue getMinimumDistance getValsForTouch sortedHighlights

Constructors

constructor

Properties

ProtectedmChart

mChart: T

instance of the data-provider

ProtectedmHighlightBuffer

mHighlightBuffer: Highlight<Entry>[]

buffer for storing previously highlighted values

Methods

ProtectedbuildHighlights

  • buildHighlights(
        set: IDataSet<Entry>,
        dataSetIndex: any,
        touchX: any,
        touchY: any,
        xVal: any,
        rounding: any,
    ): Highlight<Entry>[]

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

    Parameters

    • set: IDataSet<Entry>
    • dataSetIndex: any
    • touchX: any
    • touchY: any
    • xVal: any
    • rounding: any

    Returns Highlight<Entry>[]

ProtectedgetChartData

getClosestHighlightByPixel

  • getClosestHighlightByPixel(
        closestValues: Highlight<Entry>[],
        x: number,
        y: number,
        minSelectionDistance: number,
        axis?: AxisDependency,
    ): Highlight<Entry>

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

    Parameters

    • closestValues: Highlight<Entry>[]

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

    • x: number
    • y: number
    • minSelectionDistance: number
    • Optionalaxis: AxisDependency

      the closest axis

    Returns Highlight<Entry>

ProtectedgetData

ProtectedgetDistance

  • getDistance(x1: number, y1: number, x2: number, y2: number): number

  • Calculates the distance between the two given points.

    Parameters

    • x1: number
    • y1: number
    • x2: number
    • y2: number

    Returns number

getHighlight

  • getHighlight(x: any, y: any): Highlight<Entry>[]

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

    Parameters

    • x: any
    • y: any

    Returns Highlight<Entry>[]

ProtectedgetHighlightForX

  • getHighlightForX(xVal: any, x: any, y: any): Highlight<Entry>[]

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

    Parameters

    • xVal: any
    • x: any
    • y: any

    Returns Highlight<Entry>[]

ProtectedgetHighlightPos

  • getHighlightPos(h: Highlight<Entry>): number

  • Parameters

    Returns number

getHighlightsAtXValue

  • getHighlightsAtXValue(xVal: any, x?: any, y?: any): Highlight<Entry>[]

  • 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: any

      the transformed x-value of the x-touch position

    • Optionalx: any
    • Optionaly: any

    Returns Highlight<Entry>[]

ProtectedgetMinimumDistance

  • getMinimumDistance(
        closestValues: Highlight<Entry>[],
        pos: any,
        axis: any,
    ): number

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

    Parameters

    Returns number

ProtectedgetValsForTouch

  • getValsForTouch(x: any, y: any): any

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

    Parameters

    • x: any
    • y: any

    Returns any

sortedHighlights

  • sortedHighlights(
        closestValues: Highlight<Entry>[],
        x: number,
        y: number,
        minSelectionDistance: number,
        axis?: AxisDependency,
    ): Highlight<Entry>[]

  • Returns sorted highlights based on distance to touch x,y

    Parameters

    • closestValues: Highlight<Entry>[]

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

    • x: number
    • y: number
    • minSelectionDistance: number
    • Optionalaxis: AxisDependency

      the closest axis

    Returns Highlight<Entry>[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods