🍉 Meet Flexmonster Pivot Table & Charts 2.9.Check out all the hot features!
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 Native

This tutorial will help you integrate Flexmonster with the React Native framework. It is based on the React Native: Getting Started guide.

Prerequisites

To run a simple application you will need Node.js and npm. Download them here if they are not yet installed on your machine.

Then install the Expo CLI globally by running:

npm install -g expo-cli

After that, choose one of the following options:

  1. Run the sample project from GitHub
  2. Integrate Flexmonster into a React Native application
  3. Using methods and events in React Native
  4. Customizing Flexmonster in React Native

Run the sample project from GitHub

Step 1. Download the .zip archive with the sample project or clone it from GitHub with the following commands:

git clone https://github.com/flexmonster/pivot-react-native
cd pivot-react-native

Step 2. Install the npm packages described in package.json:

npm install

Step 3. Run your application from the console:

expo start

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

The sample project contains several examples of using Flexmonster methods and events in React Native. 

When initialized, the component is subscribed to the cellclick event. As a cell is clicked for the first time, the cellclick‘s handler is removed, and the component subscribes to the update event.

The application also has two buttons: Show chart and Show grid. The Show chart button switches to the charts view using the showCharts() method. Show grid uses the showGrid() method to switch to the grid view.

Learn more about using methods and events in this section.

Integrate Flexmonster into a React Native application

To integrate Flexmonster into a React Native app, follow these steps:

Step 1. If you don’t already have a React Native app, create one by running these commands in the console:

expo init my-app --template blank
cd my-app

Step 2. If you created a new app, install the packages described in package.json:

npm install

Step 3. Install the Flexmonster React Native module with the following command:

npm install react-native-flexmonster --save

Step 4. Import FlexmonsterReactNative into App.js:

import * as FlexmonsterReactNative from 'react-native-flexmonster';

Step 5. Insert Flexmonster Pivot into App.js:

export default function App() {
return (
    <View style={{ flex: 1 }}>
        <FlexmonsterReactNative.Pivot
          report="https://cdn.flexmonster.com/reports/report.json"
        />
      </View>
  );
}

Step 6. Run your application from the console:

expo start

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

Using methods and events in React Native

The React Native module provides many of Flexmonster’s methods and events that make the component highly customizable in a React Native application. Have a look at which methods and events are available for usage out of the box.

This section explains how to use events and methods in React Native.

Create a React reference

To use Flexmonster methods and events in React Native, we will need a React ref to the Flexmonster instance. Create a ref and attach it to the FlexmonsterReactNative.Pivot element:

this.flexmonster = React.createRef();

<FlexmonsterReactNative.Pivot
ref={(flexmonster) => { this.flexmonster = flexmonster }}
report="https://cdn.flexmonster.com/reports/report.json"
/>

Now we can reference the Flexmonster instance throughout the React component.

See how the ref is attached to the component in the sample project.

Use methods

A method’s usage depends on its role. There are two types of methods:

Methods that perform an action

To call methods that perform some action, just use the ref to Flexmonster instance:

this.flexmonster = React.createRef();

function showMyChart() {
this.flexmonster.showCharts("pie");
}

return (
<View style={{ flex: 1 }}>
<FlexmonsterReactNative.Pivot
ref={(flexmonster) => { this.flexmonster = flexmonster }}
report="https://cdn.flexmonster.com/reports/report.json"
/>
</View>
);

See how methods that perform an action are used in our sample project.

Methods that return a value

Methods that return a value are called similarly to methods that perform an action. To use their returned value, catch it with the then() method:

this.flexmonster = React.createRef();

function reportComplete() {
this.flexmonster.getReport().then(function(report) {
console.log(report);
});

}


return (
<View style={{ flex: 1 }}>
<FlexmonsterReactNative.Pivot
ref={(flexmonster) => { this.flexmonster = flexmonster }}
report="https://cdn.flexmonster.com/reports/report.json"
/>
</View>
);

Use events

You can subscribe to events in two ways:

Subscribing to events via props

To subscribe to events via props, simply define the needed event as a FlexmonsterReactNative.Pivot prop and assign an event handler to it:

return (
<View style={{ flex: 1 }}>
<FlexmonsterReactNative.Pivot
cellclick={this.onclickHandler}
report="https://cdn.flexmonster.com/reports/report.json"
/>
</View>
);

onclickHandler = () => {
alert("The cell was clicked!");
}

The sample React Native project demonstrates how to subscribe to an event via props.

Subscribing to events via the on() method

You can also subscribe to an event using the on() API call. Now we will need the previously created this.flexmonster ref:

return (
<View style={{ flex: 1 }}>
<FlexmonsterReactNative.Pivot
ref={(flexmonster) => { this.flexmonster = flexmonster }}
report="https://cdn.flexmonster.com/reports/report.json"
/>
</View>
);

myFunction = () => {
    this.flexmonster.on("aftergriddraw", () => {
   alert("aftergriddraw");
   });

}

To unsubscribe from an event, use the off() method:

return (
<View style={{ flex: 1 }}>
<FlexmonsterReactNative.Pivot
ref={(flexmonster) => { this.flexmonster = flexmonster }}
report="https://cdn.flexmonster.com/reports/report.json"
/>
</View>
);

myFunction = () => {
this.flexmonster.on("aftergriddraw", () => {
   alert("aftergriddraw");
this.flexmonster.off("aftergriddraw");
   });
}

Have a look at the sample React Native project and see how on() and off() methods are used.

Customizing Flexmonster in React Native

This section describes the specifics of customizing Flexmonster in React Native.

The Flexmonster React Native module embeds the component into a React Native application using the WebView library, which creates a separate browser window with Flexmonster. Since WebView is an independent part of the application, the component cannot be accessed directly from the app and vice versa.

This approach comes with some limitations. Methods that are defined in the application and require direct access to Flexmonster cannot be used. This includes, for example, customizeCell, customizeContextMenu, and beforetoolbarcreated.

To use these features, you need to modify the Flexmonster React Native module. Follow the steps below to see how the React Native module can be customized.

Step 1. Download the sample project from GitHub

Follow steps 1-3 from the guide on how to run the sample project from GitHub

Step 2. Download the Flexmonster React Native module from GitHub

The sample project includes the Flexmonster React Native module as an npm dependency, but we will connect it manually to add custom functionality.

Download the .zip archive with the module from GitHub or run the following command in the console:

git clone https://github.com/flexmonster/react-native-flexmonster.git

Step 3. Add the module to your project

Copy the src/index.js file from the react-native-flexmonster/ folder to the project folder (e.g., pivot-react-native/). Rename the file if needed (e.g., to react-native-flexmonster.js).

Step 4. Use the module from GitHub

Replace the React Native module from npm with the module from GitHub by updating the module import statement in the App.js file:

import * as FlexmonsterReactNative from './react-native-flexmonster';

Step 5. Customize the module

Make the necessary updates to the react-native-flexmonster.js file. Note that all the updates should be made in the HTML template.

The steps below describe how to customize cells on the grid:

  1. Add a customizeCellFunction to the module’s htmlTemplate variable:
    <script>
    new Flexmonster({
            // initialization parameters
        });
       function customizeCellFunction (cell, data) {
           if (data.type == "value") {
       if (data.rowIndex % 2 == 0) {
    cell.addClass("alter1");
       } else {
         cell.addClass("alter2");
       }
    }
       }

       ${this.registerEvents()
    </script>
  2. Add CSS classes that will be applied to the rows. This can be done right after the <script></script> section of the htmlTemplate variable:
    <script>
        new Flexmonster(
            // initialization parameters
        );
    function customizeCellFunction (cell, data) {
        // function implementation
       }
        ${this.registerEvents()}
    </script>
    <style>
        #fm-pivot-view #fm-grid-view div.alter1 {
    background-color: #f7f7f7;
    }
    #fm-pivot-view #fm-grid-view div.alter2 {
    background-color: #fcfcfc;
    }
    </style>

  3. Call the customizeCell method and pass the customizeCellFunction to it. Note that customizeCell can be defined in two ways:

    As a regular API call

    <script>
    new Flexmonster({
        // initialization parameters
       });
       function customizeCellFunction (cell, data) {
        // function implementation
       }
       ${this.registerEvents()}
    flexmonster.customizeCell(customizeCellFunction);
    </script>

    As an initialization parameter

    new Flexmonster({
    container: "pivotContainer",
       //other initialization parameters
       report: JSON.parse('${JSON.stringify(this.props.report)}'),
       customizeCell: customizeCellFunction
    });

Step 6. Run the project

Run the project from the console with the following command:

expo start

Now all the cells on the grid will be customized by the customizeCellFunction. Other customizations can be achieved in the same way.

What’s next?

You may be interested in the following articles: