Vue Funnel - Client-Side Exporting and Printing

Although DevExtreme data visualization UI components can be displayed on any device, a user may need a UI component printed or in the form of a document. For these cases, the UI components provide client-side exporting and printing. This guide shows how to configure these features for the user, and how to export and print the Funnel UI component using the API.

User Interaction

To export or print the Funnel, a user clicks the "Exporting/Printing" button and selects a command from the drop-down menu. The Print command opens the browser's Print window that lets the user select preferred printing settings and send the print job to the printer. The other commands save a file of the selected format in the user's local storage.

Funnel Export Menu

You can enable both exporting and printing by setting the export.enabled property to true. If you need only exporting to be available to the user, disable printing by assigning false to the export.printingEnabled property.

App.vue
  • <template>
  • <DxFunnel ... >
  • <DxExport
  • :enabled="true"
  • :printing-enabled="false"
  • />
  • </DxFunnel>
  • </template>
  •  
  • <script>
  • import DxFunnel, { DxExport } from 'devextreme-vue/funnel';
  •  
  • export default {
  • components: {
  • DxFunnel,
  • DxExport
  • }
  • }
  • </script>

If you want to restrict the set of formats available for exporting, change the export.formats array. You can also specify the default name for the exported file using the fileName property.

App.vue
  • <template>
  • <DxFunnel ... >
  • <DxExport
  • :enabled="true"
  • :formats="exportFormats"
  • file-name="exported_funnel"
  • />
  • </DxFunnel>
  • </template>
  •  
  • <script>
  • import DxFunnel, { DxExport } from 'devextreme-vue/funnel';
  •  
  • export default {
  • components: {
  • DxFunnel,
  • DxExport
  • },
  • data() {
  • return {
  • exportFormats: ['PNG', 'JPEG']
  • }
  • }
  • }
  • </script>

API

To export the Funnel using the API, call the exportTo(fileName, format) method passing the needed file name and format ("PNG", "PDF", "JPEG", "SVG" or "GIF") as the arguments. To print the Funnel, call the print() method. This command opens the browser's Print window.

App.vue
  • <template>
  • <DxFunnel ref="funnel" />
  • </template>
  •  
  • <script>
  • import DxFunnel from 'devextreme-vue/funnel';
  •  
  • export default {
  • components: {
  • DxFunnel
  • },
  • methods: {
  • exportFunnel () {
  • return this.$refs.funnel.instance.exportTo('Exported Funnel', 'PDF');
  • },
  • printFunnel () {
  • return this.$refs.funnel.instance.print();
  • }
  • }
  • }
  • </script>

You can also export several UI components at once using their SVG markup. Gather the markup from all required UI components by calling the DevExpress.viz.getMarkup(widgetInstances) method, and then pass the markup to the DevExpress.viz.exportFromMarkup(markup, options) method.

App.vue
  • <template>
  • <DxFunnel ref="funnel1" />
  • <DxFunnel ref="funnel2" />
  • </template>
  •  
  • <script>
  • import DxFunnel from 'devextreme-vue/funnel';
  • import { getMarkup, exportFromMarkup } from "devextreme/viz/export";
  •  
  • export default {
  • components: {
  • DxFunnel
  • },
  • methods: {
  • exportSeveralFunnels () {
  • const funnel1 = this.$refs.funnel1.instance;
  • const funnel2 = this.$refs.funnel2.instance;
  • const funnelMarkup = getMarkup([funnel1, funnel2]);
  • exportFromMarkup(funnelMarkup, {
  • height: 768,
  • width: 1024,
  • fileName: "Exported Funnels",
  • format: "PDF"
  • });
  • }
  • }
  • }
  • </script>

Events

DevExtreme data visualization UI components raise the following exporting-related events.

  • exporting
    Allows you to request exporting details or prevent exporting.

  • exported
    Allows you to notify an end user when exporting is completed.

  • fileSaving
    Allows you to access exported data in the BLOB format and/or prevent it from being saved in a file on the user's local storage.

You can handle these events with functions. If the handling functions are not going to be changed at runtime, assign them to the onExporting, onExported and onFileSaving properties when you configure the UI component.

App.vue
  • <template>
  • <DxFunnel
  • @exporting="onExporting"
  • @exported="onExported"
  • @file-saving="onFileSaving"
  • />
  • </template>
  •  
  • <script>
  • import DxFunnel from 'devextreme-vue/funnel';
  •  
  • export default {
  • components: {
  • DxFunnel
  • },
  • methods: {
  • onExporting (e) {
  • // Handler of the "exporting" event
  • };
  • onExported (e) {
  • // Handler of the "exported" event
  • };
  • onFileSaving (e) {
  • // Handler of the "fileSaving" event
  • }
  • }
  • }
  • </script>
See Also