API

Index

Enumerations

• AxisOrientation

• DataContainerEventType

• DataDisplayType

• DataScaleType

• GridLines

• LabelPosition

• LegendAlignment

• LegendSeriesType

Classes

• AreaChartView

• AxisView

• BarChartView

• ChartGridView

• ChartView

• ChartZoomView

• DataContainer

• DataContainerExtension

• DataContainerTooltipExtension

• DataContainerTransformExtension

• LabelsHelper

• LegendView

• LineChartView

• PieChartView

Interfaces

• AreaChartViewProps

• AreaChartViewStyle

• AxisParameters

• AxisPoint

• AxisViewProps

• AxisViewStyle

• BackgroundLayout

• BarChartViewProps

• BarChartViewStyle

• CanvasPosition

• ChartGridViewProps

• ChartGridViewStyle

• ChartPointerEvent

• ChartViewProps

• ChartZoomViewProps

• ChartZoomViewStyle

• DataContainerEvent

• DataContainerTooltipExtensionOptions

• DataContainerTransformExtensionOptions

• DataSeries

• LabelOptions

• LegendDataSeries

• LegendViewProps

• LegendViewStyle

• LineChartViewProps

• LineChartViewStyle

• LineChartViewStylePart

• LineEntry

• MinLineChartChunkLength

• NormalizedXYPoint

• PerformanceResults

• PieChartFragmentChunk

• PieChartLayout

• PieChartViewProps

• PieChartViewStyle

• PieFragment

• ScaleFunction

• ScaleFunctions

• SimpleOnScaleListenerArgs

• TooltipEvent

• ViewPoint

• XYPoint

• YValuesMatch

Type aliases

• AreaSelectEvent

• AxisLabelAccessor

• DataChangeEvent

• DataContainerEventListener

• DataContainerEvents

• DataNormalizer

• DeepPartial

• GetScalesEvent

• PointAccessor

• SimpleOnScaleListener

• TooltipEventHandler

Variables

• TOOLTIP_EXTENSION

• TRANSFORM_EXTENSION

• VIEW_TAG

• X_SCALE_BAR_OFFSET

• performanceResults

Functions

• calculateMinLineLength

• defaultNormalizeData

• findBestMatchInSortedArray

• floorToNearest

• getContinuousNumericScale

• getPaint

• isTupleOfNumbers

• isXYArray

• mergeXY

• performanceCounter

• precision

• prepareAxisPoints

• prepareAxisValues

• roundToNearest

• segmentizePoints

Object literals

• DEFAULT_OPTIONS

• defaultStyle

• labelPaintOverrides

Type aliases

AreaSelectEvent

Ƭ AreaSelectEvent: DataContainerEvent‹AREA_SELECT, Rect | undefined›

---

AxisLabelAccessor

Ƭ AxisLabelAccessor: function

Type declaration:

▸ (value: number, index: number): string

Parameters:

Name	Type
value	number
index	number

---

DataChangeEvent

Ƭ DataChangeEvent: DataContainerEvent‹DATA_CHANGE›

---

DataContainerEventListener

Ƭ DataContainerEventListener: function

Type declaration:

▸ (action: DataContainerEvent‹T, P›): P

Parameters:

Name	Type
action	DataContainerEvent‹T, P›

---

DataContainerEvents

Ƭ DataContainerEvents: DataChangeEvent | GetScalesEvent | AreaSelectEvent

---

DataNormalizer

Ƭ DataNormalizer: function

Type declaration:

▸ (point: XYPoint): NormalizedXYPoint

Parameters:

Name	Type
point	XYPoint

---

DeepPartial

Ƭ DeepPartial: object

Type declaration:

---

GetScalesEvent

Ƭ GetScalesEvent: DataContainerEvent‹GET_SCALES, ScaleFunctions›

---

PointAccessor

Ƭ PointAccessor: function

Type declaration:

▸ (point: DataPoint, index: number, series: DataPoint[]): XYPoint

Parameters:

Name	Type
point	DataPoint
index	number
series	DataPoint[]

---

SimpleOnScaleListener

Ƭ SimpleOnScaleListener: function

Type declaration:

▸ (args: SimpleOnScaleListenerArgs): void

Parameters:

Name	Type
args	SimpleOnScaleListenerArgs

---

TooltipEventHandler

Ƭ TooltipEventHandler: function

Type declaration:

▸ (event: TooltipEvent): void

Parameters:

Name	Type
event	TooltipEvent

Variables

Const TOOLTIP_EXTENSION

• TOOLTIP_EXTENSION: "DataContainerTooltipExtension" = "DataContainerTooltipExtension"

---

Const TRANSFORM_EXTENSION

• TRANSFORM_EXTENSION: "DataContainerTransformExtension" = "DataContainerTransformExtension"

---

Const VIEW_TAG

• VIEW_TAG: "LineChartView" = "LineChartView"

---

Const X_SCALE_BAR_OFFSET

• X_SCALE_BAR_OFFSET: 0.5 = 0.5

---

Const performanceResults

• performanceResults: Record‹string, PerformanceResults›

Functions

Const calculateMinLineLength

▸ calculateMinLineLength(start: number, end: number, scale: ScaleFunction, customMinLength?: MinLineChartChunkLength): number

Parameters:

Name	Type
start	number
end	number
scale	ScaleFunction
customMinLength?	MinLineChartChunkLength

Returns: number

---

Const defaultNormalizeData

▸ defaultNormalizeData(__namedParameters: object): object | object

Parameters:

▪ __namedParameters: object

Name	Type
x	number
y	number

Returns: object | object

---

Const findBestMatchInSortedArray

▸ findBestMatchInSortedArray‹T›(array: T[], matcher: function): T | undefined

Type parameters:

▪ T

Parameters:

▪ array: T[]

▪ matcher: function

▸ (element: T): number

Parameters:

Name	Type
element	T

Returns: T | undefined

---

Const floorToNearest

▸ floorToNearest(value: number, nearest: number): number

Parameters:

Name	Type
value	number
nearest	number

Returns: number

---

Const getContinuousNumericScale

▸ getContinuousNumericScale(scaleType: DataScaleType): ScaleContinuousNumeric‹number, number›

Parameters:

Name	Type
scaleType	DataScaleType

Returns: ScaleContinuousNumeric‹number, number›

---

Const getPaint

▸ getPaint‹P›(paint: P, contrastPaint: P | undefined, backgroundIsBright: boolean): P

Type parameters:

▪ P: Paint | undefined

Parameters:

Name	Type
paint	P
contrastPaint	P | undefined
backgroundIsBright	boolean

Returns: P

---

Const isTupleOfNumbers

▸ isTupleOfNumbers(value: unknown): value is [number, number]

Parameters:

Name	Type
value	unknown

Returns: value is [number, number]

---

Const isXYArray

▸ isXYArray(data: any): data is XYPoint‹any›[]

Parameters:

Name	Type
data	any

Returns: data is XYPoint‹any›[]

---

Const mergeXY

▸ mergeXY(x: number[], y: number[]): XYPoint[]

Parameters:

Name	Type
x	number[]
y	number[]

Returns: XYPoint[]

---

Const performanceCounter

▸ performanceCounter(name: string): end

Parameters:

Name	Type
name	string

Returns: end

---

Const precision

▸ precision(a: number): number

Parameters:

Name	Type
a	number

Returns: number

---

Const prepareAxisPoints

▸ prepareAxisPoints(axisValues: AxisPoint[], scale: ScaleFunction): AxisPoint[]

Parameters:

Name	Type
axisValues	AxisPoint[]
scale	ScaleFunction

Returns: AxisPoint[]

---

Const prepareAxisValues

▸ prepareAxisValues(scale: ScaleFunction, params: AxisParameters, seriesLength: number): AxisPoint[]

Parameters:

Name	Type	Default
scale	ScaleFunction	-
params	AxisParameters	-
seriesLength	number	10

Returns: AxisPoint[]

---

Const roundToNearest

▸ roundToNearest(value: number, nearest: number): number

Parameters:

Name	Type
value	number
nearest	number

Returns: number

---

Const segmentizePoints

▸ segmentizePoints‹In, Filter, Out›(data: XYPoint‹In›[], filterBy: Filter): XYPoint‹Out›[][]

Type parameters:

▪ In

▪ Filter

▪ Out

Parameters:

Name	Type
data	XYPoint‹In›[]
filterBy	Filter

Returns: XYPoint‹Out›[][]

Object literals

Const DEFAULT_OPTIONS

▪ DEFAULT_OPTIONS: object

▪ pan: object

• pointers: number = 1

▪ scale: object

• drag: true = true

• listenerThreshold: number = 1

• multitouch: true = true

• scroll: true = true

• selectArea: false = false

• limit: object

  • x: [number, number] = [1, 1]

  • y: [number, number] = [1, 1]

• minSelectedAreaThreshold: object

  • x: number = 50

  • y: number = 0

---

Const defaultStyle

▪ defaultStyle: object

alignment

• alignment: LegendAlignment = LegendAlignment.ROW

backgroundPaint

• backgroundPaint: Paint‹› = new Paint() .setLineWidth(1.5)

barRadius

• barRadius: number = 0

barWidth

• barWidth: number = 0.5

borders

• borders: Rect‹› = new Rect({left: 1, right: 1, top: 1, bottom: 1 })

innerRadius

• innerRadius: number = 0

isBackgroundBright

• isBackgroundBright: boolean = true

labelPadding

• labelPadding: number = 4

labelPaint

• labelPaint: Paint‹› = new Paint()

padding

• padding: number = 0

paint

• paint: Paint‹› = new Paint().setFillStyle(rgba('#FFF', 0.5)).setStrokeStyle('#FFF')

paints

• paints: object

Type declaration:

type

• type: DataDisplayType = DataDisplayType.LINE

wrapLabelsOnEdge

• wrapLabelsOnEdge: boolean = true

▪ background: object

• paint: Paint‹› = new Paint() .setFillStyle(rgba('#FFF', .1))

• radius: number = 0

• width: number = 8

▪ foreground: object

• paint: Paint‹› = new Paint() .setFillStyle(rgba('#FFF', .5))

• radius: number = 0

• width: number = 8

▪ minChunkLength: object

• domain: number = 0

---

Const labelPaintOverrides

▪ labelPaintOverrides: object

textAlign

• textAlign: CENTER = TextAlign.CENTER

textBaseline

• textBaseline: BOTTOM = TextBaseline.BOTTOM