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 jQuery

This tutorial will help you integrate the pivot table with the jQuery library. We provide the following options:

  1. Run the sample project from GitHub
  2. Integrate Flexmonster into a jQuery application

Run the sample project from GitHub

Step 1. Download the project

Download the .zip archive with the sample project or clone it from GitHub with the following command:

git clone https://github.com/flexmonster/pivot-jquery

Step 2. See the results

Open the pivot-jquery/index.html file in the browser to see the result.

Integrate Flexmonster into a jQuery application

If you already have a project with jQuery, jump to Step 2. Add Flexmonster. Otherwise, follow the steps below to set up a simple project:

Step 1. Create a new jQuery project

  1. Create a new folder for the project, e.g. my-jquery-project/.
  2. Create an index.html file inside my-jquery-project/ and include jQuery:
    <!DOCTYPE html>
    <html>
    <head>
    <title>My jQuery/Flexmonster Project</title>
    </head>
    <body>
    <script src="https://cdn.flexmonster.com/lib/jquery.min.js"></script>
    </body>
    </html>

Step 2. Add Flexmonster

Add the Flexmonster library to index.html:

<!DOCTYPE html>
<html>
<head>
    <title>My jQuery/Flexmonster Project</title>
</head>
<body>
    <script src="https://cdn.flexmonster.com/lib/jquery.min.js"></script>
    <script src="https://cdn.flexmonster.com/flexmonster.js"></script>
</body>
</html>

Step 3. Add a container for Flexmonster

Create a <div> container for the component:

<!DOCTYPE html>
<html>
<head>
    <title>My jQuery/Flexmonster Project</title>
</head>
<body>
   <script src="https://cdn.flexmonster.com/lib/jquery.min.js"></script>
   <script src="https://cdn.flexmonster.com/flexmonster.js"></script>

    <div id="pivotContainer">The component will appear here</div>
</body>
</html>

Step 4. Initialize the pivot table

Add a simple script to embed the component:

<!DOCTYPE html>
<html>
<head>
    <title>My jQuery/Flexmonster Project</title>
</head>
<body>
<script src="https://cdn.flexmonster.com/lib/jquery.min.js"></script>
    <script src="https://cdn.flexmonster.com/flexmonster.js"></script>

    <div id="pivotContainer">The component will appear here</div>
<script>
var pivot = $("#pivotContainer").flexmonster({
         componentFolder: "https://cdn.flexmonster.com/",           
         toolbar: true
});
</script>

</body>
</html>

Step 5. Load a sample report

To see some data on the grid, add the report attribute with the report URL:

<!DOCTYPE html>
<html>
<head>
    <title>My jQuery/Flexmonster Project</title>
</head>
<body>
<script src="https://cdn.flexmonster.com/lib/jquery.min.js"></script>
    <script src="https://cdn.flexmonster.com/flexmonster.js"></script>

<div id="pivotContainer">The component will appear here</div>
<script>
var pivot = $("#pivotContainer").flexmonster({
         componentFolder: "https://cdn.flexmonster.com/",
toolbar: true,
         report: "https://cdn.flexmonster.com/reports/report.json"
     });
</script>
</body>
</html>

Open the index.htmlfile in the browser — the component with a sample report is embedded into your project.

Check out a sample on JSFiddle. If you have any problems — visit our troubleshooting section.

Initial jQuery call to embed the component

$(“#pivotContainer”).flexmonster({
componentFolder: String,
global: Report Object,
width: Number | String,
height: Number | String,
report: Report Object | String,
toolbar: Boolean,
customizeCell: Function,
licenseKey: String
})

[starting from version 2.3]

Embeds the component into the HTML page.
As a parameter the jQuery call gets #pivotContainer – this is the id of the HTML element that you want to have as the container for the component.
This method allows you to insert the component into your HTML page and to provide it with all the necessary information for the initialization.

Starting from version 2.3 you can preset options for all reports using the global object.

Note: do not forget to import jQuery and flexmonster.js before you start working with it.

Parameters

  • componentFolder – String. The URL of the component’s folder that contains all the necessary files. It is also used as the base URL for report files, localization files, styles, and images. Default value: "flexmonster/".
  • globalReport Object. Allows you to preset options for all reports. These options can be overridden for specific reports. This object’s structure is the same as for report.
  • width – Number | String. The width of the component on the page (either in pixels or as a percentage). Default value"100%".
  • height – Number | String. The height of the component on the page (either in pixels or as a percentage). Default value: 500.
  • report – Report Object | String. The property to set a report. It can be an inline report JSON or a URL to the report JSON. XML reports are also supported for backward compatibility.
  • toolbar – Boolean. The parameter to embed the Toolbar (true) or not (false). Default value: false.
  • customizeCell – Function. Allows the customization of separate cells. For more info, take a look at customizeCell definition and examples.
  • customizeContextMenu – Function. Allows the customization of the context menu. For more info, take a look at customizeContextMenu definition and examples.
  • licenseKey – String. The license key.

Event handlers can also be set as properties for the jQuery call. Check out the list here.

All of the parameters are optional. If you run $("#pivotContainer").flexmonster() – an empty component without the Toolbar will be added with the default width and height.

Returns

Object – the reference to the embedded pivot table. If you want to work with multiple instances on the same page use these objects. All API calls are available through them.

After initialization, you can obtain an instance reference to the created component by using this selector:
var pivot = $("#pivot").data("flexmonster");

Installation troubleshooting

If you are facing any problems embedding the component, go to the page where the component should be displayed and open the browser console to check for any errors. Try the following steps:

  • If you get the alert "Flexmonster: jQuery is not loaded.", check the path to jQuery in your HTML page.
  • If the page is blank and you see the following error in the console: "Uncaught TypeError: $(...).flexmonster is not a function", check the path to Flexmonster in your HTML page.
  • If you get the alert "Unable to load dependencies. Please use 'componentFolder' parameter to set the path to 'flexmonster' folder.", add the componentFolder parameter to your $.flexmonster() call (e.g., "https://cdn.flexmonster.com/"):
    <div id="pivotContainer">The component will appear here</div> 
    <script src="https://cdn.flexmonster.com/lib/jquery.min.js"></script>
    <script src="https://cdn.flexmonster.com/flexmonster.js"></script>

    <script>
    var pivot = $("#pivotContainer").flexmonster({
    toolbar: true,
    // set the appropriate path
    componentFolder: "https://cdn.flexmonster.com/",
    });
    </script>
  • If you get the error "Uncaught TypeError: Cannot set property '_generatePosition' of undefined" or something similar, try updating the jQuery UI. The minimum recommended version is 1.9.2.
  • If you get the error "Uncaught TypeError: $.parseXML is not a function" or something similar, try updating jQuery. The minimum recommended version is 1.7.

What’s next?