Get Free Trial
  1. API reference
  2. Welcome
    1. Introduction
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Angular
      1. Integration with Angular
      2. Flexmonster usage in Angular
    3. React
      1. Integration with React
      2. Flexmonster usage in React
    4. Vue
      1. Integration with Vue 2
      2. Flexmonster usage in Vue 2
      3. Integration with Vue 3
      4. Flexmonster usage in Vue 3
    5. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with Blazor
      4. Integration with AngularJS (v1.x)
      5. Integration with TypeScript
      6. Integration with R Shiny
      7. Integration with jQuery
      8. Integration with Ionic
      9. Integration with Electron.js
      10. Integration with Webpack
      11. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Managing data presentation in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Managing data presentation in CSV
    4. 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
    5. Flexmonster Data Server
      1. Introduction to Flexmonster Data Server
      2. Getting started with Flexmonster Data Server
      3. Flexmonster Admin Panel Guide
      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. Referencing 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
      7. The Data Server as a console application
        1. Installing the Data Server as a console application
        2. Configurations reference
        3. Data sources guide
        4. Security and authorization guide
      8. Troubleshooting the Data Server
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
      4. Configuring the MongoDB Connector
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referencing the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    8. 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. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Supporting multilevel hierarchies
        5. Returning data for the drill-through view
        6. Testing your custom data source API server
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. Connecting to other data sources
  5. Accessibility
    1. Accessibility overview
    2. Keyboard navigation
  6. Configuring the component
    1. Available tutorials
    2. Getting started with the report
    3. Configure the data source
      1. Data source
      2. Mapping
    4. Define which data to show
      1. Slice
      2. Custom sorting
      3. Calculated values
    5. Manage Flexmonster’s functionality
      1. Options
      2. Configuring global options
    6. Format fields
      1. Number formatting
      2. Date and time formatting
      3. Conditional formatting
  7. Saving component configs
    1. Available tutorials
    2. Save and restore the report
    3. Share the report
    4. Export and print
  8. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  9. Customizing
    1. Available tutorials
    2. Customizing the Toolbar
    3. Customizing appearance
    4. Customizing the context menu
    5. Customizing the grid
    6. Customizing the pivot charts
    7. Localizing the component
  10. 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
  11. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.8 to 2.9
    4. Migration guide from 2.7 to 2.8
    5. Migration guide from 2.6 to 2.7
    6. Migration guide from 2.5 to 2.6
    7. Migration guide from 2.4 to 2.5
    8. Migration guide from 2.3 to 2.4
    9. Migration guide from 2.2 to 2.3
  12. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  13. Documentation for older versions
Table of contents

Migration guide from 2.8 to 2.9

Follow this tutorial for a comfortable and quick migration to the new major version.

Before updating

Before completing the migration guide, update Flexmonster CLI to version 2.9:

npm update -g flexmonster-cli

Then check the CLI version by running the following command in the console:

flexmonster -v

Now you can update Flexmonster and proceed to the migration guide.

This migration guide describes updates and new features presented in version 2.9. The Updates section contains a list of changes you should make to the existing code to ensure compatibility with version 2.9. The New features section lists innovations that will improve your experience with Flexmonster.

Find more details below:

  1. Updates
  2. New features
  3. Updating from previous versions


Updates in element IDs

Read this section if migrating from version 2.8.15 or earlier. To check the Flexmonster’s version, click on the grid and press Ctrl + Alt + i (Option + Control + i on macOS). You will see the pop-up window with the component’s version.

In version 2.8.16, a number of element IDs were changed to class names to remove duplicate IDs on the page.

If you have custom CSS, update your CSS selectors according to the list below (e.g., change the #fm-add-btn selector to .fm-add-btn).

Here is a full list of IDs changed to class names:

  • #fm-add-btn
  • #fm-add-group-view
  • #fm-aggr-display
  • #fm-aggregations-view
  • #fm-alert-view
  • #fm-and-label
  • #fm-branding-bar
  • #fm-btn-add-measure
  • #fm-btn-add-measure-2
  • #fm-btn-close-fields
  • #fm-btn-collapse-expand-all
  • #fm-btn-connect
  • #fm-btn-open-fields
  • #fm-build-version
  • #fm-calc-display
  • #fm-calculated-view
  • #fm-cancel-btn
  • #fm-chart
  • #fm-chart-legend
  • #fm-charts-filters-btn
  • #fm-charts-filters-container
  • #fm-charts-view
  • #fm-cols-filter
  • #fm-cols-resize
  • #fm-cols-sheet
  • #fm-conditions
  • #fm-conditions-dropdown
  • #fm-data-sheet
  • #fm-datepicker-1
  • #fm-datepicker-2
  • #fm-dates-filter-view
  • #fm-details-label
  • #fm-drag-handle"
  • #fm-drillthrough-view
  • #fm-fields-view
  • #fm-filter-label
  • #fm-filter-sort-row
  • #fm-filter-view
  • #fm-filters-col
  • #fm-font-family
  • #fm-font-size
  • #fm-formula-input
  • #fm-func-btn-group
  • #fm-grid-view
  • #fm-header-toolbar
  • #fm-icon-display
  • #fm-info-icon
  • #fm-inp-proxy-url
  • #fm-interval-dropdown
  • #fm-labels-filter-btn
  • #fm-labels-filter-view
  • #fm-landscape-radio
  • #fm-left-scroll-button
  • #fm-link
  • #fm-list-wrapper
  • #fm-lst-columns
  • #fm-lst-hierarchies
  • #fm-lst-measures
  • #fm-lst-pages
  • #fm-lst-rows
  • #fm-measures-dropdown
  • #fm-members-filter-list
  • #fm-message-label
  • #fm-moreicon-display
  • #fm-name-input
  • #fm-next-btn
  • #fm-num-input-1
  • #fm-num-input-2
  • #fm-numbers-filter-view
  • #fm-page-filter
  • #fm-periods-dropdown
  • #fm-popUp-modal-overlay
  • #fm-popup-conditional
  • #fm-popup-format-cells
  • #fm-popup-olap
  • #fm-popup-options
  • #fm-portrait-radio
  • #fm-preloader-view
  • #fm-prev-btn
  • #fm-prompt-view
  • #fm-remove-btn
  • #fm-right-scroll-button
  • #fm-rows-filter
  • #fm-rows-resize
  • #fm-rows-sheet
  • #fm-sample
  • #fm-select-counter
  • #fm-sheet-headers
  • #fm-sort-col
  • #fm-sort-label
  • #fm-spinner
  • #fm-text-display
  • #fm-time-filter-view
  • #fm-txt-input-1
  • #fm-txt-input-2
  • #fm-ui-dp-month
  • #fm-ui-dp-year
  • #fm-values
  • #fm-values-filter-view
  • #fm-version-label
  • #fm-wrap-columns
  • #fm-wrap-measures
  • #fm-wrap-pages
  • #fm-wrap-rows

For instance, the #fm-grid-view selector in the following CSS code:

#fm-pivot-view #fm-grid-view div.alter1 {
background-color: #f7f7f7;

should be changed to .fm-grid-view:

#fm-pivot-view .fm-grid-view div.alter1 {
background-color: #f7f7f7;

Updates for Flexmonster Data Server

Starting from version 2.9, Flexmonster Data Server is available as a Windows/Unix service. It is shipped together with Flexmonster Admin Panel – a graphical user interface for the Data Server.

The main advantages of using the Data Server as a service are:

  • It runs in the background and out of sight.
  • It starts automatically on operating system startup.
  • It’s hard for a user to quit the application inadvertently.
  • With the Admin Panel, you can manage indexes, users, and other Data Server configurations conveniently.
  • The Admin Panel allows controlling memory usage and the Data Server logs.

Before updating Flexmonster Data Server, update Flexmonster CLI to version 2.9 or higher:

npm update -g flexmonster-cli

Now see our documentation for details on installing the Data Server as a service and migrating your existing configurations to it.

Previous Data Server versions are compatible with version 2.9 of Flexmonster, so you can update the Data Server later.

Updates in the MongoDB Connector

Version 2.9 includes the following MongoDB Connector updates:

  • Configurations. Now you can manage logging and caching in the MongoDB Connector. Refer to our documentation for details.
  • Multilevel hierarchy support. Starting from version 2.9, you can configure multilevel hierarchies in MongoDB using the mapping.
  • Improved performance. The MongoDB connector has become faster due to optimized data queries and caching the database’s responses.

Updates in the custom data source API

Read this section if you have a custom data source API server that supports multilevel hierarchies.

Since version 2.8, there were two significant updates in the custom data source API, namely in version 2.8.5 and version 2.8.22. 

To check your version of the custom data source API, see the instructions below:

  • If your server implements the /handshake request, a version sent in the response is your version of the custom data source API.
  • If your server does not implement /handshake, Flexmonster considers 2.8.5 to be your custom data source API version.

Depending on your version of the custom data source API, follow the instructions from one of the tabs below:

From version 2.8.5

In version 2.8.5, we added advanced filters for hierarchical data. Implementing these filters allows you to compose multilevel hierarchies of your data.

See our guide on supporting multilevel hierarchies in version 2.8.5 for more details.

From version 2.8.22

In version 2.8.22, we improved the advanced filter’s syntax to make hierarchical filters more comprehensive. Your server should implement new filters to support multilevel hierarchies in version 2.8.22. Learn more in our documentation.

New features

Accessibility support

Significant accessibility improvements were introduced in version 2.9:

  • High-contrast CSS theme.
  • Keyboard navigation.
  • Accessible drag-and-drop feature.
  • Compatibility with screen readers.
  • Conformance with web accessibility standards.

Learn more in the Accessibility section.

Integrations: Ionic and Electron.js

Flexmonster is now available for Ionic and Electron.js frameworks. You are welcome to try these integrations:

Report sharing

Flexmonster now allows sharing reports with the help of Flexmonster Data Server. 

There are two updates in Flexmonster API to support report-sharing functionality: the shareReport method and the shareReportConnection property of the new Flexmonster() API call.

For more details on how to share your report, see our guide.

Async API calls

The following asynchronous methods are now available:

Creating several fields from one field

With the MappingObject, it is now possible to create several fields from one field when using a JSON or CSV data source. Have a look at the example:

dataSource: {
    mapping: {
        "Price": [
                type: "number",
                uniqueName: "PriceNumber",
                caption: "Price as Number"
                type: "string",
                uniqueName: "PriceString",
                caption: "Price as String"

Learn more about this feature in the mapping guide.

New intervals in mapping

The following new intervals were added to the mapping.interval property:

  • y for one year.
  • q for one quarter.
  • M for one month.
  • w for one week.

Note that these intervals should be used without numbers. The feature is available only for "json" and "csv" data source types.

Updating from previous versions

If migrating from the previous major versions, follow these tutorials: