ChartJS

The ChartJS Class provides properties, methods, and events to interface with the HTML tags generated by the <silk:Chart> tag. This objects extends the functionality of Chart.js object (https://www.chartjs.org).

Kind: global class

Properties

Name	Type	Description
$target	Object	jQuery object referencing the HTMLtag wraping the chart.
$canvas	Object	jQuery object referencing chart's canvas.
$title	Object	jQuery object referencing chart's title.
$chartObject	Object	jQuery object referencing chart's object.

Methods and Event

new ChartJS(id, option)

Returns a ChartJS instance.

Param	Type	Default	Description
id	String		Unique identifier.
option	Object		Object containing the configuration.
[option.chartType]	String	bar	The chart type from https://www.chartjs.org/docs/latest/charts/area.html. The default value is "bar".
[option.dataSource]	String		Unique identifier of the dataProvider used to fill the Chart.
[option.labelColumn]	String		The name of the column which defines the char's labels.
[option.dataColumn]	String		The name of the column which defines the char's data.
[option.backgroundColor]	String	#1886C1	The chart's background color.
[option.showGrid]	String	true	Defines if the char will have a grid.
[option.showLegend]	String	false	Defines if the char will show the lagend.
[option.indexAxis]	String	x	Sets the chart's index axis.
[option.tooltip]	String	true	Defines if the char will show the tooltips.
[option.dataLabels]	String	true	Defines if the char will show data labels.

hide()

Method to hide the chart.

Kind: instance method of ChartJS

load()

This method loads the data from the dataSource and generates the chart.

Kind: instance method of ChartJS

on

Extends the "on" method from the eventManager Class.

Kind: instance property of ChartJS

Param	Type	Description
eventName	String	The event's name.
eventFunction	function	The function to be triggered.

setTitle(title)

Method to sets the Chart's title.

Kind: instance method of ChartJS

Param	Description
title	The chart's title.

show()

Method to show the chart after being hidden.

Kind: instance method of ChartJS

toggle(mode)

Method to toggle the chart between hidden and displayed.

Kind: instance method of ChartJS

Param	Description
mode	True is show, false is hide.

on:afterLoad

Event triggered after ChartJS has loaded data. Created with the ChartJS.on("afterLoad", function(){}) method.

Kind: event emitted by ChartJS

on:beforeLoad

Event triggered before the ChartJS loads data. Created with the ChartJS.on("beforeLoad", function(){}) method.

Kind: event emitted by ChartJS

on:click (index, value, label)

Event triggered when a ChartJS data segment is clicked. Created with the ChartJS.on("click", function(index,value,label){}) method.

Kind: event emitted by ChartJS

Param	Type	Description
index	Integer	The dataSource index providing data for the selected element.
value	Numeric	The numeric value of the selected element.
label	String	The label of the selected element.

on:resize (size)

Event triggered when a ChartJS get resized. Created with the ChartJS.on("resize", function(size){}) method.

Kind: event emitted by ChartJS

Param	Type	Description
size	Object	The chart's new size.