The requested page is not available for the requested platform. You are viewing the content for Default platform.

Exporting

The Web Dashboard control allows end-users to export an entire dashboard or individual dashboard items. You can export the dashboard/dashboard items to PDF and Image formats; additionally, you can export dashboard item's data to Excel/CSV. To learn more about basic exporting capabilities, see Printing and Exporting.

Exporting Dashboards

To export the entire dashboard, click the Printing_ExportElementButtonWeb button in the dashboard title and choose the required action.

Printing_ExportMenuWeb

Note

You can export only dashboard items when the Web Dashboard displays dashboards on mobile phones.

  • Export to PDF - Invokes a corresponding dialog that allows end-users to export a dashboard to a PDF file with specific options. The following options are available:

    ExportToPDF_DashboardOptions

    • File Name - Specifies the name of the exported PDF file.
    • Page Layout - Specifies the page orientation used to export a dashboard. You can select between Portrait, Landscape and Auto. Note that in the Auto mode the page orientation is selected automatically depending on the horizontal and vertical sizes of a dashboard.
    • Size - Specifies the standard paper size (for instance, Letter or A4).
    • Show Title - Specifies whether to apply the dashboard title to the exported document title.
    • Title - Specifies the title of the exported document.
    • Scale Mode - Specifies the mode for scaling when exporting a dashboard.
      Note

      Note that this option is in effect when Page Layout is set to value different from Auto.

    • Include | Filters - Allows you to include master filter values to the exported document.
    • Include | Parameters - Allows you to include parameter values to the exported document.
    • Position - Specifies the position of the master filter and parameter values in the exported document. You can select between Below and Separate Page.
  • Export to Image - Invokes a corresponding dialog that allows end-users to export a dashboard to image of the specified format. The following options are available:

    ExportToImage_DashboardOptions

    • File Name - Specifies the name of the exported Image file.
    • Show Title - Specifies whether to apply the dashboard title to the exported document title.
    • Title - Specifies the title of the exported document.
    • Image Format - Specifies the image format in which the dashboard is exported. The following formats are available: PNG, JPEG and GIF.
    • Resolution (dpi) - Specifies the resolution (in dpi) used to export a dashboard.
    • Include | Filters - Allows you to include master filter values to the exported document.
    • Include | Parameters - Allows you to include parameter values to the exported document.
  • Export to Excel - Invokes a corresponding dialog that allows end-users to export dashboard's data to the Excel file. The following options are available:

    ExportToExcel_DashboardOptions_Web

    • File Name - Specifies the name of the exported Image file.
    • Excel Format - Specifies the Excel workbook format in which the dashboard's data is exported. You can select between XLSX and XLS.
    • Include | Export Filters - Allows you to include master filter values to the exported document.
    • Include | Export Parameters - Allows you to include parameter values to the exported document.
    • Position - Specifies the position of the master filter and parameter values in the exported document. You can select between Below and Separate Sheet.

Specify the required options in the dialog and click the Export button to export the dashboard. To reset the changes to the default values, click the Reset button.

Exporting Dashboard Items

To export a dashboard item, click the Printing_ExportElementButtonWeb button in the dashboard item caption and choose the required action.

Printing_ExportElementWeb

  • Export to PDF - Invokes a corresponding dialog that allows end-users to export a dashboard to a PDF file with specific options.
  • Export to Image - Invokes a corresponding dialog that allows end-users to export a dashboard to image of the specified format.
  • Export to Excel - Invokes a corresponding dialog that allows end-users to export a dashboard item's data to the Excel workbook or CSV file.

To learn more about exporting specifics of different dashboard items, see the Exporting topic for the required dashboard item.

Exporting in Code

The following topics contain a list of API used to customize default export options and export dashboard / dashboard items:

See Member Table: Printing and Exporting for a detailed table related to export.

Note

Export to image is disabled for .NET Core because of some problems in the Libgdiplus library. See T685212 and T685811 for more information.

See Also