Getting Started

    DataView requires a collection of items as its value and one or more templates depending on the layout mode e.g. list and grid.

    Throughout the samples, a car interface having vin, brand, year and color properties are used to define an object to be displayed by the dataview. Cars are loaded by a CarService that connects to a server to fetch the cars.

    2. export interface Car {
    3.     vin;
    4.     year;
    5.     brand;
    6.     color;
    7. }
    8.  
    2. import {Injectable} from 'angular2/core';
    3. import {Http, Response} from 'angular2/http';
    4. import {Car} from '../domain/car';
    6. @Injectable()
    7. export class CarService {
    9.     constructor(private http: Http) {}
    11.     getCarsLarge() {
    12.         return this.http.get('/showcase/resources/data/cars-large.json')
    13.                     .toPromise()
    14.                     .then(res => <Car[]> res.json().data)
    15.                     .then(data => { return data; });
    16.     }
    17. }
    18.  
    2. export class DataViewDemo implements OnInit {
    4.     cars: Car[];
    6.     constructor(private carService: CarService) { }
    8.     ngOnInit() {
    9.         this.carService.getCarsLarge().then(cars => this.cars = cars);
    10.     }
    11. }
    12.  
    2. <p-dataView [value]="cars">
    3.     <ng-template let-car pTemplate="listItem">
    4.         <div>
    5.             {{car.id}}
    6.         </div>
    7.     </ng-template>
    8. </p-dataView>
    9.  

    Layouts

    DataView has two layout modes; "list" and "grid" where a separate template is used to render an item in each mode. In list mode name of the template is "listItem" whereas in grid mode it is "gridItem". In grid mode, the ng-template element should contain a div element as a wrapper with Grid CSS style class of your choice.

    Sections

    Header and Footer are the two sections that are capable of displaying custom content.

    2. <p-dataView [value]="cars">
    3.     <p-header>List of Cars</p-header>
    4.     <p-footer>Choose from the list.</p-footer>
    5.     <ng-template let-car pTemplate="listItem">
    6.         <div>
    7.             {{car.id}}
    8.         </div>
    9.     </ng-template>
    10.     <ng-template let-car pTemplate="gridItem">
    11.         <div class="ui-g-12 ui-md-3">
    12.             {{car.year}}
    13.         </div>
    14.     </ng-template>
    15. </p-dataView>
    16.  

    DataViewLayoutOptions

    When both layout modes are enabled in DataView, a UI element would be necessary to let the user toggle between the view. p-dataViewLayoutOptions is a helper component to display a buttonset to choose the layout mode in DataView. Location of the p-dataViewLayoutOptions should be inside the DataView component. If you prefer a different UI element you can create your own that updates the layout property of the DataView. 

    2. <p-dataView [value]="cars">
    3.     <p-header>
    4.         <p-dataViewLayoutOptions></p-dataViewLayoutOptions>
    5.     </p-header>
    6.     <p-footer>
    7.         <p-dataViewLayoutOptions></p-dataViewLayoutOptions>
    8.     </p-footer>
    9.     <ng-template let-car pTemplate="listItem">
    10.         <div>
    11.             {{car.id}}
    12.         </div>
    13.     </ng-template>
    14.     <ng-template let-car pTemplate="gridItem">
    15.         <div class="ui-g-12 ui-md-3">
    16.             {{car.year}}
    17.         </div>
    18.     </ng-template>
    19. </p-dataView>
    20.  

    Pagination is enabled by setting paginator property to true, rows attribute defines the number of rows per page and pageLinks specify the the number of page links to display. To customize the left and right side of the paginators, use "paginatorLeftTemplate" and "paginatorRightTemplate" templates.

    2. <p-dataView [value]="cars" [paginator]="true" [rows]="10">
    3.     <ng-template let-car pTemplate="listItem">
    4.         <div>
    5.             {{car.id}}
    6.         </div>
    7.     </ng-template>
    8.     <ng-template let-car pTemplate="gridItem">
    9.         <div class="ui-g-12 ui-md-3">
    10.             {{car.year}}
    11.         </div>
    12.     </ng-template>
    13.     <ng-template pTemplate="paginatorleft" let-state>
    14.         {{state.first}}
    15.         <button type="button" pButton icon="fa-refresh"></button>
    16.     </ng-template>
    17.     <ng-template pTemplate="paginatorright">
    18.         <button type="button" pButton icon="fa-cloud-upload"></button>
    19.     </ng-template>
    20. </p-dataView>
    21.  

    Lazy Loading

    Lazy mode is handy to deal with large datasets, instead of loading the entire data, small chunks of data is loaded by invoking onLazyLoad callback everytime paging happens. To implement lazy loading, enable lazy attribute and provide a method callback using onLazyLoad that actually loads the data from a remote datasource. onLazyLoad gets an event object that contains information about what to load. It is also important to assign the logical number of rows to totalRecords by doing a projection query for paginator configuration so that paginator displays the UI assuming there are actually records of totalRecords size although in reality they aren't as in lazy mode, only the records that are displayed on the current page exist.

    2. <p-dataView [value]="cars" [paginator]="true" [rows]="10"
    3.     [lazy]="true" (onLazyLoad)="loadData($event)" [totalRecords]="totalRecords">
    4.     <ng-template let-car pTemplate="listItem">
    5.         <div>
    6.             {{car.id}}
    7.         </div>
    8.     </ng-template>
    9.     <ng-template let-car pTemplate="gridItem">
    10.         <div class="ui-g-12 ui-md-3">
    11.             {{car.year}}
    12.         </div>
    13.     </ng-template>
    14. </p-dataView>
    15.  

    Sorting

    2. <p-dataView [value]="cars" [sortField]="sortField" [sortOrder]="sortOrder">
    3.     <p-header>
    4.         <p-dropdown [options]="sortOptions" [(ngModel)]="sortKey" placeholder="Sort By"
    5.             (onChange)="onSortChange($event)" [style]="{'min-width':'15em'}"></p-dropdown>
    6.     </p-header>
    7.     <ng-template let-car pTemplate="listItem">
    8.         <div>
    9.             {{car.id}}
    10.         </div>
    11.     </ng-template>
    12.     <ng-template let-car pTemplate="gridItem">
    13.         <div class="ui-g-12 ui-md-3">
    14.             {{car.year}}
    15.         </div>
    16.     </ng-template>
    17. </p-dataView>
    18.  
    2. export class DataViewSortDemo implements OnInit {
    4.     cars: Car[];
    6.     sortOptions: SelectItem[];
    8.     sortKey: string;
    10.     sortField: string;
    12.     sortOrder: number;
    14.     constructor(private carService: CarService) { }
    16.     ngOnInit() {
    17.         this.carService.getCarsLarge().then(cars => this.cars = cars);
    19.         this.sortOptions = [
    20.             {label: 'Newest First', value: '!year'},
    21.             {label: 'Oldest First', value: 'year'},
    22.         ];
    23.     }
    25.     onSortChange(event) {
    26.         let value = event.value;
    28.         if (value.indexOf('!') === 0) {
    29.             this.sortOrder = -1;
    30.             this.sortField = value.substring(1, value.length);
    31.         }
    32.         else {
    33.             this.sortOrder = 1;
    34.             this.sortField = value;
    35.         }
    36.     }
    37. }
    38.  

    Filtering

    Filtering is implemented by defining the filterBy property and calling the filter function of the component, for flexibility there is no built-in UI available so that a custom UI can be used for the filter element. Here is an example that uses an input field. filterBy is a string and multiple fields can be defined with a comma separated list.

    2. <p-dataView #dv [value]="cars" filterBy="brand">
    3.     <p-header>
    4.         <input type="search" pInputText placeholder="Search by brand" (keyup)="dv.filter($event.target.value)">
    5.     </p-header>
    6.     <ng-template let-car pTemplate="listItem">
    7.         {{car.id}}
    8.     </ng-template>
    9.     <ng-template let-car pTemplate="gridItem">
    10.         {{car.year}}
    11.     </ng-template>
    12. </p-dataView>
    13.  

    Custom UI Elements

    As mentioned above, layout options selector, sorting and filtering are baked-in and no strict UI is enforces to make it possible to come up with your own UI elements to enable these features.

    DataView has a loading property, when enabled a spinner icon is displayed to indicate data load. An optional loadingIcon property can be passed in case you'd like a different loading icon.

    2. <p-dataview [value]="cars" [loading]="loading">
    3.     //content
    4. </p-dataview>
    5.  

    Properties

    Events

    Styling

    Following is the list of structural style classes, for theming classes visit theming page.

    Dependencies

    Source

    2. export class DataViewDemo implements OnInit {
    4.     cars: Car[];
    6.     selectedCar: Car;
    8.     displayDialog: boolean;
    10.     sortOptions: SelectItem[];
    12.     sortKey: string;
    14.     sortField: string;
    16.     sortOrder: number;
    18.     constructor(private carService: CarService) { }
    20.     ngOnInit() {
    21.         this.carService.getCarsLarge().then(cars => this.cars = cars);
    23.         this.sortOptions = [
    24.             {label: 'Newest First', value: '!year'},
    25.             {label: 'Oldest First', value: 'year'},
    26.             {label: 'Brand', value: 'brand'}
    27.         ];
    28.     }
    30.     selectCar(event: Event, car: Car) {
    31.         this.selectedCar = car;
    32.         this.displayDialog = true;
    33.         event.preventDefault();
    34.     }
    36.     onSortChange(event) {
    37.         let value = event.value;
    39.         if (value.indexOf('!') === 0) {
    40.             this.sortOrder = -1;
    41.             this.sortField = value.substring(1, value.length);
    42.         }
    43.         else {
    44.             this.sortOrder = 1;
    45.             this.sortField = value;
    46.         }
    47.     }
    49.     onDialogHide() {
    50.         this.selectedCar = null;
    51.     }