Using methods and events

This guide explains how to use Flexmonster methods and events in an Angular application. First, we will create a reference to the Flexmonster instance. Then we will use this reference to call methods and subscribe to events.

Prerequisites

An Angular application with Flexmonster embedded into it.
If Flexmonster is not yet embedded, see Integration with Angular.

Get a reference to the Flexmonster instance

To access Flexmonster API inside the .component.ts file, we need a reference to the FlexmonsterPivot instance. Follow the steps below to create the reference:

Step 1. In the HTML template of the component with Flexmonster (e.g., src/app/app.component.html), assign a template variable to the FlexmonsterPivot instance (e.g., #pivot):

<fm-pivot #pivot
 [toolbar]="true">
</fm-pivot>

Step 2. In the component’s TypeScript file (e.g., src/app/app.component.ts), import FlexmonsterPivot and get a reference to the <fm-pivot> instance using a template variable and the @ViewChild decorator:

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

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [FlexmonsterPivotModule],
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css'],
})
export class AppComponent {
  @ViewChild('pivot') pivotRef!: FlexmonsterPivot;
  // Other code
}

The pivotRef reference to the FlexmonsterPivot instance is created.

In this guide, we will use the pivotRef.flexmonster property, which is a reference to the Flexmonster instance. The pivotRef.flexmonster gives you access to Flexmonster API.

Use methods

Call Flexmonster methods using the previously created pivotRef reference:

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

Some methods can also be defined as FlexmonsterPivot input properties:

<fm-pivot #pivot
 [toolbar]="true"
 [customizeCell]="customizeCellFunction">
</fm-pivot>

Such methods include:

Check out the sample Angular project for more examples with Flexmonster methods.

See the full list of Flexmonster methods.

Use events

There are two ways to subscribe to Flexmonster events:

By defining them in the template
Via the on() method

You can also unsubscribe from an event.

Specify the event's name as the <fm-pivot> attribute in parentheses and assign an event handler to it:

<fm-pivot #pivot
 [toolbar]="true"
 [report]="'https://cdn.flexmonster.com/reports/report.json'"
 (reportcomplete)="onReportComplete()">
</fm-pivot>

The sample Angular project demonstrates how to subscribe to events by defining them as <fm-pivot> attributes.

See the full list of Flexmonster events.

Learn more about events in Angular.

Use the previously created pivotRef reference to call the on() method:

this.pivotRef.flexmonster.on('reportcomplete', onReportComplete);

See how the on() method is used in the sample Angular project.

Check out the full list of Flexmonster events.

Unsubscribing from an event

Use the off() method to unsubscribe from an event:

this.pivotRef.flexmonster.off('reportcomplete');

This will remove all handlers from the event. To remove a specific handler, pass its name as a second parameter to off():

this.pivotRef.flexmonster.off('reportcomplete', onReportComplete);

Note If a handler is specified as an anonymous function, you can remove it only by removing all handlers.

See how the off() method is used in the sample Angular project.

Using methods and events

Prerequisites

Get a reference to the Flexmonster instance

Use methods

Use events

Subscribing to an event by defining it in the template

Subscribing to an event via the on() method

Unsubscribing from an event

See also