Class BarController

Controller class for bar and line charts.

Hierarchy

Controller
- BarController

Index

Constructors

Properties

requiredConfigWithValue svgChart axisController #barCountPerColumn currentBarIndex stackedBarValues barWidth config

Accessors

barCountPerColumn

Methods

onDrawSerie onDrawStart onConfigBefore onConfigSerieBefore onFocusedValueDisplay onDraw onDrawEnd onConfigAfter onConfigSerieAfter

Constructors

constructor

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

Properties

`Static` requiredConfigWithValue

requiredConfigWithValue: {
xAxisGridColumns: boolean;
} = ...

Type declaration

xAxisGridColumns: boolean

svgChart

svgChart: SvgChart

axisController

axisController: XYHorVertAxisController

`Private` #barCountPerColumn

#barCountPerColumn: number

currentBarIndex

currentBarIndex: number

stackedBarValues

stackedBarValues: object

barWidth

barWidth: number

config

config: SvgChartConfig

Accessors

barCountPerColumn

get barCountPerColumn(): number
Returns number
- Defined in charts/bar_chart_controller.ts:26
set barCountPerColumn(value): void
Parameters
- value: number
Returns void
- Defined in charts/bar_chart_controller.ts:22

Methods

onDrawSerie

onDrawSerie(serie, serieIndex, serieGroup): void
Draws chart element for this serie and attached it to the serieGroup.
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/bar_chart_controller.ts:56

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/bar_chart_controller.ts:104

onConfigBefore

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

Returns void
Overrides Controller.onConfigBefore
- Defined in charts/bar_chart_controller.ts:121

onConfigSerieBefore

onConfigSerieBefore(serie): void
Execute serie config things before global config serie things are done.
Parameters
- serie: ChartConfigSerie
  
  Serie object
Returns void
Overrides Controller.onConfigSerieBefore
- Defined in charts/bar_chart_controller.ts:135

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

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