Migrating from WebDataRocks to Flexmonster

This guide will help you migrate from WebDataRocks to Flexmonster in your Angular project.

The migration process is simple. Flexmonster is embedded in an Angular application similarly to WebDataRocks. In addition, the code you’ve created around the WebDataRocks component will require only minor changes.

Step 1. Install Flexmonster CLI

Flexmonster CLI is the most convenient way to work with Flexmonster Pivot. Install the CLI globally using npm:

npm install -g flexmonster-cli

As a result, a new flexmonster command will be available in the console. Learn more about Flexmonster CLI.

Step 2. Install Flexmonster Pivot

There are two Flexmonster wrappers for Angular:

• ngx-flexmonster (works for Angular 14 and later, Ivy-compatible)
• ng-flexmonster (works for Angular 5 through 15)

Run one of the following commands inside your project to get the chosen wrapper. If your Angular version is compatible with both wrappers, we recommend choosing the ngx-flexmonster:

flexmonster add ngx-flexmonster

flexmonster add ng-flexmonster

Step 3. Replace WebDataRocks in the NgModule

In the NgModule where WebdatarocksPivotModule is imported (e.g., src/app/app.module.ts), import FlexmonsterPivotModule instead:

import { WebdatarocksPivotModule } from "ng-webdatarocks";
 
@NgModule({
  // ...
  imports: [
    WebdatarocksPivotModule,
    // Other imports
  ],
  // ...
})

import { FlexmonsterPivotModule } from "ngx-flexmonster";
 
@NgModule({
  // ...
  imports: [
    FlexmonsterPivotModule,
    // Other imports
  ],
  // ...
})

import { FlexmonsterPivotModule } from "ng-flexmonster";
 
@NgModule({
  // ...
  imports: [
    FlexmonsterPivotModule,
    // Other imports
  ],
  // ...
})

Step 4. Replace WebDataRocks styles

Open the CSS file with WebDataRocks styles (e.g., src/styles.css) and replace them with Flexmonster styles:

@import "webdatarocks/webdatarocks.min.css";

@import "flexmonster/flexmonster.min.css";

If you were using one of WebDataRocks’ predefined themes, replace it with a corresponding Flexmonster theme.

Step 5. Replace the <app-wbr-pivot> directive

In every HTML file containing the pivot table (e.g., src/app/app.component.html), replace the <app-wbr-pivot> directive with the <fm-pivot> directive:

<app-wbr-pivot
  [report]="report">
</app-wbr-pivot>

<fm-pivot
  [report]="report">
</fm-pivot>

Note You need to change only the directive’s name. Its attributes may stay the same.

<fm-pivot> has more attributes than <app-wbr-pivot>. Learn more about the <fm-pivot> directive and its attributes.

Step 6. Replace WebDataRocks API with Flexmonster API

Flexmonster includes WebDataRocks API, so you can continue using the methods and events you’ve used in your project. Follow the steps below to migrate to Flexmonster API.

Step 6.1. Replace WebdatarocksComponent with FlexmonsterPivot

In every .component.ts file with code for WebDataRocks (e.g., app.component.ts), import FlexmonsterPivot instead of WebdatarocksComponent:

import { Component, OnInit, ViewChild } from "@angular/core";
import { WebdatarocksComponent } from "ng-webdatarocks";

import { Component, OnInit, ViewChild } from "@angular/core";
import { FlexmonsterPivot } from "ngx-flexmonster";

import { Component, OnInit, ViewChild } from "@angular/core";
import { FlexmonsterPivot } from "ng-flexmonster";

Step 6.2. Update references injected using the @ViewChild decorator

The reference injected with @ViewChild is needed to use Flexmonster methods and events. 

To update the reference, change WebdatarocksComponent to FlexmonsterPivot:

@ViewChild('pivot') pivot: WebdatarocksComponent;

@ViewChild('pivot') pivot: FlexmonsterPivot;

Step 6.3. Update methods

Flexmonster supports all methods available in WebDataRocks and provides additional ones. See the full list of Flexmonster methods.

To start using Flexmonster methods, you need to:

1. Change the WebDataRocks instance to the Flexmonster instance in method calls. For example:
   

   WebDataRocks

   this.pivot.webDataRocks.setReport(this.report);

   Flexmonster

   this.pivot.flexmonster.setReport(this.report);

2. Update methods themselves if needed.
   Since all WebDataRocks methods are available in Flexmonster, there is no need to update method names.
   However, some Flexmonster methods have slightly different signatures. Check them out in API Reference.

Step 6.4. Update events

Flexmonster supports all events available in WebDataRocks and provides additional ones. See the full list of Flexmonster events.

Since all WebDataRocks events are available in Flexmonster, there is no need to update event names in your code.

However, some Flexmonster events have slightly different signatures. Check them out in API Reference.

Note If you subscribe to events through the on() and off() methods, don't forget to change the WebDataRocks instance to the Flexmonster instance when calling these methods.

Step 6.5. Update objects

Objects are passed as parameters to methods and event handlers. All WebDataRocks objects are available in Flexmonster.

To replace WebDataRocks objects with Flexmonster objects, you need to:

1. Change their namespace from WebDataRocks to Flexmonster. For example:
   

   WebDataRocks

   customizeCellFunction(cell: WebDataRocks.CellBuilder,
     data: WebDataRocks.CellData) {
       // Function body
   }

   Flexmonster

   customizeCellFunction(cell: Flexmonster.CellBuilder,
     data: Flexmonster.CellData) {
       // Function body
   }

2. Update objects themselves if needed.
   Since all WebDataRocks objects are available in Flexmonster, there is no need to update object names.
   However, some Flexmonster objects have slightly different properties. Check them out in API Reference.

Step 7. Update your reports

To use a WebDataRocks report in Flexmonster, you need to make one minor change manually. The rest of the report will be converted automatically upon loading it in Flexmonster.

To update your report, change "uniqueName": "Measures" to "uniqueName": "[Measures]" in the slice:

"slice": {
  "rows": [
    {
      // ...
    },
    {
      "uniqueName": "Measures"
    }
  ],
  // Other properties
}

"slice": {
  "rows": [
    {
      // ...
    },
    {
      "uniqueName": "[Measures]"
    }
  ],
  // Other properties
}

Step 8. Uninstall WebDataRocks

Run the following commands inside your project to uninstall:

• The WebDataRocks Angular module:

  npm uninstall ng-webdatarocks

• WebDataRocks itself:

  npm uninstall webdatarocks

Step 9. Run the application

Run your application from the console:

ng serve --open

Open your application in the browser and see that Flexmonster is used instead of WebDataRocks.

The migration is complete.

What's next?

With Flexmonster, you can connect to JSON/CSV files, SQL and MongoDB databases, Elasticsearch, and Microsoft Analysis Services. See the full list: Supported data sources.

Flexmonster also offers features that are not available in WebDataRocks:

• Built-in pivot charts
• More customization options
• Accessibility
• Report sharing