1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Slice Object
    4. Options Object
    5. Format Object
    6. Conditional Format Object
    7. Cell Data 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. getData
    25. getFilter
    26. getFilterProperties
    27. getFormat
    28. getMeasures
    29. getMembers
    30. getOptions
    31. getReport
    32. getReportFilters
    33. getRows
    34. getSelectedCell
    35. getSort
    36. getXMLACatalogs
    37. getXMLACubes
    38. getXMLADataSources
    39. getXMLAProviderName
    40. load
    41. off
    42. on
    43. open
    44. openFieldsList
    45. openFilter
    46. print
    47. refresh
    48. removeAllCalculatedMeasures
    49. removeAllConditions
    50. removeCalculatedMeasure
    51. removeCondition
    52. removeSelection
    53. runQuery
    54. save
    55. setBottomX
    56. setFilter
    57. setFormat
    58. setOptions
    59. setReport
    60. setSort
    61. setTopX
    62. showCharts
    63. showGrid
    64. showGridAndCharts
    65. sortingMethod
    66. sortValues
    67. 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

save

save(params:Object)

[starting from version: 2.302]

You can use this method to save your current report to a specified location. Thus you can open it later with all fields, applied filters, and sortings same like you placed it. The report is saved in JSON format.

Parameters

params object can have the following properties:

  • filename – a default name of the file.
  • destination (optional) – parameter defines how to save a generated file. File can be saved to "server" or "file". The default value is "file".
  • callbackHandler (optional) – JS function which will be called when the report is saved.
  • url (optional) – an URL to the server-side script which saves the generated file. The file is sent as a POST parameter. Use this parameter only if destination parameter is "server".
  • embedData (optional) – specifies whether to save CSV/OCSV data within the report or not. Default value is false.
  • reportType (optional) – String. Report can be saved in "json" or "xml" format. Default value is "json". Starting from version 2.6.0, "xml" format is deprecated.
  • withDefaults (optional) – Boolean. Indicates whether the default values for options will be included in the report (true) of not (false). The default value is false.
  • withGlobals (optional) – Boolean. Indicates whether the options defined in global object will be included in the report (true) of not (false). The default value is false.

Examples

1) How to save a report to the local file system:

flexmonster.save({
    filename: 'myreport.json', 
    destination: 'file'
});

Check out on JSFiddle.

2) How to save a report to the server:

flexmonster.save({
    filename: 'myreport.json', 
    destination: 'server',
    url: 'http://yourserver.com/yourscript.php'
});

Please note that the server-side script should be created on your back-end to be able save reports to the server. And an url parameter is the path to this server-side script.

3) How to save a report and perform some JS code right after the report was already saved:

<button onclick="javascript: 
    flexmonster.save({
    filename: 'myreport.json', 
    destination: 'file',
    callbackHandler: 'reportSaved'
})">
	Save Report
</button>
<script type="text/javascript">
	function reportSaved() {
	// some JS code 
	}
</script>

See also

load
getReport
setReport