Flexmonster Software License Agreement (“Agreement”) has been significantly revised and is effective as of September 30, 2024.
The following modifications were made:
The modified version of Flexmonster Software License Agreement is available here.
Downloading, installing, and/or continuing to use Flexmonster Software after September 30, 2024, constitutes Licensee’s acceptance of the terms and conditions of the modified version of Flexmonster Software License Agreement. If Licensee does not agree to any of these terms and conditions, they must cease using Flexmonster Software and must not download, install, use, access, or continue to access Flexmonster Software. By continuing to use Flexmonster Software or renewing the license under License Model or Maintenance after the effective date of any modifications to Agreement, Licensee accepts and agrees to be bound by the terms and conditions of the modified Agreement.
This tutorial will help you integrate Flexmonster with the Highcharts charting library.
Watch the tutorial in the video format: Pivot table with Highcharts.
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.
More ready-to-use examples of integration with Highcharts you can find on the Examples page.
Step 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 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/data.csv" }, slice: { rows: [ { uniqueName: "Country" } ], columns: [ { uniqueName: "Business Type" }, { uniqueName: "[Measures]" } ], measures: [ { uniqueName: "Price" } ] } }, licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX" }); </script>
Step 2. Add Highcharts:
<script src="https://code.highcharts.com/highcharts.js"></script>
Step 3. Add our connector for Highcharts:
<script src="https://cdn.flexmonster.com/lib/flexmonster.highcharts.js"></script>
Step 4. Add a container for the chart:
<div id="chartContainer"></div>
Step 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(); }
Step 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("chartContainer", chartConfig); }, function(chartConfig) { Highcharts.chart("chartContainer", 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
Live example.
You can also watch our video tutorial that covers the integration process:
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:
Parameter/Type | Description |
---|---|
options Object | Allows setting options for data preprocessing. |
options.type String | optional The chart type to prepare data for. Default value: "line" .Here is an example of how to specify a chart type: function pie() { |
options.slice SliceObject | optional 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. Here is an example of a slice: function withManyYAxis() { |
options.xAxisType String | optional Set the value of this to "datetime" to use dates on the X-axis. Try it on JSFiddle, this sample also illustrates how to define a type for particular series. |
options.valuesOnly Boolean | optional 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).Live example Default value: false . |
options.withDrilldown Boolean | optional 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" .Live example Default value: false . |
options.prepareDataFunction Function | optional 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:
|
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 Function | optional 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 FormatObject 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's FormatObject 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 FormatObject and returns the Highcharts format string with the value
variable.highcharts.getPointXFormat(format)
– String. Takes the pivot table FormatObject and returns the Highcharts format string with the point.x
variable.highcharts.getPointYFormat(format)
– String. Takes the pivot table FormatObject and returns the Highcharts format string with the point.y
variable.highcharts.getPointZFormat(format)
– String. Takes the pivot table FormatObject 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
Live example.