React Exporter API Deprecated

NOTE
This widget is deprecated. Instead of it, use the built-in client-side exporting. For further information, refer to the export option of a particular widget.

The Exporter widget allows you to export your chart, gauge or any other DevExtreme data visualization widget into an image or a document. The Exporter works in conjunction with other widgets and should not be used separately.

Type:

Object

To operate, Exporter requires the PhantomJS WebKit version 1.9.X, which allows you to use the client-server model where PhantomJS performs as a server. Refer to the Deploy a Server topic for details on how to setup your server.

When your server is ready, add Exporter onto your page.

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the Exporter widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery
JavaScript
HTML
$(function() {
    $("#exportMenu").dxExporter({
        // ...
        });
});
<div id="exportMenu"></div>
Angular
HTML
<dx-exporter></dx-exporter>
AngularJS
HTML
<div dx-exporter="{
    // ...
}"></div>
Knockout
HTML
<div data-bind="dxExporter: {
    // ...
}"></div>

Props

An object configuring options for the Exporter widget.

Name Description
exportFormat

Specifies a set of formats available for exporting into.
fileName

Specifies a name that should be assigned to the file with the exported widget.
onDisposing

A function that is executed before the widget is disposed of.
onInitialized

A function that is executed only once, after the widget is initialized.
onOptionChanged

A function that is executed after a widget option is changed.
printingEnabled

Specifies whether or not to enable printing operation.
serverUrl

Specifies the URL of the server that supplies the exporting service.
showMenu

Specifies whether to show the export menu or not.
sourceContainer

Specifies a div container that holds the widget to be exported.

Methods

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

Name Description
beginUpdate()

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

Refreshes the widget after a call of the beginUpdate() method.
exportTo(fileName, format)

Exports the widget.
instance()

Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all widget options.
option(optionName)

Gets the value of a single option.
option(optionName, optionValue)

Updates the value of a single option.
option(options)

Updates the values of several options.
print()

Calls the browser's print window.

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');

Events

This section describes events fired by this widget.

Name Description
disposing

Raised before the widget is disposed of.
initialized

Raised only once, after the widget is initialized.
optionChanged

Raised after a widget option is changed.

See Also