Menu
Download Free Trial
  1. API reference
  2. Welcome
    1. Component overview
    2. Quickstart
    3. System requirements
    4. Troubleshooting
    5. Installation troubleshooting
    6. Managing license keys
  3. Connecting to Data Source
    1. JSON
      1. Connecting to JSON
      2. Data types in JSON
    2. CSV
      1. Connecting to CSV
      2. Data types in CSV
    3. SQL database
      1. Connecting to SQL database
      2. Connecting to database with .NET
      3. Connecting to database with .NET Core
      4. Connecting to database with Java
      5. Connecting to database with PHP
    4. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Accelerator
      3. Installing Accelerator as a Windows Service
      4. Configuring username/password protection
      5. Configuring secure HTTPS connection
      6. Troubleshooting
    5. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with Accelerator
      3. Configuring Mondrian roles
      4. Сonfiguring username/password protection
      5. Сonfiguring secure HTTPS connection
      6. Troubleshooting
    6. icCube
  4. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Number formatting
    6. Conditional formatting
    7. Set report to the component
    8. Get report from the component
    9. Date and time formatting
    10. Configuring global options
    11. Export and print
    12. Calculated values
    13. Custom sorting
  5. Integration with frameworks
    1. Available tutorials
    2. Integration with AngularJS
    3. Integration with Angular 2
    4. Integration with Angular 4
    5. Integration with React
    6. Integration with RequireJS
    7. Integration with TypeScript
    8. Integration with ASP.NET
    9. Integration with JSP
    10. Integration with PhoneGap
  6. Integration with charts
    1. Integration with Highcharts
    2. Integration with FusionCharts
    3. Integration with Google Charts
    4. Integration with any charting library
  7. Customizing
    1. Customizing toolbar
    2. Customizing appearance
    3. Localizing component
  8. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.3 to 2.4
    4. Migration guide from 2.2 to 2.3
  9. Older Versions
    1. Documentation 2.3
    2. Documentation 2.2
    3. API reference - Flex
Table of contents

Quickstart

Embed into the web application

Here you can find a guide through the process of embedding Pivot Table and Charts Component into your HTML using flexmonster.js library.

To get your Pivot Table component embedded you should accomplish the following steps:

  1. Download a free trial of the component and extract the files from the downloaded package.
  2. Copy flexmonster/ folder into your web project root to your server.
  3. Create <div> container for the component. Please note, that your page should be in the same folder as flexmonster/:
    <div id="pivotContainer">The component will appear here</div>
    
  4. Include flexmonster.js into your HTML page:
    <div id="pivotContainer">The component will appear here</div>
    <script src="flexmonster/flexmonster.js"></script>
    
  5. Add simple script to embed the component. Please note, licenseKey is your license or trial key, so you should replace XXXX-XXXX-XXXX-XXXX-XXXX with an actual key:
    <div id="pivotContainer">The component will appear here</div>
    <script src="flexmonster/flexmonster.js"></script>
    
    <script>
    	var pivot = new Flexmonster({
    		container: "pivotContainer",
    		toolbar: true,
    		licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
    	});
    </script>
    
    
  6. Now launch the page from browser — here you go! The component without data is embedded into your project. You can see the example on JSFiddle.
  7. The next step is to see your own data on the grid. Find detailed tutorials for connecting Pivot Table to the following data sources: JSON, CSV, SQL database, Microsoft Analysis Services, Mondrian and icCube.

Should you have any problems — visit our troubleshooting page.

Initial call to embed the component

This is the first API call you need to know.

new Flexmonster({
	container:String, 
	componentFolder:String, 
	global:Object, 
	width:Number, 
	height:Number, 
	report:Object|String, 
	toolbar:Boolean, 
	customizeCell:Function,
	licenseKey:the license key})

This API call embeds the component into HTML page and allows you to provide it with all necessary information for the initialization by setting the following arguments:

  • container – property to set a selector of the HTML element which will be a container for the component.
  • componentFolder – URL of the component’s folder which contains all necessary files. Also, it is used as a base URL for report files, localization files, styles and images. The default value for componentFolder is flexmonster/.
  • global – object that allows you to preset options for all reports. These options can be overwritten for concrete reports. Object structure is the same as for report.
  • width – width of the component on the page (pixels or percent). The default value for width is 100%.
  • height – height of the component on the page (pixels or percent). The default value for height is 500.
  • report – property to set a report. It can be inline report JSON or URL to report JSON. XML reports are also supported in terms of backward compatibility.
  • toolbar – parameter to embed the toolbar (the one that is shown in Pivot Table demo) or not. Default value is false – without toolbar.
  • customizeCell – function that allows customizing of separate cells.
  • licenseKey – the license key.

The only required property is container. If you run new Flexmonster({container: "pivotContainer"}), where "pivotContainer" is the selector of container HTML element, – an empty component without toolbar will be added with the default width and height.