This tutorial will help you integrate Flexmonster with the Angular framework. It is based on angular.io quickstart. Flexmonster is fully compatible with the latest Angular 12 as well as earlier 4+ versions.
To run a simple application you will need Node.js and npm. Download them here if they are not already installed on your machine.
Open a terminal/console window and verify that you are running at least node v4.x.x and npm 3.x.x by running node -v and npm -v.
Then install the Angular CLI globally by running:
npm install -g @angular/cli
Flexmonster CLI is also required as it is the most convenient way to work with Flexmonster. Install the CLI globally using npm:
npm install -g flexmonster-cli
Now a new flexmonster command is available in the console. Learn more about Flexmonster CLI and its commands in our documentation.
Now, choose one of the following options:
Create the sample project with the following CLI command:
flexmonster create angular -r
The flexmonster create angular command does the following:
.zip archive with the sample Angular project from GitHub.flexmonster-angular-project/ folder will appear in your working directory.The -r option, which is short for --run, completes these tasks:
package.json.The application can be shut down manually with Ctrl + C.
To integrate Flexmonster into an Angular 5+ app, follow these steps:
Step 1. If you don’t have an Angular CLI app, you can create one by running these commands in the console:
ng new PROJECT-NAME cd PROJECT-NAME
Step 2. Install the Flexmonster Angular module by running this CLI command from the folder containing package.json :
flexmonster add ng-flexmonster
The add command installs the ng-flexmonster package to the node_modules/ folder and adds it as an npm dependency to package.json.
Step 3. Import FlexmonsterPivotModule into src/app/app.module.ts:
import { FlexmonsterPivotModule } from 'ng-flexmonster';
@NgModule({
...
imports: [FlexmonsterPivotModule],
...
})
Step 4. Import CSS styles (e.g., in styles.css):
@import "flexmonster/flexmonster.min.css"
Step 5. Import the flexmonster and ng-flexmonster TypeScript modules (e.g., in app.component.ts):
import * as Flexmonster from 'flexmonster';
import { FlexmonsterPivot } from 'ng-flexmonster';
Step 6. Insert the fm-pivot directive where you need the pivot table (e.g., in app.component.html):
<fm-pivot
[report]="'https://cdn.flexmonster.com/reports/report.json'">
</fm-pivot>
Step 7. Run your application from the console:
ng serve
To see the result, open your browser on http://localhost:4200/.
If you want to integrate with charting libraries, we included all necessary type definitions for integration with Google Charts, FusionCharts, and Highcharts.
The sample Angular project with Flexmonster contains several usage examples. You can try them all on the project’s starting page.
This section gives a detailed description of each example:
The first example demonstrates the basic usage of Flexmonster. In pivot-table-demo.component.html, notice how the toolbar and report initialization parameters are specified in Angular.
Flexmonster has more initialization parameters. Have a look at all of them.
This usage example focuses on Flexmonster events. It provides a toggle button for subscribing to all the events and unsubscribing from them. See how calling the events is implemented in the calling-events.component.ts file.
When Flexmonster is subscribed to the events, the log output displays:
See the full list of Flexmonster events in our documentation.
The Using API calls section is about customizing the component with API calls. Switch the toggle buttons to:
All the functionality is implemented in using-api-calls.component.ts.
See the full list of Flexmonster API calls here.
The Updating data section contains an example of updating data at runtime. The example uses the updateData() API call in the function to update the data. See the source code in the updating-data.component.ts file.
Go to the Customizing the Toolbar section to see an example of Toolbar customization.
We use the beforetoolbarcreated event to invoke the customizeToolbar() function. As a result, a custom tab with custom functionality is added.
The beforetoolbarcreated event is called in customizing-toolbar.component.html, and its handler can be found in the customizing-toolbar.component.ts file.
Learn more about customizing the Toolbar.
The Customizing the grid example demonstrates how the component can be customized.
Switch the toggle buttons to apply or remove customization. Custom grid styles are defined in the customizeCellFunction() method in the customizing-grid.component.ts file.
See our documentation to learn more about cell customization.
See an example of integration with Highcharts in the With Highcharts section.
Here are the main elements of this integration:
reportcomplete event; when triggered, the function to draw the chart is invoked.drawChart() function, which you can find in the with-highcharts.component.ts file.Integration with other charting libraries can be done in a similar way. Check out the integrations we provide.
In the With amCharts section, you can see a dashboard with Flexmonster and amCharts.
The key elements of this integration are:
reportcomplete event; when triggered, the function to draw the chart is invoked.drawChart() function, which you can find in the with-amcharts.component.ts file.Integration with other charting libraries can be done in a similar way. Check out the integrations we provide.
To integrate Flexmonster into an Angular 4 project, we recommend using the FlexmonsterPivot module from GitHub. This module is also available on npm, but due to restrictions on metadata files, it can only be used with Angular 5+ versions.
Follow the steps below:
Step 1. If needed, uninstall the ng-flexmonster npm module:
npm uninstall ng-flexmonster
Step 2. Download the FlexmonsterPivot source code from GitHub and move it to the src/app/ folder.
Step 3. Install the flexmonster npm module:
npm install flexmonster
Step 4. In the app.component.ts file, import FlexmonsterPivot like this:
import { FlexmonsterPivot } from './flexmonster.component';
Step 5. In the app.module.ts file, declare the FlexmonsterPivot module:
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { FlexmonsterPivot } from './flexmonster.component';
import { AppComponent } from './app.component';
@NgModule({
declarations: [
AppComponent, FlexmonsterPivot
],
imports: [
BrowserModule
],
providers: [],
bootstrap: [AppComponent]
}
export class AppModule { }
Step 6. Import Flexmonster styles in the src/styles.css file:
@import "../node_modules/flexmonster/flexmonster.min.css";
After completing these steps, you can use Flexmonster in your Angular 4 application.
The fm-pivot directive embeds the component into the HTML page. The name of each attribute of the fm-pivot directive is surrounded by square brackets. The value of each attribute can be of any type, including an Angular variable available in the current scope, but it must be surrounded by double quotes.
String values must be surrounded by single quotes within the double quotes, e.g., [report]="'https://cdn.flexmonster.com/reports/report.json'".
All attributes are equivalent to those which are passed to the new Flexmonster() API call. Check out the full list of available attributes.
Here is an example demonstrating how different attributes can be specified:
<h1>Angular 4+/Flexmonster</h1>
<fm-pivot [componentFolder]="'https://cdn.flexmonster.com/'"
[toolbar]="true"
[width]="'100%'"
[height]="500"
[report]="'https://cdn.flexmonster.com/reports/report.json'"
(reportcomplete)="onReportComplete()">
Flexmonster will appear here
</fm-pivot>
In the above example, notice the following line:
(reportcomplete)="onReportComplete()"
In Angular, events are specified in round brackets instead of square brackets. This line means that the onReportComplete function handles the reportcomplete event. Any other event handling can be specified in the same way. Here is the full list of Flexmonster events.
You may be interested in the following articles: