Class LineController

Controller class for bar and line charts.

Hierarchy

Controller
- LineController

Index

Constructors

Properties

requiredConfigWithValue axisController svgChart config

Methods

onDrawSerie onDrawStart #getCurvedPathFromPoints #closePath #getStraightPathFromPoints onConfigBefore onFocusedValueDisplay onDraw onDrawEnd onConfigAfter onConfigSerieBefore onConfigSerieAfter

Constructors

constructor

new LineController(svgChart, axisController?): LineController
Parameters
- svgChart: SvgChart
  
  SvgChart instance.
- Optional axisController: XYHorVertAxisController
Returns LineController
Overrides Controller.constructor
- Defined in charts/line_chart_controller.ts:17

Properties

`Static` requiredConfigWithValue

requiredConfigWithValue: {} = {}

Type declaration

axisController

axisController: XYHorVertAxisController

svgChart

svgChart: SvgChart

config

config: SvgChartConfig

Methods

onDrawSerie

onDrawSerie(serie, serieIndex, serieGroup): void
Draws chart element for this serie and attached it to the serieGroup. Overrides base class method.
Parameters
- serie: ChartConfigSerie
  
  Serie object.
- serieIndex: number
  
  Serie index.
- serieGroup: SVGElement
  
  DOM group element for this serie.
Returns void
Overrides Controller.onDrawSerie
- Defined in charts/line_chart_controller.ts:35

onDrawStart

onDrawStart(currentSerieGroupElement): void
Do things at the start of the draw for this chart.
Parameters
- currentSerieGroupElement: SVGElement
  
  DOM group element.
Returns void
Overrides Controller.onDrawStart
- Defined in charts/line_chart_controller.ts:115

`Private` #getCurvedPathFromPoints

#getCurvedPathFromPoints(points): any[]
Helper function to get a curved path from an array of points.
Parameters
- points: ChartPoint[]
  
  Array of points.
Returns any[]
Array of curved path coordinates.
- Defined in charts/line_chart_controller.ts:125

`Private` #closePath

#closePath(path, points): void
Closes path for filled line charts.
Parameters
- path: any[]
  
  Array of path coordinates
- points: ChartPoint[]
  
  Array of points
Returns void
- Defined in charts/line_chart_controller.ts:145

`Private` #getStraightPathFromPoints

#getStraightPathFromPoints(points): any[]
Helper function to get a straight path for line charts.
Parameters
- points: ChartPoint[]
  
  Array of points.
Returns any[]
Array of path coordinates.
- Defined in charts/line_chart_controller.ts:162

onConfigBefore

onConfigBefore(): void
Execute config things before global config things are done.

Returns void
Overrides Controller.onConfigBefore
- Defined in charts/line_chart_controller.ts:180

onFocusedValueDisplay

onFocusedValueDisplay(configSerie, serieIndex, dataIndex): string
Returns HTML string to display when an item has received focus.
Parameters
- configSerie: ChartConfigSerie
  
  Config serie for which to display the value.
- serieIndex: number
  
  Index of the serie.
- dataIndex: number
  
  Index of the data.
Returns string
The HTML string to display.
Inherited from Controller.onFocusedValueDisplay
- Defined in charts/controller.ts:37

onDraw

onDraw(currentSerieGroupElement): void
Draws chart.

Calls:
- onDrawStart - Called once at the beginning of the drawing.
- onDrawSerie - Called for each serie.
- onDrawEnd - Called once at the end of the drawing.
Parameters
- currentSerieGroupElement: SVGElement
  
  Group element where the chart can be appended to.
Returns void
Inherited from Controller.onDraw
- Defined in charts/controller.ts:51

onDrawEnd

onDrawEnd(currentSerieGroupElement): void
Do things at the end of the draw for this chart.
Parameters
- currentSerieGroupElement: SVGElement
  
  DOM group element.
Returns void
Inherited from Controller.onDrawEnd
- Defined in charts/controller.ts:78

onConfigAfter

onConfigAfter(): void
Execute config things after global config things are done.

Returns void
Inherited from Controller.onConfigAfter
- Defined in charts/controller.ts:99

onConfigSerieBefore

onConfigSerieBefore(serie): void
Execute serie config things before global config serie things are done.
Parameters
- serie: ChartConfigSerie
  
  Serie object
Returns void
Inherited from Controller.onConfigSerieBefore
- Defined in charts/controller.ts:106

onConfigSerieAfter

onConfigSerieAfter(serie): void
Execute config things after global config things are done.
Parameters
- serie: ChartConfigSerie
  
  Serie object
Returns void
Inherited from Controller.onConfigSerieAfter
- Defined in charts/controller.ts:113

Generated using TypeDoc