Methods

This section describes methods that can be used in code to manipulate the Exporter widget.

All the methods listed in this section should be called of the Exporter widget's instance. To obtain it, use the following construction.

JavaScript
var exporter = $('#exporterContainer').dxExporter('instance');

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

endUpdate()

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

Main article: beginUpdate()

See Also

exportTo(fileName, format)

Exports a DevExtreme data visualization widget into a file with a specified name and format.

Parameters:
fileName: String
The name of a destination file.
format: String
A required format.

To specify the widget that should be exported, use the sourceContainer option. Refer to the exportFormat option description to learn more about the formats available for exporting into.

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 the value of the specified configuration option of the widget.

Parameters:
optionName: String
The name of the option to get.
Return Value: any
The value of the specified option.
See Also

option(optionName, optionValue)

Sets a value to the specified configuration option of the widget.

Parameters:
optionName: String
The name of the required option.
optionValue: any
The value to be assigned to the required option.
See Also

option(options)

Sets one or more options.

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

print()

Calls the browser's print window.

To specify the widget that should be printed, use the sourceContainer option.

See Also