Although the DevExtreme Data Visualization widgets can be displayed in any browser on any platform, there are cases when printing a chart or having it as an image or a document may be necessary for an end user. For these cases, the DevExtreme Data Visualization widgets provide the client-side exporting and printing features. This guide shows how to use these features in the UI and in code.
To export or print a widget, a user clicks and selects a command from the drop-down menu that appears. The Print command opens the Print window in the browser that lets the user to select preferred printing options and to send the print job to the printer. The other commands save a file of the selected format on the user's local storage.
Exporting and printing in the UI are configured by the export object. The following exporting and printing characteristics can be changed using the fields of this object.
To enable exporting, assign true to the enabled field. With this setting, printing becomes available as well. If you need only exporting, disable printing by setting the printingEnabled field to false.
- Formats and File Name
By default, a user can export the widget into five formats: PNG, PDF, JPEG, SVG and GIF. To alter this set, use the formats option. In addition, you can change the default name for the file with the exported widget using the fileName option.
- Background Color
By default, the background of the widget is transparent. To fill it with a color of your choice, specify the backgroundColor option.
To export a widget in code, call its exportTo(fileName, format) method passing the needed file name and format ('PNG', 'PDF', 'JPEG', 'SVG' or 'GIF') as the arguments.
widgetInstance.exportTo('Test Chart', 'PDF');
Also, the DevExtreme Data Visualization widgets fire the following exporting-related events.