Chart

WIP description for Chart

getDataPointIndex ( event: Event)

Returns Datapoint index of point clicked from chart

Parameters
Name Type Description
event Event User MouseEvent

removeAnnotations ( id: String )

Removes an annotation from the chart

Parameters
Name Type Description
id String The id or ids of the annotations to remove

setAnnotations ( data: Object )

Adds or updates an annotation on the chart

Parameters
Name Type Description
data Object Object with annotations keyed by their ids

setColors ( colors: Array )

Sets the colors used when rendering the diagram

Parameters
Name Type Description
colors Array Array of of colors. For Radar and Line charts, colors can be objects with properties backgroundColor, borderColor, pointBackgroundColor, pointBorderColor, pointHoverBackgroundColor, pointHoverBorderColor

setData ( data: Array , options: Object )

Sets the data set that will be used to populate the chart

Parameters
Name Type Description
data Array The data set to be used to populate the chart
options Object Options object for setting data, label and set attribute names

setQuery ( queryName: String )

Sets the query used to populate the chart.

Parameters
Name Type Description
queryName String The name of the query.

show ( )

Shows the widget.

showTooltip ( idx: Number )

Displays tooltip on datapoint of chart

Parameters
Name Type Description
idx Number The idx used to select datapoint on chart

blur ( )

Triggers the blur event.

focus ( )

Triggers the focus event.

get ( name: String ) →{ Object }

Gets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
Returns

The property's value.

getId ( ) →{ ID }

Returns the ID of the widget.

Returns

The ID of the widget

getValue ( ) →{ Object }

Returns the widget's value.

Returns

The widget's value.

hide ( )

Hides the widget.

isEnabled ( ) →{ Boolean }

Returns true if the widget is enabled.

Returns

True if enabled, otherwise false.

isHidden ( ) →{ Boolean }

Returns true if the widget is hidden.

Returns

True if hidden, otherwise false.

set ( name: String , value: Object )

Sets the value of the specified property.

Parameters
Name Type Description
name String The name of the property.
value Object The new value.

setEnabled ( Enabled: Boolean )

Enables/disables the widget.

Parameters
Name Type Description
Enabled Boolean True to enable the widget, false to disable.

setStyle ( Object: Object )

Set the widget-style

Parameters
Name Type Description
Object Object properties

setValue ( value: Object )

Sets the widget's value.

Parameters
Name Type Description
value Object The new value.

Widgets