getReport

getReport(options: Object): ReportObject

[starting from version: 1.4]

Returns ReportObject which describes the current report. Use this object to save or edit the report at runtime.

Parameters

Parameter/Type	Description
options Object	optional Allows specifying which options should be included in the report.
options.withDefaults Boolean	optional Indicates whether the default values for options will be included in the report (true) or not (false). Default value: false.
options.withGlobals Boolean	optional Indicates whether the options defined in the GlobalObject will be included in the report (true) or not (false). Default value: false.

Example

1) Get report:

<div id="pivotContainer">The component will appear here</div>  
<script src="flexmonster/flexmonster.js"></script> 

<script> 
var pivot = new Flexmonster({ 
  container: "pivotContainer", 
  componentFolder: "node_modules/flexmonster/",
  report: { 
    dataSource: { 
      filename: "https://cdn.flexmonster.com/data/data.csv" 
    } 
  } 
}); 
</script> 

<button onclick="getReport()">Get Report</button>
<script> 
function getReport() { 
  console.log(pivot.getReport()); 
} 
</script> 

Open the example on JSFiddle.

2) Swap two reports:

<div id="firstPivotContainer">The component will appear here</div>  
<div id="secondPivotContainer">The component will appear here</div>  
<script src="flexmonster/flexmonster.js"></script> 

<script> 
var pivot1 = new Flexmonster({ 
  container: "firstPivotContainer", 
  componentFolder: "node_modules/flexmonster/",
  toolbar: true, 
  report: { 
    dataSource: { 
      filename: "data1.csv" 
    } 
  }
}); 
var pivot2 = new Flexmonster({ 
  container: "secondPivotContainer", 
  componentFolder: "node_modules/flexmonster/",
  toolbar: true, 
  report: { 
    dataSource: { 
      filename: "data2.csv" 
    } 
  }
}); 
</script> 

<button onclick="javascript: swapReports()">Swap Reports</button> 
<script>   
function swapReports() { 
  var report1 = pivot1.getReport(); 
  var report2 = pivot2.getReport(); 
  pivot1.setReport(report2); 
  pivot2.setReport(report1);   
} 
</script>  

Try on JSFiddle.

3) Get a report with defaults or globals: JSFiddle.

See also

setReport
shareReport
ReportObject
open
load
save
Save and restore the report