Class BarHighlighter

Created by philipp on 10/06/16.

Hierarchy (View Summary)

ChartHighlighter<BarDataProvider>
- BarHighlighter
  - HorizontalBarHighlighter

Index

Constructors

constructor

new BarHighlighter(chart: BarDataProvider): BarHighlighter
Parameters
- chart: BarDataProvider
Returns BarHighlighter
Overrides ChartHighlighter.constructor
- Defined in packages/ui-chart/highlight/BarHighlighter.d.ts:7

Properties

`Protected`mChart

mChart: BarDataProvider

instance of the data-provider

`Protected`mHighlightBuffer

mHighlightBuffer: Highlight<Entry>[]

buffer for storing previously highlighted values

Methods

`Protected`buildHighlights

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>[]
Inherited from ChartHighlighter.buildHighlights
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:65

`Protected`getChartData

getChartData(): BarData
Returns BarData
Overrides ChartHighlighter.getChartData
- Defined in packages/ui-chart/highlight/BarHighlighter.d.ts:8

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>
Inherited from ChartHighlighter.getClosestHighlightByPixel
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:78

`Protected`getClosestStackIndex

getClosestStackIndex(ranges: any[], value: any): number
Returns the index of the closest value inside the values array / ranges (stacked barchart) to the value given as a parameter.
Parameters
- ranges: any[]
- value: any
Returns number
- Defined in packages/ui-chart/highlight/BarHighlighter.d.ts:30

`Protected`getData

getData(): BarData
Returns BarData
Overrides ChartHighlighter.getData
- Defined in packages/ui-chart/highlight/BarHighlighter.d.ts:32

`Protected`getDistance

getDistance(x1: any, y1: any, x2: any, y2: any): number
Calculates the distance between the two given points.
Parameters
- x1: any
- y1: any
- x2: any
- y2: any
Returns number
Overrides ChartHighlighter.getDistance
- Defined in packages/ui-chart/highlight/BarHighlighter.d.ts:31

getHighlight

getHighlight(x: number, y: number): Highlight<Entry>[]
Returns a Highlight object corresponding to the given x- and y- touch positions in pixels.
Parameters
- x: number
- y: number
Returns Highlight<Entry>[]
Overrides ChartHighlighter.getHighlight
- Defined in packages/ui-chart/highlight/BarHighlighter.d.ts:9

`Protected`getHighlightForX

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>[]
Inherited from ChartHighlighter.getHighlightForX
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:35

`Protected`getHighlightPos

getHighlightPos(h: Highlight): number
Parameters
- h: Highlight
Returns number
Inherited from ChartHighlighter.getHighlightPos
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:46

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>[]
Inherited from ChartHighlighter.getHighlightsAtXValue
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:55

`Protected`getMinimumDistance

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
- closestValues: Highlight<Entry>[]
- pos: any
- axis: any
Returns number
Inherited from ChartHighlighter.getMinimumDistance
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:45

getStackedHighlight

getStackedHighlight(
    high: Highlight,
    set: IBarDataSet,
    touchX: any,
    touchY: any,
    xVal: any,
    yVal: any,
): Highlight
This method creates the Highlight object that also indicates which value of a stacked BarEntry has been selected.
Parameters
- high: Highlight
  the Highlight to work with looking for stacked values
- set: IBarDataSet
- touchX: any
- touchY: any
- xVal: any
- yVal: any
Returns Highlight
- Defined in packages/ui-chart/highlight/BarHighlighter.d.ts:20

`Protected`getValsForTouch

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
Inherited from ChartHighlighter.getValsForTouch
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:26

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>[]
Inherited from ChartHighlighter.sortedHighlights
- Defined in packages/ui-chart/highlight/ChartHighlighter.d.ts:90

Class BarHighlighter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BarHighlighter

Properties

ProtectedmChart

ProtectedmHighlightBuffer

Methods

ProtectedbuildHighlights

Parameters

Returns Highlight<Entry>[]

ProtectedgetChartData

Returns BarData

getClosestHighlightByPixel

Parameters

Returns Highlight<Entry>

ProtectedgetClosestStackIndex

Parameters

Returns number

ProtectedgetData

Returns BarData

ProtectedgetDistance

Parameters

Returns number

getHighlight

Parameters

Returns Highlight<Entry>[]

ProtectedgetHighlightForX

Parameters

Returns Highlight<Entry>[]

ProtectedgetHighlightPos

Parameters

Returns number

getHighlightsAtXValue

Parameters

Returns Highlight<Entry>[]

ProtectedgetMinimumDistance

Parameters

Returns number

getStackedHighlight

Parameters

Returns Highlight

ProtectedgetValsForTouch

Parameters

Returns any

sortedHighlights

Parameters

Returns Highlight<Entry>[]

Settings

On This Page

`Protected`mChart

`Protected`mHighlightBuffer

`Protected`buildHighlights

`Protected`getChartData

`Protected`getClosestStackIndex

`Protected`getData

`Protected`getDistance

`Protected`getHighlightForX

`Protected`getHighlightPos

`Protected`getMinimumDistance

`Protected`getValsForTouch