1.Integration with Angular

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 7 as well as earlier 4+ versions.

Prerequisites

To run a simple application you will need Node.js and npm. Get it here if it’s 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

After that, choose one of the following options:

Integrate Flexmonster into an existing/new application
Run a simple Angular 4+ and Flexmonster sample from GitHub

Integrate Flexmonster into an existing/new application

To integrate Flexmonster into an Angular 4+ app follow these steps:

If you don’t have an Angular CLI app, you can create it by running these commands in the console:
```
ng new PROJECT-NAME
cd PROJECT-NAME
```
Add the Flexmonster package and the Flexmonster Angular module by running the command:
```
npm i ng-flexmonster --save
```

Add CSS and JS references to angular.json:

"styles": [ 
	"styles.css", 
	"/node_modules/flexmonster/flexmonster.min.css" 
],
"scripts": [ "/node_modules/flexmonster/flexmonster.full.js" ],

Include FlexmonsterPivotModule into app.module.ts. app.module.ts can be found inside the PROJECT-NAME/src/app folder.

import { FlexmonsterPivotModule } from 'ng-flexmonster';

@NgModule({
  ...
  imports: [FlexmonsterPivotModule],
  ...
})

Insert the fm-pivot directive into where you need the pivot table, for example in app.component.html. licenseKey is your license or trial key, so replace XXXX-XXXX-XXXX-XXXX-XXXX with an actual key. If you don’t have a license key, get a trial key here.
```
<fm-pivot 
  [licenseKey]="'XXXX-XXXX-XXXX-XXXX-XXXX'"
  [report]="'https://cdn.flexmonster.com/reports/report.json'">
</fm-pivot>
```
Run your application from the console:
```
ng serve
```
The ng serve command compiles the application and runs it. To see the result open http://localhost:4200/ in your browser.

If you want to integrate with charting libraries, we included all necessary type definitions for integration with Google Charts, FusionCharts, and Highcharts.

Run a simple Angular 4+ and Flexmonster sample from GitHub

Download the .zip archive with the sample or clone it from GitHub with the following command:

git clone https://github.com/flexmonster/pivot-angular my-proj
cd my-proj

Install the npm packages described in package.json:

npm install

Open app.component.html and add your license or trial key to the fm-pivot directive. If you don’t have a license key, get a trial key here.

<fm-pivot 
  [licenseKey]="'XXXX-XXXX-XXXX-XXXX-XXXX'"
  [report]="'https://cdn.flexmonster.com/reports/report.json'">
</fm-pivot>

Run your application:

ng serve

The ng serve command compiles the application and runs it. To see the result open http://localhost:4200/ in your browser.

The application can be shut down manually with Ctrl+C.

The `fm-pivot` directive and its attributes

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. Note that 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 are specified:

<h1>Angular 4+/Flexmonster</h1>
<fm-pivot [componentFolder]="'https://cdn.flexmonster.com/'"
          [toolbar]="true"
          [width]="'100%'"
          [height]="500"
          [licenseKey]="'XXXX-XXXX-XXXX-XXXX-XXXX'"
          [report]="'https://cdn.flexmonster.com/reports/report.json'"
          (reportcomplete)="onReportComplete($event)">
    Flexmonster will appear here
</fm-pivot>

In the above example notice the following line:

(reportcomplete)="onReportComplete($event)"

In Angular, events are specified in round brackets instead of square brackets. This line means that onReportComplete handles the reportcomplete event. Any other event handling can be specified the same way. Here is the full list of Flexmonster events.

Project structure

Let’s take a closer look at the folder structure of the application: the app/ folder contains application files:
- app.module.ts – here we import FlexmonsterPivotModule in order to use it in the Angular app.
- app.component.html – in this file we embed our pivot table. A special directive <fm-pivot> is used to integrate the pivot table with Angular 4+.
- app.component.ts – we recommend to use the Flexmonster API in this file. As an example, you can check how we are handling the onReportComplete event and using the setReport() API call in app.component.ts on GitHub.
index.html – the entering point for the Angular project.

What’s next?

You may be interested in the following articles:

1.