Angular PrimeNG TreeTable Filtering

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. This article will show us how to use the TreeTable Filtering in Angular PrimeNG.

Angular PrimeNG TreeTable Filtering enables Filter options in the TreeTable component. So using filtering options, we can easily search and filter out the required data according to our needs.

Syntax:

<p-treeTable #tableref>
    <ng-template pTemplate="caption">
        <input
            type="text"
            pInputText
            (input)="tableref.filterGlobal(
            $event.target.value, 'contains')" />
  </ng-template>
</p-treeTable>

Creating Angular application & Module Installation:

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

ng new appname

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

cd appname

Step 3: Install PrimeNG in your given directory.

npm install primeng --save
npm install primeicons --save

Project Structure: It will look like the following:

Example 1: Below is a simple example that demonstrates the use of the Angular PrimeNG TreeTable Filtering, here we have applied a column filter, so data can be easily filtered by columns.

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG TreeTable Filtering</h4>

<p-treeTable #myTab [columns]="cols"
    [value]="tableData">
    <ng-template pTemplate="colgroup"
        let-columns>
        <colgroup>
            <col *ngFor="let col of columns" />
        </colgroup>
    </ng-template>

    <ng-template pTemplate="header" let-columns>
        <tr>
            <th *ngFor="let col of columns">
                {{ col.header }}
            </th>
        </tr>

        <tr>
            <th *ngFor="let col of cols">
              <input
                pInputText
                type="text"
                (input)=
                "myTab.filter($event.target.value,
                 col.field, col.filterMatchMode)" />
            </th>
        </tr>
    </ng-template>

    <ng-template
        pTemplate="body"
        let-rowNode
        let-rowData="rowData"
        let-columns="columns">
        <tr>
            <td *ngFor="let col of columns; let i = index">
                <p-treeTableToggler
                    [rowNode]="rowNode"
                    *ngIf="i == 0">
                  </p-treeTableToggler>
                {{ rowData[col.field] }}
            </td>
        </tr>
    </ng-template>
</p-treeTable>

app.component.ts

import { Component, OnInit } from '@angular/core';
import { NodeService } from './nodeservice';
import { TreeNode } from 'primeng/api';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
})

export class AppComponent {
  tableData: TreeNode[];
  cols: any[];
  constructor(private nodeService: NodeService) {}

  ngOnInit() {
    this.cols = [
      { field: 'name', header: 'First Name' },
      { field: 'age', header: 'Age' },
    ];
    this.tableData = [
      {
        data: {
          name: 'David',
          age: '40',
        },
        children: [
          {
            data: {
              name: 'Nathan',
              age: '16',
            },
          },
          {
            data: {
              name: 'Shane',
              age: '14',
            },
          },
        ],
      },
      {
        data: {
          name: 'Warner',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Max',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Willy',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Miley',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Sam',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'James',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
    ];
  }
}

app.module.ts

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 { NodeService } from './nodeservice';
import { TreeTableModule } from 'primeng/treetable';
import { ButtonModule } from 'primeng/button';
import { InputTextModule } from 'primeng/inputtext';

@NgModule({
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    TreeTableModule,
    ButtonModule,
    InputTextModule,
    HttpClientModule,
    FormsModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
  providers: [NodeService],
})

export class AppModule {}

Output:

Example 2: Below is another example that demonstrates the use of the Angular PrimeNG TreeTable Filtering, here we have applied a global filter, so data can be easily filtered globally by all table data.

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG TreeTable Filtering</h4>

<p-treeTable #myTab [columns]="cols"
    [value]="tableData">
    <ng-template pTemplate="caption">
        <div style="text-align: right">
            <i class="pi pi-search"
               style="margin:4px 4px 0 0">
              </i>
            <input
              type="text"
              pInputText
              size="50"
              placeholder="Global Filter"
              (input)="myTab.filterGlobal(
              $event.target.value, 'contains')"
              style="width:auto" />
        </div>
    </ng-template>

    <ng-template pTemplate="colgroup" let-columns>
        <colgroup>
            <col *ngFor="let col of columns" />
        </colgroup>
    </ng-template>

    <ng-template pTemplate="header" let-columns>
        <tr>
            <th *ngFor="let col of columns">
                {{ col.header }}
            </th>
        </tr>
    </ng-template>

    <ng-template
        pTemplate="body"
        let-rowNode
        let-rowData="rowData"
        let-columns="columns">
        <tr>
            <td *ngFor="let col of columns; let i = index">
                <p-treeTableToggler
                  [rowNode]="rowNode"
                  *ngIf="i == 0">
                </p-treeTableToggler>
                {{ rowData[col.field] }}
            </td>
        </tr>
    </ng-template>
</p-treeTable>

app.component.ts

import { Component, OnInit } from '@angular/core';
import { NodeService } from './nodeservice';
import { TreeNode } from 'primeng/api';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
})

export class AppComponent {
  tableData: TreeNode[];
  cols: any[];
  constructor(private nodeService: NodeService) {}

  ngOnInit() {
    this.cols = [
      { field: 'name', header: 'First Name' },
      { field: 'age', header: 'Age' },
    ];
    this.tableData = [
      {
        data: {
          name: 'David',
          age: '40',
        },
        children: [
          {
            data: {
              name: 'Nathan',
              age: '16',
            },
          },
          {
            data: {
              name: 'Shane',
              age: '14',
            },
          },
        ],
      },
      {
        data: {
          name: 'Warner',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Max',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Willy',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Miley',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'Sam',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
      {
        data: {
          name: 'James',
          age: '55',
        },
        children: [
          {
            data: {
              name: 'Michelle',
              age: '20',
            },
          },
          {
            data: {
              name: 'Charlie',
              age: '24',
            },
          },
        ],
      },
    ];
  }
}

app.module.ts

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 { NodeService } from './nodeservice';
import { TreeTableModule } from 'primeng/treetable';
import { ButtonModule } from 'primeng/button';
import { InputTextModule } from 'primeng/inputtext';

@NgModule({
  imports: [
    BrowserModule,
    BrowserAnimationsModule,
    TreeTableModule,
    ButtonModule,
    InputTextModule,
    HttpClientModule,
    FormsModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
  providers: [NodeService],
})

export class AppModule {}

Output:

Reference: https://www.primefaces.org/primeng/treetable/filter