Angular PrimeNG Table Data Export

Angular PrimeNG is an open-source framework with a rich set of native Angular UI components that are used for great styling and this framework is used to make responsive websites with very much ease. It provides a lot of templates, components, theme design, an extensive icon library, and much more. In this article, we are going to learn Angular PrimeNG Table  Data Export.

Angular PrimeNG Table is used to display data in tabular format. The Data Export let us export the table data in form of pdf and excel. The table can be exported to other formats as well.

Syntax:

exportExcel() {
    import('xlsx').then((xlsx) => {
        const worksheet = xlsx.utils.json_to_sheet(this.tutorials);
        const workbook = { Sheets: { data: worksheet }, SheetNames: ['data'] };
        const excelBuffer: any = xlsx.write(workbook, {
            bookType: 'xlsx',
            type: 'array',
        });
        this.saveAsExcelFile(excelBuffer, 'tutorials');
    });
}

saveAsExcelFile(buffer: any, fileName: string): void {
    let EXCEL_TYPE =
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;charset=UTF-8';
    let EXCEL_EXTENSION = '.xlsx';
    const data: Blob = new Blob([buffer], {
        type: EXCEL_TYPE,
    });
    FileSaver.saveAs(
        data,
        fileName + '_export_' + new Date().getTime() + EXCEL_EXTENSION
    );
}

Creating Angular application & Module Installation:

Step 1: Create an Angular application using the following command.

ng new geeks_angular

Step 2: After creating your project folder i.e. geeks_angular, move to it using the following command.

cd geeks_angular

Step 3: Install PrimeNG in your given directory.

npm install primeng --save
npm install primeicons --save
npm install file-saver jspdf ispdf-autotable

Project Structure:

Example 1: In the following example, we have a Table with an excel export button.

• app.component.html:

HTML

<h1 style="color:green;text-align:center;">
    GeeksforGeeks
</h1>
<h3>Angular PrimeNG Table Data Export</h3>
<h5>Local Storage</h5>

<p-table #dt
         [value]="tutorials"
         dataKey="title"
         [rowHover]="true"
         [showCurrentPageReport]="true"
         [filterDelay]="0"
         stateStorage="local"
         stateKey="gfg-local"
         [globalFilterFields]="['title', 'category', 'rating']">
    <ng-template pTemplate="caption">
        <div class="flex">
            <button type="button"
                    pButton pRipple
                    icon="pi pi-file-excel"
                    (click)="exportExcel()"
                    class="p-button-success mr-2"
                    pTooltip="XLS"
                    tooltipPosition="bottom">
            </button>
            Excel
        </div>
    </ng-template>
    <ng-template pTemplate="header">
        <tr>
            <th style="width: 3rem"></th>
            <th pSortableColumn="title">
                Title
                <p-sortIcon field="title"></p-sortIcon>
            </th>
            <th pSortableColumn="category">
                Category
                <p-sortIcon field="category"></p-sortIcon>
            </th>
            <th pSortableColumn="rating">
                Rating
                <p-sortIcon field="rating"></p-sortIcon>
            </th>
        </tr>
    </ng-template>
    <ng-template pTemplate="body"
                 let-tutorial
                 let-rowIndex="rowIndex">
        <tr class="p-selectable-row">
            <td>
                <p-tableCheckbox
                    [value]="tutorial"
                    [index]="rowIndex">
                </p-tableCheckbox>
            </td>
            <td>
                <span class="p-column-title">
                    Title
                </span>
                {{ tutorial.title }}
            </td>
            <td>
                <span class="p-column-title">
                    Category
                </span>
                <span class="image-text">
                    {{ tutorial.category }}
                </span>
            </td>
            <td>
                <span class="p-column-title">
                    Rating
                </span>
                <span class="image-text">
                    {{ tutorial.rating }}
                </span>
            </td>
        </tr>
    </ng-template>
</p-table>

• app.component.ts

Javascript

import { Component, OnInit, ViewChild } from '@angular/core';
import { ProductService } from './productservice';
import { Table } from 'primeng/table';
import * as FileSaver from 'file-saver';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
})
export class AppComponent {
    tutorials: Tutorial[];
    @ViewChild('dt') table: Table;

    constructor(private productService: ProductService) { }

    cols: any[];

    exportColumns: any[];

    ngOnInit() {
        this.tutorials = [
            {
                title: 'Queue',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Circularly LinkedList',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Doubly LinkedList',
                category: 'Data Structure',
                rating: 3
            },
            {
                title: 'Singly LinkedList',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Doubly Ended Queue',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Binary Search Tree',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Red Black Tree',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Breadth First Search',
                category: 'Graph',
                rating: 4
            },
            {
                title: "Floyd's Cycle",
                category: 'Algorithm',
                rating: 4
            },
            {
                title: 'Travelling Salesman Problem',
                category: 'Algorithm',
                rating: 5,
            },
            {
                title: 'Bellman Ford',
                category: 'Graph',
                rating: 4
            },
            {
                title: 'KMP Algorithm',
                category: 'String',
                rating: 5
            },
        ];
    }

    exportExcel() {
        import('xlsx').then((xlsx) => {
            const worksheet = xlsx.utils.json_to_sheet(this.tutorials);
            const workbook = {
                Sheets: { data: worksheet },
                SheetNames: ['data']
            };
            const excelBuffer: any = xlsx.write(workbook, {
                bookType: 'xlsx',
                type: 'array',
            });
            this.saveAsExcelFile(excelBuffer, 'tutorials');
        });
    }

    saveAsExcelFile(buffer: any, fileName: string): void {
        let EXCEL_TYPE =
'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;charset=UTF-8';
        let EXCEL_EXTENSION = '.xlsx';
        const data: Blob = new Blob([buffer], {
            type: EXCEL_TYPE,
        });
        FileSaver.saveAs(
            data,
            fileName + '_export_' + new Date().getTime() + EXCEL_EXTENSION
        );
    }
}
export interface Tutorial {
    title?: string;
    category?: string;
    rating?: number;
}

• app.module.ts

Javascript

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { FormsModule } from "@angular/forms";
import { HttpClientModule } from "@angular/common/http";
import { BrowserAnimationsModule } from "@angular/platform-browser/animations";

import { AppComponent } from "./app.component";

import { TableModule } from "primeng/table";
import { ButtonModule } from "primeng/button";

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        TableModule,
        HttpClientModule,
        FormsModule,
        ButtonModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
})
export class AppModule { }

Output:

Example 2: In the following example, we can export to PDF.

• app.component.html

HTML

<h1 style="color:green;text-align:center;">GeeksforGeeks</h1>
<h3>Angular PrimeNG Table Data Export</h3>
<h5>Local Storage</h5>

<p-table #dt
         [value]="tutorials"
         dataKey="title"
         [rowHover]="true"
         [showCurrentPageReport]="true"
         [filterDelay]="0"
         [globalFilterFields]="['title', 'category', 'rating']">
    <ng-template pTemplate="caption">
        <div class="flex">
            <button type="button"
                    pButton pRipple
                    icon="pi pi-file-pdf"
                    (click)="exportPdf()"
                    class="p-button-success mr-2"
                    pTooltip="PDF"
                    tooltipPosition="bottom">
            </button>PDF
        </div>
    </ng-template>
    <ng-template pTemplate="header">
        <tr>
            <th style="width: 3rem"></th>
            <th pSortableColumn="title">
                Title
                <p-sortIcon field="title"></p-sortIcon>
            </th>
            <th pSortableColumn="category">
                Category
                <p-sortIcon field="category"></p-sortIcon>
            </th>
            <th pSortableColumn="rating">
                Rating
                <p-sortIcon field="rating"></p-sortIcon>
            </th>
        </tr>
    </ng-template>
    <ng-template pTemplate="body"
                 let-tutorial
                 let-rowIndex="rowIndex">
        <tr class="p-selectable-row">
            <td>
                <p-tableCheckbox
                    [value]="tutorial"
                    [index]="rowIndex">
                </p-tableCheckbox>
            </td>
            <td>
                <span class="p-column-title">
                    Title
                </span>
                {{ tutorial.title }}
            </td>
            <td>
                <span class="p-column-title">
                    Category
                </span>
                <span class="image-text">
                    {{ tutorial.category }}
                </span>
            </td>
            <td>
                <span class="p-column-title">
                    Rating
                </span>
                <span class="image-text">
                    {{ tutorial.rating }}
                </span>
            </td>
        </tr>
    </ng-template>
</p-table>

• app.component.ts

Javascript

import { Component, OnInit, ViewChild } from '@angular/core';
import { ProductService } from './productservice';
import { Table } from 'primeng/table';
import jsPDF from 'jspdf';
import autoTable from 'jspdf-autotable';
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
})
export class AppComponent {
    tutorials: Tutorial[];
    @ViewChild('dt') table: Table;

    constructor(private productService: ProductService) { }

    cols: any[];

    exportColumns: any[];

    ngOnInit() {
        this.tutorials = [
            {
                title: 'Queue',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Circularly LinkedList',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Doubly LinkedList',
                category: 'Data Structure',
                rating: 3
            },
            {
                title: 'Singly LinkedList',
                category: 'Data Structure',
                rating: 4
            },
            {
                title: 'Doubly Ended Queue',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Binary Search Tree',
                category: 'Data Structure',
                rating: 4
                ,
            {
                title: 'Red Black Tree',
                category: 'Data Structure',
                rating: 5
            },
            {
                title: 'Breadth First Search',
                category: 'Graph',
                rating: 4
            },
            {
                title: "Floyd's Cycle",
                category: 'Algorithm',
                rating: 4
            },
            {
                title: 'Travelling Salesman Problem',
                category: 'Algorithm',
                rating: 5,
            },
            {
                title: 'Bellman Ford',
                category: 'Graph',
                rating: 4
            },
            {
                title: 'KMP Algorithm',
                category: 'String',
                rating: 5
            },
        ];
    }

    exportPdf() {
        const doc = new jsPDF('l', 'mm', 'a4');

        const head = [['Title', 'Category', 'Rating']];

        autoTable(doc, {
            head: head,
            body: this.toPdfFormat(),
            didDrawCell: (data) => { },
        });
        doc.save('tutorials.pdf');
    }
    toPdfFormat() {
        let data = [];
        for (var i = 0; i < this.tutorials.length; i++) {
            data.push([
                this.tutorials[i].title,
                this.tutorials[i].category,
                this.tutorials[i].rating,
            ]);
        }
        return data;
    }
}
export interface Tutorial {
    title?: string;
    category?: string;
    rating?: number;
}

• app.module.ts

Javascript

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { FormsModule } from "@angular/forms";
import { HttpClientModule } from "@angular/common/http";
import { BrowserAnimationsModule } from "@angular/platform-browser/animations";

import { AppComponent } from "./app.component";
import { ProductService } from "./productservice";

import { TableModule } from "primeng/table";
import { ButtonModule } from "primeng/button";

@NgModule({
    imports: [
        BrowserModule,
        BrowserAnimationsModule,
        TableModule,
        HttpClientModule,
        FormsModule,
        ButtonModule
    ],
    declarations: [AppComponent],
    bootstrap: [AppComponent],
    providers: [ProductService]
})
export class AppModule { }

Output:

Reference: http://primefaces.org/primeng/table/export