This migration guide describes breaking changes in version 2.6. To see the full list of new features and fixes in version 2.6, visit the Release notes page.
The majority of our customers have already switched to using a JSON format for the reports, so the XML format is being deprecated from version 2.6. Old XML reports can be converted to JSON via an online XML to JSON converter or an npm package converter.
Among other improvements, we have added the ability to select a measure multiple times allowing you to apply different aggregations on the same measure. For example, a revenue measure can be selected 2 times for a pivot table showing the aggregated values revenue (sum) and revenue (average) Live example.
In version 2.5 and earlier, the measure’s unique name was used to apply sorting, filtering on values, and table sizes. In version 2.6, since one measure can be selected multiple times, it may be necessary to provide not only the unique name of the measure but also its aggregation type to identify the measure. Thus, measure (String) is replaced with measure (Object). measure has the following properties:
uniqueName – String. The measure’s unique name.aggregation optional – String. The measure’s aggregation type.The aggregation parameter is optional, it only needs to be specified when the report contains a measure with multiple aggregations.
setTopX API call usage in version 2.5:
pivot.setTopX("Category", 2, "Price");
setTopX API call usage in version 2.6:
pivot.setTopX("Category", 2, {"uniqueName": "Price"});
"Price" is replaced with {"uniqueName": "Price"}.
All changes are backward compatible, so code from version 2.5 will still remain functional. Moreover, if a report composed in version 2.5 is loaded into version 2.6 and then saved, the changes to the ReportObject will be applied automatically. However, if your own code composes/parses reports or uses API calls from the list below, it is recommended to update the code manually by replacing measure (String) with measure (Object). Below is a list of places where this update is necessary.
To update in the ReportObject:
report.slice.sorting.row.measurereport.slice.sorting.column.measurereport.slice.rows[n].filter.measurereport.slice.columns[n].filter.measurereport.slice.expands.rows[n].measurereport.slice.expands.columns[n].measurereport.slice.drills.rows[n].measurereport.slice.drills.columns[n].measurereport.options.chart.activeMeasurereport.tableSizes.rows[n].measurereport.tableSizes.columns[n].measureCheck out the updated structure of the ReportObject.
To update in API calls usage:
getFilterProperties return has changed.setBottomX input parameter has changed.setTopX input parameter has changed.When migrating from previous major versions, follow these tutorials: