1. API reference
  2. Welcome
    1. Component overview
    2. Quick start
    3. System requirements
    4. Troubleshooting
    5. Managing license keys
  3. Connecting to Data Source
    1. JSON
      1. Connecting to JSON
      2. Connecting to JSON using the Data Compressor
      3. Data types in JSON
    2. CSV
      1. Connecting to CSV
      2. Connecting to CSV using the Data Compressor
      3. Data types in CSV
    3. Database
      1. Connecting to SQL databases
      2. Connecting to other databases
      3. Connecting to a database with Node.js
      4. Connecting to a database with .NET
      5. Connecting to a database with .NET Core
      6. Connecting to a database with Java
      7. Connecting to a database with PHP
    4. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with the Accelerator
      3. Installing the Accelerator as a Windows service
      4. Referring the Accelerator as a DLL
      5. Configuring the authentication process
      6. Configuring a secure HTTPS connection
      7. Troubleshooting
    5. 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
    6. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
  4. Security
    1. Security in Flexmonster
    2. Security aspects when connecting to an OLAP cube
      1. The data transfer process
      2. Data security
      3. Data access management
    3. Security aspects when connecting to a database
      1. The data transfer process
      2. Data access management
  5. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Number formatting
    6. Conditional formatting
    7. Set the report for the component
    8. Get the report from the component
    9. Date and time formatting
    10. Configuring global options
    11. Export and print
    12. Calculated values
    13. Custom sorting
  6. Integration with frameworks
    1. Available tutorials
    2. Integration with AngularJS (v1.x)
    3. Integration with Angular
    4. Integration with React
    5. Integration with Webpack
    6. Integration with ASP.NET
    7. Integration with jQuery
    8. Integration with JSP
    9. Integration with TypeScript
    10. Integration with RequireJS
    11. Integration with PhoneGap
  7. Integration with charts
    1. Integration with Highcharts
    2. Integration with Google Charts
    3. Integration with FusionCharts
    4. Integration with any charting library
  8. Customizing
    1. Customizing toolbar
    2. Customizing appearance
    3. Customizing context menu
    4. Localizing component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.6 to 2.7
    4. Migration guide from 2.5 to 2.6
    5. Migration guide from 2.4 to 2.5
    6. Migration guide from 2.3 to 2.4
    7. Migration guide from 2.2 to 2.3
    8. Documentation for older versions
Table of contents

Integration with jQuery

This tutorial will help you integrate the pivot table with the jQuery library. Follow these steps 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. Copy the flexmonster/ folder into your project folder. You can find flexmonster/ inside of the package that you downloaded from our website.
  3. 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="flexmonster/lib/jquery.min.js"></script>
    </body>
    </html>
    

Step 2: Add Flexmonster dependencies

  1. Create a <div> container for the component:
    <!DOCTYPE html>
    <html>
    <head>
        <title>My jQuery/Flexmonster Project</title>
    </head>
    <body>
        <div id="pivotContainer">The component will appear here</div>
        <script src="flexmonster/lib/jquery.min.js"></script>
    </body>
    </html>
    
  2. Add the Flexmonster library to index.html:
    <!DOCTYPE html>
    <html>
    <head>
        <title>My jQuery/Flexmonster Project</title>
    </head>
    <body>
        <div id="pivotContainer">The component will appear here</div>
        <script src="flexmonster/lib/jquery.min.js"></script>
        <script src="flexmonster/flexmonster.js"></script>
    </body>
    </html>
    

Step 3: Initialize the pivot table

Add a simple script to embed the component. Note that licenseKey is your license or trial key, so replace XXXX-XXXX-XXXX-XXXX-XXXX with an actual key:

<!DOCTYPE html>
<html>
<head>
    <title>My jQuery/Flexmonster Project</title>
</head>
<body>
	<div id="pivotContainer">The component will appear here</div>
	<script src="flexmonster/lib/jquery.min.js"></script>
	<script src="flexmonster/flexmonster.js"></script>
	
	<script>
		var pivot = $("#pivotContainer").flexmonster({
			toolbar: true,
			licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
		});
	</script>
	
</body>
</html>

Step 4: 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>
	<div id="pivotContainer">The component will appear here</div>
	<script src="flexmonster/lib/jquery.min.js"></script>
	<script src="flexmonster/flexmonster.js"></script>
	
	<script>
		var pivot = $("#pivotContainer").flexmonster({
			toolbar: true,
			report: "https://cdn.flexmonster.com/reports/report.json",
			licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
		});
	</script>
</body>
</html>

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 overwritten 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. To embed the toolbar or not. Default value: false – no toolbar.
    • 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 separate cells. 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.min.js 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.js 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. Pay attention to the message "Files not found: ..." and set componentFolder to receive the correct paths to lib/jqueryui.min.js, lib/jqueryhelpers.min.js and flexmonster.css.
      <div id="pivotContainer">The component will appear here</div>
      <script src="flexmonster/lib/jquery.min.js"></script>
      <script src="flexmonster/flexmonster.js"></script>
      
      <script>
        var pivot = $("#pivotContainer").flexmonster({
          toolbar: true,
          licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX",
          // set the appropriate path
          componentFolder: "",
        });
      </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?