Methods
This section describes the methods that can be used in code to manipulate objects related to the dxSparkline widget.
beginUpdate()
Prevents the component from refreshing until the endUpdate method is called.
The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you are changing multiple component settings at once.
element()
Returns the root HTML element of the widget.
The root element of the widget.
endUpdate()
Enables the component to refresh after the beginUpdate method call.
The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when you change multiple component setting at once.
instance()
Returns an instance of this component class.
An instance of this component class
Use this method to access other methods of the component.
off(eventName)
Detaches all event handlers from the specified event.
off(eventName, eventHandler)
Detaches a particular event handler from the specified event.
on(eventName, eventHandler)
Subscribes to a specified event.
The name of the event to be subscribed.
An event handler for the specified event.
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.
An object of the following structure: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events at one method call. Available events are listed in the Events section.
See Also
option()
Returns the configuration options of this component.
An object representing the configuration options of this component.
option(optionName)
Gets the value of the specified configuration option of this component.
The name of the option to get.
The value of the specified option.
If you need to get the value of a configuration option field, specify the path to the required field.
option(optionName, optionValue)
Sets a value to the specified configuration option of this component.
The name of the required option.
The value you wish to assign to the required option.
To set a value to the configuration option field, specify the path to the required field.
option(options)
Sets one or more options of this component.
An object containing the required configuration options.
render()
Redraws a widget.
In order to be displayed correctly when the size of the parent window or container is changed, a widget should be rerendered manually. To rerender the widget, call the render() method.
svg()
Returns the widget's SVG markup.
The widget's SVG markup.