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. Available tutorials
    2. Save and restore the report
    3. Share the report
    4. 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

Get Flexmonster

There are several ways to include Flexmonster in your project:

Download Flexmonster via Flexmonster CLI

The most convenient way to get Flexmonster Pivot is through Flexmonster CLI — our command-line interface tool. Install the CLI globally using npm:

npm install -g flexmonster-cli

After this, a new flexmonster command will be available in the console. Learn more about Flexmonster CLI and its commands in our documentation: CLI overview.

To add Flexmonster to your project, run one of the commands below from the folder with the package.json file:

Pure JavaScript

flexmonster add flexmonster

This command downloads Flexmonster to node_modules/ and adds it as a dependency to the package.json file.

Flexmonster can now be used in your project – see the quick start guide for more details.

Angular

flexmonster add ng-flexmonster

This command downloads the Flexmonster Angular module to node_modules/ and adds it as a dependency to the package.json file.

Flexmonster can now be used in your Angular project – see Integration with Angular for more details.

React

flexmonster add react-flexmonster

This command downloads the Flexmonster React module to node_modules/ and adds it as a dependency to the package.json file.

Flexmonster can now be used in your React project – see Integration with React for more details.

Vue

flexmonster add vue-flexmonster

This command downloads the Flexmonster Vue module to node_modules/ and adds it as a dependency to the package.json file.

Flexmonster can now be used in your Vue project – see Integration with Vue for more details.

Include Flexmonster from our CDN

Add Flexmonster to your project by including the files directly from our CDN.

Use the latest version of the component:

<script src="https://cdn.flexmonster.com/flexmonster.js"></script>

Use a specific version of the component:

<script src="https://cdn.flexmonster.com/2.8.16/flexmonster.js"></script>

To learn how to embed Flexmonster in your webpage, refer to our quick start guide.

Download the Flexmonster package

The most convenient way to get Flexmonster Pivot is through Flexmonster CLI — our command-line interface tool. Install the CLI globally using npm:

npm install -g flexmonster-cli

Now, download the Flexmonster Pivot package with the following CLI command:

flexmonster create javascript

This command downloads the .zip archive with Flexmonster Pivot and automatically unpacks the files in the current folder.

As a result, the flexmonster-javascript-project/ folder will appear in your working directory. Open it and copy the flexmonster/ folder into the root of your web project.

Note: to use a trial version of Flexmonster, you will need to set a trial key. It can be found in the flexmonster-javascript-project/TrialKey.txt file. Copy the contents of the file and set the trial key using the licenseKey initialization parameter:

var pivot = new Flexmonster({
container: "pivotContainer",
licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
});

To embed Flexmonster in your project, see the quick start guide.

Include Flexmonster from WebJars

If you have a JVM-based web application, you can include Flexmonster in it using WebJars:

Step 1. Go to WebJars and search for Flexmonster using the Search input field.

Step 2. In the Build Tool column, select the tab with the build tool used in your project (e.g., Maven).

Step 3. Include Flexmonster in your configuration file using the code snippet provided in the Build Tool column. For example, Maven’s pom.xml configuration file should look similar to the following:

<dependencies>
    ...
    <dependency>
        <groupId>org.webjars</groupId>
        <artifactId>flexmonster</artifactId>
        <version>2.9.0</version>
    </dependency>
    ...
</dependencies>

Flexmonster can now be used in your JVM-based project.

For instructions on embedding Flexmonster in your webpage, see our quick start guide.