Get Free Trial
  1. API reference
  2. Welcome
    1. Introduction
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Angular
      1. Integration with Angular
      2. Flexmonster usage in Angular
    3. React
      1. Integration with React
      2. Flexmonster usage in React
    4. Vue
      1. Integration with Vue 2
      2. Flexmonster usage in Vue 2
      3. Integration with Vue 3
      4. Flexmonster usage in Vue 3
    5. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with Blazor
      4. Integration with AngularJS (v1.x)
      5. Integration with TypeScript
      6. Integration with R Shiny
      7. Integration with jQuery
      8. Integration with Ionic
      9. Integration with Electron.js
      10. Integration with Webpack
      11. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Managing data presentation in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Managing data presentation in CSV
    4. Database
      1. Connecting to SQL databases
      2. Connecting to a MySQL database
      3. Connecting to a Microsoft SQL Server database
      4. Connecting to a PostgreSQL database
      5. Connecting to an Oracle database
    5. Flexmonster Data Server
      1. Introduction to Flexmonster Data Server
      2. Getting started with Flexmonster Data Server
      3. Flexmonster Admin Panel Guide
      4. Data sources guide
      5. Security and authorization guide
      6. The Data Server as a DLL
        1. Getting started with the Data Server as a DLL
        2. Referencing the Data Server as a DLL
        3. Implementing the API controller
        4. Implementing the server filter
        5. Implementing the custom parser
        6. DLL configurations reference
        7. The controller's methods for request handling
      7. The Data Server as a console application
        1. Installing the Data Server as a console application
        2. Configurations reference
        3. Data sources guide
        4. Security and authorization guide
      8. Troubleshooting the Data Server
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
      4. Configuring the MongoDB Connector
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referencing the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    8. Custom data source API
      1. Introduction to the custom data source API
      2. A quick overview of a sample Node.js server
      3. A quick overview of a sample .NET Core server
      4. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Supporting multilevel hierarchies
        5. Returning data for the drill-through view
        6. Testing your custom data source API server
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. Connecting to other data sources
  5. Accessibility
    1. Accessibility overview
    2. Keyboard navigation
  6. Configuring the component
    1. Available tutorials
    2. Getting started with the report
    3. Configure the data source
      1. Data source
      2. Mapping
    4. Define which data to show
      1. Slice
      2. Custom sorting
      3. Calculated values
    5. Manage Flexmonster’s functionality
      1. Options
      2. Configuring global options
    6. Format fields
      1. Number formatting
      2. Date and time formatting
      3. Conditional formatting
  7. Saving component configs
    1. Save and restore the report
    2. Share the report
    3. Export and print
  8. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  9. Customizing
    1. Available tutorials
    2. Customizing the Toolbar
    3. Customizing appearance
    4. Customizing the context menu
    5. Customizing the grid
    6. Customizing the pivot charts
    7. Localizing the component
  10. Security
    1. Security in Flexmonster
    2. Security aspects of connecting to an OLAP cube
      1. Ways of connecting to an OLAP cube
      2. The data transfer process
      3. Data security
      4. Data access management
  11. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.8 to 2.9
    4. Migration guide from 2.7 to 2.8
    5. Migration guide from 2.6 to 2.7
    6. Migration guide from 2.5 to 2.6
    7. Migration guide from 2.4 to 2.5
    8. Migration guide from 2.3 to 2.4
    9. Migration guide from 2.2 to 2.3
  12. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  13. Documentation for older versions
Table of contents

Save and restore the report

All your configurations for Flexmonster are contained in a report. Each report can be saved and restored in the component.

This guide contains the following sections:

How to save the report

Reports are saved in JSON format. You can save your report:

  • Via code
  • To the local file system
  • To a remote server

Via code

When getting a report via code, you can:

  • Edit the report programmatically at runtime: add, replace or remove some configurations.
  • Set the report for the component or save it with a custom saving function.

To get your report via code, use the getReport() method:

let pivot = new Flexmonster({
	container: "pivotContainer",
	toolbar: true,
	report: {
		// some report
	}
});

let report = flexmonster.getReport();
// parse, change or save the report for later use

Check out an example on JSFiddle.

To the local file system

To save your report to the local file system, select Save on the Toolbar or use the save() method:

let pivot = new Flexmonster({
	container: "pivotContainer",
	toolbar: true,
	report: {
		// some report
	}
});

flexmonster.save();

See a live sample on JSFiddle.

If you need to edit the report before saving it, we recommend implementing a custom saving function using the getReport() method.

To a remote server

To save your report to a remote server, use the save() method. This method creates an XMLHttpRequest object and sends it in a POST request.

Your server should accept and handle this request. Then the report can be saved to the server or any other location.

Here is an example:

let pivot = new Flexmonster({
	container: "pivotContainer",
	report: {
		// some report
	}
});

flexmonster.save("https://example.com/");

If you need to edit the report before saving it, we recommend implementing a custom saving function using the getReport() method.

In Flexmonster, you can also export your report or share it with other users.

Saving the report with default and global configs

In Flexmonster, you can save reports with default or global settings. It can be done using the following saving options:

  • withDefaults — allows saving the report with default configs.
  • withGlobals — allows saving a report with global configs.

These options are available for both getReport() and save() methods.

Here is an example:

flexmonster.getReport({
	withGlobals: true,
	withDefaults: true
});

See a live sample on JSFiddle.

Configs that are not saved in the report

The saved report can contain only configurations set in the ReportObject and GlobalObject. The configurations listed below are not saved:

How to restore the report

To restore your component configurations, you can:

  • Set a report via code 
  • Open a local report
  • Load a remote report

Set a report via code

To restore a report via code, use the setReport() method:

let report = {  
    // your report
};

flexmonster.setReport(report);

Check out an example on JSFiddle.

Open a local report

To load a report from the local file system, select Open > Local report on the Toolbar or use the open() method:

flexmonster.open();

See the full code on JSFiddle.

Load a remote report

To load a report from the specified URL, select Open > Remote report or use the load() method:

flexmonster.load("report.json");

See a live sample on JSFiddle.

Examples

1) Save the report with global configurations:

flexmonster.save({
	withGlobals: true
});

See an example on JSFiddle.

2) Save the initial report and restore it when needed:

let report;

let pivot = new Flexmonster({
	container: "pivot-container",
	report: {
		// some report
	},
	reportcomplete: () => {
		report = flexmonster.getReport();
		flexmonster.off("reportcomplete");
	}
});

function restoreInitialConfiguration() {
	flexmonster.setReport(report);
}

See a live sample on JSFiddle.

3) Restore the report when refreshing the page.

This example shows how to save component configurations to the browser’s local storage and restore them on page reload.

Other examples of saving and restoring the report can be found on the Examples page.