Methods

This section describes the methods that can be used in code to manipulate objects related to the Sparkline widget.

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

element()

Gets the root element of the widget.

Return Value: jQuery
The root element of the widget.
See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports the widget into a document with a specified name and format.

Parameters:
fileName: String
The name of a destination file.
format: String
A required format.
Accepted Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
See Also

getDataSource()

Returns the DataSource instance.

Return Value: DataSource
The DataSource instance.
NOTE
This method returns the DataSource instance even if the dataSource option of the widget was given a simple array.
See Also

instance()

Returns this widget's instance. Use it to access other methods of the widget.

Return Value: Object
This widget's instance.
See Also

off(eventName)

Detaches all event handlers from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
Return Value: Object
The object for which this method is called.
See Also

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

Parameters:
eventName: String
The name of the event to unsubscribe from.
eventHandler: function
The handler to be detached from the specified event.
Return Value: Object
The object for which this method is called.
See Also

on(eventName, eventHandler)

Subscribes to a specified event.

Parameters:
eventName: String
The name of the event to be subscribed.
eventHandler: function
An event handler for the specified event.
Return Value: Object
The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to the specified events.

Parameters:
events: Object
An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}
Return Value: Object
The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

option()

Gets the widget's options.

Return Value: Object
The widget's options.
See Also

option(optionName)

Gets a specific option value.

Parameters:
optionName: String
The option name or the full path to the option.
Return Value: any
This option value.
See Also

option(optionName, optionValue)

Assigns a new value to a specific option.

Parameters:
optionName: String
The option name or the full path to the option.
optionValue: any
A new value for this option.
See Also

option(options)

Sets one or more options.

Parameters:
options: Object
The options along with their new values.
See Also

print()

Opens the browser's print window.

See Also

render()

Redraws the widget.

Normally, the widget will redraw itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, e.g., after the widget container is resized. For this purpose, call the render() method.

See Also

svg()

Returns the widget's SVG markup.

Return Value: String
The widget's SVG markup.