Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
  2. Welcome
    1. Component overview
    2. Quick start
    3. System requirements
    4. Troubleshooting
    5. Managing license keys
    6. 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. Integration with Python
      1. Integration with Django
      2. Integration with Jupyter Notebook
    6. Integration with React Native
    7. Integration with AngularJS (v1.x)
    8. Integration with TypeScript
    9. Integration with R Shiny
    10. Integration with jQuery
    11. Integration with Ionic
    12. Integration with Electron.js
    13. Integration with Webpack
    14. Integration with RequireJS
  4. Connecting to Data Source
    1. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    2. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    3. 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
      6. Connecting to other databases
    4. Flexmonster Data Server
      1. Getting started with Flexmonster Data Server
      2. Installation guide
      3. Configurations reference
      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. Referring 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
    5. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    6. 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
    7. 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. Implementing the custom data source API server
      5. Implementing filters
      6. Supporting more aggregation functions
      7. Returning data for the drill-through view
    8. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    9. 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
  5. 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
  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. Date and time formatting
    11. Configuring global options
    12. Export and print
    13. Calculated values
    14. Custom sorting
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with Google Charts
    5. Integration with FusionCharts
    6. Integration with any charting library
  8. Customizing
    1. Customizing the Toolbar
    2. Customizing appearance
    3. Customizing the context menu
    4. Customizing the grid
    5. Customizing the pivot charts
    6. Localizing the component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.7 to 2.8
    4. Migration guide from 2.6 to 2.7
    5. Migration guide from 2.5 to 2.6
    6. Migration guide from 2.4 to 2.5
    7. Migration guide from 2.3 to 2.4
    8. Migration guide from 2.2 to 2.3
    9. Documentation for older versions
Table of contents

Integration with Highcharts

This tutorial will help you integrate Flexmonster with the Highcharts charting library.

The guide contains the following sections:

Supported chart types

Flexmonster supports the following Highchart types:

If the chart type that you want to use is not on the list, it is possible to use prepareDataFunction to preprocess the data to fit your preferences.

Adding Highcharts

  1. Add the component using data from a CSV file to your HTML page. Replace XXXX-XXXX-XXXX-XXXX-XXXX with your license key. If you don’t have a license key, contact our customer service team and request a special trial key:
    <div id="pivotContainer">The component will appear here</div>
    <script src="https://cdn.flexmonster.com/flexmonster.js"></script>

    <script>
    var pivot = new Flexmonster({
    container: "pivotContainer",
    componentFolder: "https://cdn.flexmonster.com/"
    toolbar: true,
    report: {
    dataSource: {
    filename: "data.csv"
    },
    slice: {
    rows: [
    { uniqueName: "Country" }
    ],
    columns: [
    { uniqueName: "Business Type" },
    { uniqueName: "[Measures]" }
    ],
    measures: [
    { uniqueName: "Price" }
    ]
    }
    },
    licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
    });
    </script>
  2. Add Highcharts:
    <script src="http://code.highcharts.com/highcharts.js"></script>
  3. Add our connector for Highcharts:
    <script src="https://cdn.flexmonster.com/lib/flexmonster.highcharts.js"></script>
  4. Add a container for the chart:
    <div id="highchartsContainer"></div>
  5. Add a reportComplete event handler to know when the pivot table is ready to be a data provider:
    reportcomplete: function() {
    pivot.off("reportcomplete");
    createChart();
    }
  6. Add a function to create the chart. This function uses the connector for Highcharts from flexmonster.highcharts.js. The connector extends the Flexmonster API with the following call: highcharts.getData(options, callbackHandler, updateHandler).
    function createChart() {
    pivot.highcharts.getData(
    {},
    function(chartConfig) {
    Highcharts.chart('highchartsContainer', chartConfig);
    },
    function(chartConfig) {
    Hightcharts.chart('highchartsContainer', chartConfig);
    }
    );
    }

You will see a line chart that displays the same data that is shown in the pivot pivot table instance and it will react to updates. Check out a live example on JSFiddle.

Flexmonster Connector for Highcharts

flexmonster.highcharts.js is a connector between our component and Highcharts. The highcharts.getData() method requests data from the pivot table and preprocesses it to the appropriate format for the required type of chart.

highcharts.getData(options:Object, callbackHandler:Function, updateHandler:Function) has the following parameters:

  • options – Object. This object has the following properties:
    • type (optional) – String. The chart type to prepare data for. Default value: "line".
      function pie() {
      pivot.highcharts.getData({
      type: 'pie'
      }, function(chartConfig) {
      Highcharts.chart('highchartsContainer', chartConfig);
      }, function(chartConfig) {
      Highcharts.chart('highchartsContainer', chartConfig);
      });
      }
    • slice (optional) – Object. Defines the slice from which the data should be returned (for JSON and CSV data sources only). If not defined, the API call will return data currently displayed in the pivot table.
      function withManyYAxis() {
      pivot.highcharts.getData({
      type: 'column',
      slice: {
      rows: [{uniqueName: "Country"}],
      columns: [{uniqueName: "[Measures]"}],
      measures: [
      {uniqueName: "Price"},
      {uniqueName: "Quantity"}
      ]
      }
      }, function(chartConfig) {
      Highcharts.chart('highchartsContainer', chartConfig);
      }, function(chartConfig) {
      Highcharts.chart('highchartsContainer', chartConfig);
      });
      }
    • xAxisType (optional) – String. Set the value of this to “datetime” to use dates on the X axis. Try it in JSFiddle, this sample also illustrates how to define a type for particular series.
    • valuesOnly (optional) – Boolean. Set this property to true to display all axes values in the chart as numbers. This property is applicable only for the following chart types: “bubble”, “line”, “polygon”, and “spline”. Note, that this value is always true for the “scatter” chart (and you do not need to set it explicitly to true). Try it in JSFiddle. Default value: false.
    • withDrilldown (optional) – Boolean. Set this property to true to have drill-downs in the chart. This property is available for the following chart types: “area”, “areaspline”, “bar”, “column”, “waterfall”, “funnel”, “pie”, “pyramid”, “polygon”, “spline”, and “line”. Try it in JSFiddle. Default value: false.
    • prepareDataFunction (optional) – An external function. If the connector does not include the necessary type of chart or if you need to preprocess the data differently, use this function. prepareDataFunction takes two input parameters: rawData – the raw data (check out the structure of rawData in getData()); options – an object with options set in the highcharts.getData() function. Try it in JSFiddle.
  • callbackHandler – Function. Specifies what will happen once the data is ready. Additional options can be specified and then data can be passed directly to the charting library. Takes two input parameters – chartConfig and rawData (rawData is passed just in case you need it, for example for defining number formatting in the tooltip).
  • updateHandler (optional) – Function. Takes two input parameters – chartConfig and rawData. Specifies what will happen once data in the pivot table is filtered/sorted/etc or a number format is changed.

The connector has several functions for defining number formatting for Highcharts. All these functions take the pivot table format object and return the formatting string in Highcharts format. The Highcharts format string is a template for labels with one of the following variables inserted in a bracket notation: value, point.x, point.y, or point.z. For example, "{value:.2f}" is for two decimal places. Thus, there are four functions in the connector that convert the Flexmonster number format object to the Highcharts format string (refer to the Highcharts documentation for more details about the format strings).

  • highcharts.getAxisFormat(format) – String. Takes the pivot table format object and returns the Highcharts format string with the value variable.
  • highcharts.getPointXFormat(format) – String. Takes the pivot table format object and returns the Highcharts format string with the point.x variable.
  • highcharts.getPointYFormat(format) – String. Takes the pivot table format object and returns the Highcharts format string with the point.y variable.
  • highcharts.getPointZFormat(format) – String. Takes the pivot table format object and returns the Highcharts format string with the point.z variable.

These functions can be used in both callbackHandler and updateHandler to define the number formatting for axes and tooltips. Try it in JSFiddle.