Get Free Trial
Get Free Trial
  1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Data Source Object
    4. Slice Object
    5. Options Object
    6. Filtering
      1. Filter Object
      2. Number Query Object
      3. String Query Object
      4. Date Query Object
      5. Time Query Object
      6. Value Query Object
    7. Format Object
    8. Conditional Format Object
    9. Cell Data Object
    10. Toolbar Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. alert
    5. clear
    6. clearFilter
    7. clearXMLACache
    8. closeFieldsList
    9. collapseAllData
    10. collapseData
    11. connectTo
    12. customizeCell
    13. customizeContextMenu
    14. dispose
    15. expandAllData
    16. expandData
    17. exportTo
    18. getAllConditions
    19. getAllHierarchies
    20. getAllMeasures
    21. getCell
    22. getColumns
    23. getCondition
    24. getFilter
    25. getFormat
    26. getMeasures
    27. getMembers
    28. getOptions
    29. getReport
    30. getReportFilters
    31. getRows
    32. getSelectedCell
    33. getSort
    34. getXMLACatalogs
    35. getXMLACubes
    36. getXMLADataSources
    37. getXMLAProviderName
    38. load
    39. off
    40. on
    41. open
    42. openCalculatedValueEditor
    43. openFieldsList
    44. openFilter
    45. print
    46. refresh
    47. removeAllCalculatedMeasures
    48. removeAllConditions
    49. removeCalculatedMeasure
    50. removeCondition
    51. removeSelection
    52. runQuery
    53. save
    54. setFilter
    55. setFormat
    56. setOptions
    57. setReport
    58. setSort
    59. showCharts
    60. showGrid
    61. showGridAndCharts
    62. sortingMethod
    63. sortValues
    64. updateData
  4. Events
    1. All events
    2. afterchartdraw
    3. aftergriddraw
    4. beforegriddraw
    5. beforetoolbarcreated
    6. cellclick
    7. celldoubleclick
    8. datachanged
    9. dataerror
    10. datafilecancelled
    11. dataloaded
    12. exportcomplete
    13. exportstart
    14. fieldslistclose
    15. fieldslistopen
    16. filterclose
    17. filteropen
    18. loadingdata
    19. loadinglocalization
    20. loadingolapstructure
    21. loadingreportfile
    22. localizationerror
    23. localizationloaded
    24. olapstructureerror
    25. olapstructureloaded
    26. openingreportfile
    27. printcomplete
    28. printstart
    29. querycomplete
    30. queryerror
    31. ready
    32. reportchange
    33. reportcomplete
    34. reportfilecancelled
    35. reportfileerror
    36. runningquery
    37. update
Table of contents

exportTo

exportTo(type:String, params:Object, callbackHandler:Function|String)

[starting from version: 1.4]

Exports grid or chart to CSV, HTML, PDF, Image or Excel format. The file can be saved to the local file system or to your server (you need to have a script on the server side).

Parameters

  • type – type of export. There are such types available: "csv", "html", "pdf", "image" and "excel".
  • params (optional) – export parameters. Object params can contain the following properties:
    • filename – default name of the resulting file.
    • destinationType – defines where the component’s content will be exported. Destination type can be the following:
      • "file" – the component’s content will be exported to the file to the local computer.
      • "server" – the component’s content will be exported to the server (a server-side script is required).
      • "plain" – the component’s content will be returned with callbackHandler. Below are the types of the component’s content for each type of export:
        • for HTML export: String
        • for CSV export: String
        • for Excel export: Uint8Array
        • for image export: HTMLCanvasElement
        • for PDF export: jsPDF object. This destination type allows modification of the generated PDF file. jsPDF is a library which generates PDFs in client-side JavaScript. After export from Flexmonster, jsPDF object can be modified using jsPDF API and then saved. See the example.
    • excelSheetName (starting from v2.2) (optional) – String. To configure the sheet name when exporting to Excel file.
    • fieldSeparator (optional) – String. Defines specific fields separator to split CSV row in the export file (only for CSV export). The default separator is ,.
    • fontUrl (from v2.7.7) (optional) – String. The URL to the TTF font file for saving PDF reports in Chinese, Arabic or any other language. Check out the list of ready-to-use Google Noto Fonts that you can use to support almost any language in the world. Only fonts in standard TTF format are supported.
    • footer (starting from v2.211) (optional) – String. HTML and PDF only. Footer is set in HTML format (tags, inline styles, img with base64 src). For PDF it is rendered in the browser and added as an image to the exported file. The following tokens can be used for PDF export: ##CURRENT-DATE##, ##PAGE-NUMBER##. They will be replaced by appropriate data. ##CURRENT-DATE## is also available for HTML export.
    • header (starting from v2.211) (optional) – String. HTML and PDF only. Header is set in HTML format (tags, inline styles, img with base64 src). For PDF it is rendered in the browser and added as an image to the exported file. The following tokens can be used for PDF export: ##CURRENT-DATE##, ##PAGE-NUMBER##. They will be replaced by appropriate data. ##CURRENT-DATE## is also available for HTML export.
    • pageFormat (optional) – defines the page format for a PDF file. There are such types available: "A0", "A1", "A2", "A3", "A4", "A5". Default value: "A4".
    • pageOrientation (optional) – defines the page orientation for a PDF file. Page orientation can be the following:
      • "portrait" (by default) – defines portrait page orientation for a PDF file.
      • "landscape" – defines landscape page orientation for a PDF file.
    • requestHeaders (starting from v2.6.13) (optional) – Object. This object allows you to add custom request headers when exporting the file to a server. The object consists of "key": "value" pairs, where "key" is a header name and "value" is its value.
    • showFilters (starting from v2.1) (optional) – Boolean. Excel only. Indicates whether the filters info will be shown (true) in exported Excel file or not (false). Default value is false.
    • url – to save the file to the server you should provide the component with a path to the server-side script which can save this file.
    • useOlapFormattingInExcel (starting from v2.2) (optional) – Boolean. To configure how to export grid cells in Excel file if formatting is taken from OLAP cube – as a formatted string (true) or as numbers without formatting (false).
    • useCustomizeCellForData (optional) – Boolean. Excel only. Specifies how cells modified by customizeCell are exported: as formatted strings (true) or as numbers without formatting (false). Default value: true.
  • callbackHandler (optional) – Callback handler is called with the following object: {data: result}. Check out how to handle errors when exporting to a server.

Examples

1) This example on JSFiddle demonstrates all types of export: CSV, HTML, PDF, Image and Excel.

2) Export to PDF, modify generated file and save locally:

flexmonster.exportTo("pdf", { destinationType: "plain" }, function(res) {
  var pdf = res.data;
  pdf.addPage();
  pdf.text('Hello world!', 10, 10);
  pdf.save(res.filename);
});

3) Export to CSV, save as a local file and add a callback handler:

flexmonster.exportTo('csv', {filename : 'flexmonster.csv'}, 
    function(result) {console.log(result.data)}
);

4) Export to HTML and save as local file:

var params = {
  filename : 'flexmonster.html'
};
flexmonster.exportTo('html', params);

5) Export to PDF file, change page orientation to landscape and save file to the server:

var params = {
  filename : 'flexmonster.pdf', 
  pageOrientation : 'landscape',
  destinationType : 'server',
  url : 'your server'
};
flexmonster.exportTo('pdf', params);

6) Export to Excel and save as local file:

flexmonster.exportTo('excel');

7) Export to PDF and set TTF font file:

flexmonster.exportTo('pdf', {
  fontUrl: 'https://cdn.flexmonster.com/fonts/NotoSansCJKtc-Regular.ttf'
});

See also

print
Export and print tutorial