Get Free Trial
  1. API reference
  2. Welcome
    1. Getting started
    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. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    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. Data types in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types 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. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with the Accelerator
      3. Configuring Mondrian roles
      4. Configuring username/password protection
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    11. Connecting to other data sources
  5. Accessibility
    1. Accessibility overview
    2. Keyboard navigation
  6. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Mapping
    6. Number formatting
    7. Conditional formatting
    8. Set the report for the component
    9. Get the report from the component
    10. Share the report
    11. Date and time formatting
    12. Configuring global options
    13. Export and print
    14. Calculated values
    15. Custom sorting
  7. 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
  8. 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
  9. 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
  10. 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
  11. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  12. Documentation for older versions
Table of contents

Integration with React

This tutorial will help you integrate Flexmonster with the React framework

Prerequisites

To work with React, you will need Node.js and npm. Get them here if they are not already installed on your machine.

Another required tool is Flexmonster CLI, which is the most convenient way to work with Flexmonster. Install the CLI globally using npm:

npm install -g flexmonster-cli

Now a new flexmonster command is available in the console. Learn more about Flexmonster CLI and its commands in our documentation.

Now, choose one of the following options:

  1. Run a sample project from GitHub
  2. Integrate Flexmonster into a React application
  3. See the examples of Flexmonster usage in React
  4. Use Flexmonster in a React + ES5 application
  5. Learn how to use Flexmonster with React Hooks
  6. Improve Flexmonster performance in React
  7. See FlexmonsterReact.Pivot properties

Run a sample project from GitHub

Download the sample project with the flexmonster create command. You can choose either the React + ES6 or React + TypeScript project:

React + ES6

flexmonster create react es6 -r

The flexmonster create react es6 command does the following:

  • Downloads the .zip archive with the sample React + ES6 project from GitHub.
  • Automatically unpacks the files in the current folder — as a result, the flexmonster-react-es6-project/ folder will appear in your working directory.

The -r option, which is short for --run, completes these tasks:

  • Installs all the npm dependencies described in package.json.
  • Compiles the application and runs it in the browser.

React + TypeScript

flexmonster create react typescript -r

The flexmonster create react typescript command does the following:

  • Downloads the .zip archive with the sample React + TypeScript project from GitHub.
  • Automatically unpacks the files in the current folder — as a result, the flexmonster-react-typescript-project/ folder will appear in your working directory.

The -r option, which is short for --run, completes these tasks:

  • Installs all the npm dependencies described in package.json.
  • Compiles the application and runs it in the browser.

The application can be shut down manually with Ctrl + C.

Integrate Flexmonster into a React application

Follow the steps below to integrate Flexmonster Pivot into a new React application. If you already have the React project, jump to Step 2. Install Flexmonster.

Step 1. Create a new React project

Create a React app by running the commands below in the console. You can choose between React + ES6 and React + TypeScript projects:

React + ES6

npx create-react-app my-app
cd my-app

React + TypeScript

npx create-react-app my-app --typescript
cd my-app

Step 2. Install Flexmonster

Install the Flexmonster React module by running this CLI command from the folder containing package.json:

flexmonster add react-flexmonster

The add command installs the react-flexmonster package to the node_modules/ folder and adds it as an npm dependency to package.json.

Step 3. Add Flexmonster styles

Import the styles of Flexmonster.

React + ES6

Add the following import statement to index.js:

import 'flexmonster/flexmonster.css';

React + TypeScript

Add the following import statement to index.tsx:

import 'flexmonster/flexmonster.css';

Step 4. Import Flexmonster

Include the FlexmonsterReact component into your React project.

React + ES6

Add the following import statement to App.js:

import * as FlexmonsterReact from 'react-flexmonster';

React + TypeScript

Add the following import statement to App.tsx:

import * as FlexmonsterReact from 'react-flexmonster';

Step 5. Create the pivot table

Instructions on how to use Flexmonster in React vary depending on the type of your React project.

React + ES6

Insert a pivot table into App.js:

class App extends Component {
render()
return (
<div className="App">
<FlexmonsterReact.Pivot
toolbar={true}
componentFolder="https://cdn.flexmonster.com/"
width="100%"
report="https://cdn.flexmonster.com/reports/report.json"
/>
</div>
);
}
}

React + TypeScript

Insert a pivot table into App.tsx:

class App extends React.Component { 
public render() {
return (
  <div className="App">
<FlexmonsterReact.Pivot
toolbar={true}
componentFolder="https://cdn.flexmonster.com/"
width="100%"
report="https://cdn.flexmonster.com/reports/report.json"
/>
</div>
);
}
}

Step 6. Run the project

Run your application from the console:

npm start

Examples

Both React + ES6 and React + TypeScript sample projects contain several Flexmonster usage examples. You can try them all on the projects’ starting page.

This section gives a detailed description of each example:

Adding the pivot table

The first example demonstrates the basic usage of Flexmonster. Notice how the toolbar, report, and licenseKey initialization parameters are specified:

Flexmonster has more initialization parameters. Have a look at all of them.

Calling events

This usage example focuses on Flexmonster events. It provides a toggle button for subscribing to all the events and unsubscribing from them. Here is the source code:

When Flexmonster is subscribed to the events, the log output displays:

  • Which event was triggered.
  • When the event was triggered.
  • Details about that event.

See the full list of Flexmonster events in our documentation.

Using API calls

The Using API calls section is about customizing the component with API calls. Switch the toggle buttons to:

  • Show the pie chart.
  • Show the grid.
  • Make the component read-only.
  • Make the component interactive.

Here is how the functionality is implemented:

See the full list of Flexmonster API calls here.

Updating data

The Updating data section contains an example of updating data at runtime. The example uses the updateData() API call in the function to update the data.

See the source code:

Customizing the Toolbar

Go to the Customizing the Toolbar section to see an example of Toolbar customization.

We use the beforetoolbarcreated event to invoke the customizeToolbar() function. As a result, a custom tab with custom functionality is added. See how it is implemented:

Learn more about customizing the Toolbar.

Customizing the grid

This example demonstrates how the component can be customized.

Switch the toggle buttons to apply or remove customization. Custom grid styles are defined in the customizeCellFunction(). Have a look at the source code:

See our documentation to learn more about cell customization.

Integrating with Highcharts

Here is how the integration with Highcharts is implemented:

Here are the main elements of this integration:

  1. The Highcharts module and Flexmonster Connector for Highcharts.
  2. A container for Highcharts.
  3. The reportcomplete event; when triggered, the function to draw the chart is invoked.
  4. The drawChart() function.

Integration with other charting libraries can be done in a similar way. Check out the integrations we provide.

Integrating with amCharts

In the With amCharts section, you can see a dashboard with Flexmonster and amCharts. Here is how the integration is implemented:

The key elements of this integration are:

  1. The amCharts module and Flexmonster Connector for amCharts.
  2. A container for amCharts.
  3. The reportcomplete event; when triggered, the function to draw the chart is invoked.
  4. The drawChart() function.

Integration with other charting libraries can be done in a similar way. Check out the integrations we provide.

A React/JSX application with Flexmonster

On our GitHub, we also have examples of React/JSX application with Flexmonster Pivot:

To run these applications, just launch the needed HTML page from a browser.

Use Flexmonster in a React + ES5 application

If needed, you can use the ES5 version of Flexmonster in your React project. Import FlexmonsterReact ES5 in App.js as follows:

import * as FlexmonsterReact from 'react-flexmonster/es5';

Now the ES5 version of Flexmonster will be used instead of the ES6 one.

Use Flexmonster with React Hooks

To use Flexmonster Pivot with React Hooks, import FlexmonsterReact as a class component:

import * as FlexmonsterReact from 'react-flexmonster';

Now embed Flexmonster into your React Hooks component:

import React from 'react';
import * as FlexmonsterReact from 'react-flexmonster';

function PivotTableHooks (props) {
const ref = React.useRef();

const onReportComplete = () => {
console.log(">>>>", ref.current.flexmonster.getReport());
}

return <>
<div className="App">
<FlexmonsterReact.Pivot
ref={ref}
toolbar={true}
width="100%"
report="https://cdn.flexmonster.com/reports/report.json"
reportcomplete={onReportComplete}
/>
</div>
</>;
}

export default PivotTableHooks;

In the example above, notice this line:

console.log(">>>>", ref.current.flexmonster.getReport());

It demonstrates how to call Flexmonster’s methods when using React Hooks. Here is the full list of Flexmonster API calls.

Improve Flexmonster performance in React

One of the causes of slow Flexmonster performance in React is the babel-loader package, which is built in the react-create-app command. By default, babel-loader transpiles files located in the node_modules/ folder, including Flexmonster files.

This issue can be fixed by manually configuring babel-loader, which requires running the npm run eject command. Note that this command’s effect is irreversible, so we recommend learning more about npm run eject before running it.

To improve Flexmonster performance, follow the steps below:

Step 1. Run the npm run eject command in the console.

Step 2. Open the webpack.config.js file and exclude Flexmonster from babel-loader:

// Process any JS outside of the app with Babel
// Unlike the application JS, we only compile the standard ES features
{
test: /\.(js|mjs)$/,
exclude: [
/node_modules[\\/]flexmonster/,
/@babel(?:\/|\\{1,2})runtime/
],
loader: require.resolve('babel-loader'),

}

If you completed the instructions above, but the performance is still slow, you can try passing data to the component in a different way.

For example, data can be aggregated on a server and passed to Flexmonster in a ready-to-show format. This will reduce the load on the browser and improve performance. This approach is implemented in Flexmonster Data Server – our tool for server-side data processing, so you are welcome to use it.

FlexmonsterReact.Pivot properties

All available attributes for FlexmonsterReact.Pivot are equivalent to those which are passed to the new Flexmonster() API call. Check out the full list of available attributes.

Here is an example demonstrating how different attributes are specified:

<FlexmonsterReact.Pivot
toolbar={true}
componentFolder="https://cdn.flexmonster.com/"
width="100%"
height="600"
report="https://cdn.flexmonster.com/reports/report.json"
reportcomplete={this.onReportComplete}
/>

In the above example, notice the following line:

reportcomplete={this.onReportComplete} 

This line means that the onReportComplete function handles the reportcomplete event. Any other event handling can be specified in the same way. Here is the full list of Flexmonster events.

What’s next?

You may be interested in the following articles: