Paginator component description

Constructors

Section titled "Constructors"

IgxPaginatorComponent

new IgxPaginatorComponent(): IgxPaginatorComponent

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:269

Returns IgxPaginatorComponent

Properties

Section titled "Properties"

pageChange

Section titled "pageChange"

Emitted after the current page is changed.

 
pageChange: EventEmitter<number>

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:93

Example

<igx-paginator (pageChange)="onPageChange($event)"></igx-paginator>
public onPageChange(page: number) {
  this.currentPage = page;
}

paging

Section titled "paging"

Emitted before paging is performed.

 
paging: EventEmitter<IPageCancellableEventArgs>

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:106

Remarks

Returns an object consisting of the current and next pages.

Example

<igx-paginator (paging)="pagingHandler($event)"></igx-paginator>

pagingDone

Section titled "pagingDone"

Emitted after paging is performed.

 
pagingDone: EventEmitter<IPageEventArgs>

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:119

Remarks

Returns an object consisting of the previous and current pages.

Example

<igx-paginator (pagingDone)="pagingDone($event)"></igx-paginator>

perPageChange

Section titled "perPageChange"

Emitted when perPage property value of the paginator is changed.

 
perPageChange: EventEmitter<number>

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:77

Example

<igx-paginator (perPageChange)="onPerPageChange($event)"></igx-paginator>
public onPerPageChange(perPage: number) {
  this.perPage = perPage;
}

totalPages

Section titled "totalPages"

Total pages calculated from totalRecords and perPage

 
totalPages: number

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:124

overlaySettings

Section titled "overlaySettings" 
overlaySettings: OverlaySettings

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:244, projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:248

page

Section titled "page" 
page: number

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:149, projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:153

perPage

Section titled "perPage" 
perPage: number

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:180, projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:184

resourceStrings

Section titled "resourceStrings" 
resourceStrings: IPaginatorResourceStrings

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:258, projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:265

selectOptions

Section titled "selectOptions" 
selectOptions: number[]

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:228, projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:232

totalRecords

Section titled "totalRecords" 
totalRecords: number

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:206, projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:210

Accessors

Section titled "Accessors"

isFirstPage

Section titled "isFirstPage"

Returns if the current page is the first page.

const lastPage = this.paginator.isFirstPage;
get isFirstPage(): boolean

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:291

Returns boolean

isLastPage

Section titled "isLastPage"

Returns if the current page is the last page.

const lastPage = this.paginator.isLastPage;
get isLastPage(): boolean

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:281

Returns boolean

nativeElement

Section titled "nativeElement"

Methods

Section titled "Methods"

nextPage

Section titled "nextPage"

Goes to the next page of the IgxPaginatorComponent, if the paginator is not already at the last page.

this.paginator.nextPage();
nextPage(): void

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:326

Returns void

paginate

Section titled "paginate"

Goes to the desired page index.

this.paginator.paginate(1);
paginate(val: number): void

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:353

Parameters

  • val: number

Returns void

previousPage

Section titled "previousPage"

Goes to the previous page of the IgxPaginatorComponent, if the paginator is not already at the first page.

this.paginator.previousPage();
previousPage(): void

Defined in projects/igniteui-angular/paginator/src/paginator/paginator.component.ts:339

Returns void