Angular PrimeNG TreeTable Sorting

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 Horizontal Scrolling in Angular PrimeNG.

Angular PrimeNG TreeTable Sorting enables Sorting the Table data in the TreeTable component. Using the Sorting feature, we can easily sort the TreeTable component data easily using a single column or multiple column sorting.

Syntax:

<p-treeTable>
    <ng-template 
         pTemplate="header" 
         let-columns>
        <tr>
            <th *ngFor="let col of columns" 
                [ttSortableColumn]="col.field">
                {{colData}}
            </th>
        </tr>
    </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 Sorting. In this example, we are applying single-column sorting, which means that the sorting will be only applied according to a single column.

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG TreeTable Sorting</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"
                [ttSortableColumn]="col.field">
                {{ col.header }}
                <p-treeTableSortIcon
                    [field]="col.field">
                </p-treeTableSortIcon>
            </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 a simple example that demonstrates the use of the Angular PrimeNG TreeTable Sorting. In this example, we are applying multi-column sorting, which means that the sorting can be applied to multiple columns.

app.component.html

<h2 style="color: green">GeeksforGeeks</h2>
<h4>Angular PrimeNG TreeTable Sorting</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
        sortMode="multiple">
        <tr>
            <th *ngFor="let col of columns"
                [ttSortableColumn]="col.field">
                {{ col.header }}
                <p-treeTableSortIcon
                    [field]="col.field">
                </p-treeTableSortIcon>
            </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/sort