import Chart from 'd-theia/src/components/Chart.js'

public class | source

Chart

Direct Subclass:

AxisChart, BubbleChart

Indirect Subclass:

BarChart, LineChart

The Chart object is the parent class for all types of Chart. It is used to initialise all of the base settings universal to all charts.

Constructor Summary

Public Constructor
public	constructor(jConfig: Object, aData: Array, sContainer: String, dContainer: Object) Constructor function that sets up the local object.

Member Summary

Public Members
public	aData: Array The chart's data
public	d3Svg: Object SVG d3 object for d3 operations on the chart
public	dContainer: Object DOM reference to container element that wraps SVG
public	dLoader: Object DOM reference to loader display element
public	dSvg: Object SVG DOM object for displaying the chart
public	iHeight: Number The current calculated height of the chart
public	iInitialWidth: Number The width before any browser resize
public	iInnerHeight: Number The current calculated inner height of the chart
public	iInnerWidth: Number The current calculated inner width of the chart
public	iResizeOffset: *
public	iTransitionTime: Number Default time for d3 transitions on the chart
public	iWidth: Number The current calculated width of the chart
public	jConfig: Object The chart's config object
public	jPadding: Object The padding for the chart within the container
public	oChartOutWatcher: *
public	oResizeWatcher: *
public	oTooltip: Object Chart's tooltip object

Method Summary

Public Methods
public	init(): * Check chart is ready and render.
public	setConfig(jConfig: Object) Sets the local config options for the chart.
public	setContainer(dContainer: Object) Sets the local container object.
public	setData(aData: Array, bTransform: Boolean) Sets the local data for the chart.
public	setDimensions() Sets the local chart dimensions based on the size of the container.
public	updateConfig(jConfig: JSON) Updates the local config for the chart.
public	updateData(aData: Array, bTransform: Boolean) Updates the local data for the chart.

Public Constructors

public constructor(jConfig: Object, aData: Array, sContainer: String, dContainer: Object) source

Constructor function that sets up the local object.

Params:

Name	Type	Attribute	Description
jConfig	Object		JSON configuration object
aData	Array		the data to be displayed
sContainer	String		Optional ID to select DOM object
dContainer	Object		Optional DOM object in place of ID

Public Members

public aData: Array source

The chart's data

Properties:

Name	Type	Attribute	Description
aData	*

public d3Svg: Object source

SVG d3 object for d3 operations on the chart

Properties:

Name	Type	Attribute	Description
d3Svg	*

public dContainer: Object source

DOM reference to container element that wraps SVG

Properties:

Name	Type	Attribute	Description
dContainer	*

public dLoader: Object source

DOM reference to loader display element

Properties:

Name	Type	Attribute	Description
dLoader	*

public dSvg: Object source

SVG DOM object for displaying the chart

Properties:

Name	Type	Attribute	Description
dSvg	*

public iHeight: Number source

The current calculated height of the chart

Properties:

Name	Type	Attribute	Description
iHeight	*

public iInitialWidth: Number source

The width before any browser resize

Properties:

Name	Type	Attribute	Description
iInitialWidth	*

public iInnerHeight: Number source

The current calculated inner height of the chart

Properties:

Name	Type	Attribute	Description
iInnerHeight	*

public iInnerWidth: Number source

The current calculated inner width of the chart

Properties:

Name	Type	Attribute	Description
iInnerWidth	*

public iResizeOffset: * source

public iTransitionTime: Number source

Default time for d3 transitions on the chart

Properties:

Name	Type	Attribute	Description
iTransitionTime	*

public iWidth: Number source

The current calculated width of the chart

Properties:

Name	Type	Attribute	Description
iWidth	*

public jConfig: Object source

The chart's config object

Properties:

Name	Type	Attribute	Description
jConfig	*

public jPadding: Object source

The padding for the chart within the container

Properties:

Name	Type	Attribute	Description
jPadding	*

public oChartOutWatcher: * source

public oResizeWatcher: * source

public oTooltip: Object source

Chart's tooltip object

Properties:

Name	Type	Attribute	Description
oTooltip	*

Public Methods

public init(): * source

Check chart is ready and render.

Return:

Throw:

Error

chart not ready for initialisation

public setConfig(jConfig: Object) source

Sets the local config options for the chart.

Params:

Name	Type	Attribute	Description
jConfig	Object		JSON configuration object

Throw:

Error

missing configuration

public setContainer(dContainer: Object) source

Sets the local container object.

Params:

Name	Type	Attribute	Description
dContainer	Object		Required DOM element

Throw:

Error

invalid DOM element

public setData(aData: Array, bTransform: Boolean) source

Sets the local data for the chart.

Params:

Name	Type	Attribute	Description
aData	Array		array of JSON objects
bTransform	Boolean		transform mapped data

Throw:

Error

missing data

public setDimensions() source

Sets the local chart dimensions based on the size of the container.

Throw:

Error

missing DOM element

public updateConfig(jConfig: JSON) source

Updates the local config for the chart.

Params:

Name	Type	Attribute	Description
jConfig	JSON		config JSON style object

public updateData(aData: Array, bTransform: Boolean) source

Updates the local data for the chart.

Params:

Name	Type	Attribute	Description
aData	Array		array of JSON objects
bTransform	Boolean		transform mapped data