constructor

• new IgxPaginatorComponent(
      elementRef: ElementRef,
      cdr: ChangeDetectorRef,
  ): IgxPaginatorComponent

  Parameters

  • elementRef: ElementRef

  • cdr: ChangeDetectorRef

  Returns IgxPaginatorComponent

pageChange

<igx-paginator (pageChange)="onPageChange($event)"></igx-paginator>
Copy

public onPageChange(page: number) {
  this.currentPage = page;
}
Copy

paging

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

pagingDone

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

perPageChange

<igx-paginator (perPageChange)="onPerPageChange($event)"></igx-paginator>
Copy

public onPerPageChange(perPage: number) {
  this.perPage = perPage;
}
Copy

totalPages

isFirstPage

• get isFirstPage(): boolean

  Returns if the current page is the first page.

  const lastPage = this.paginator.isFirstPage;
  Copy

  Returns boolean

isLastPage

• get isLastPage(): boolean

  Returns if the current page is the last page.

  const lastPage = this.paginator.isLastPage;
  Copy

  Returns boolean

nativeElement

• get nativeElement(): any

  Returns any

overlaySettings

• get overlaySettings(): OverlaySettings

  Sets custom OverlaySettings.

  <igx-paginator [overlaySettings] = "customOverlaySettings"></igx-paginator>
  Copy

  Returns OverlaySettings

• set overlaySettings(value: OverlaySettings): void

  Parameters

  • value: OverlaySettings

  Returns void

page

• get page(): number

  Gets/Sets the current page of the paginator. The default is 0.

  let page = this.paginator.page;
  Copy

  Memberof

  IgxPaginatorComponent

  Returns number

• set page(value: number): void

  Parameters

  • value: number

  Returns void

perPage

• get perPage(): number

  Gets/Sets the number of visible items per page in the paginator. The default is 15.

  let itemsPerPage = this.paginator.perPage;
  Copy

  Memberof

  IgxPaginatorComponent

  Returns number

• set perPage(value: number): void

  Parameters

  • value: number

  Returns void

resourceStrings

• get resourceStrings(): IPaginatorResourceStrings

  An accessor that returns the resource strings.

  Returns IPaginatorResourceStrings

• set resourceStrings(value: IPaginatorResourceStrings): void

  An accessor that sets the resource strings. By default it uses EN resources.

  Parameters

  • value: IPaginatorResourceStrings

  Returns void

selectOptions

• get selectOptions(): number[]

  Sets custom options in the select of the paginator

  let options = this.paginator.selectOptions;
  Copy

  Memberof

  IgxPaginatorComponent

  Returns number[]

• set selectOptions(value: number[]): void

  Parameters

  • value: number[]

  Returns void

totalRecords

• get totalRecords(): number

  Sets the total records.

  let totalRecords = this.paginator.totalRecords;
  Copy

  Memberof

  IgxPaginatorComponent

  Returns number

• set totalRecords(value: number): void

  Parameters

  • value: number

  Returns void

nextPage

• nextPage(): void

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

  this.paginator.nextPage();
  Copy

  Memberof

  IgxPaginatorComponent

  Returns void

paginate

• paginate(val: number): void

  Goes to the desired page index.

  this.paginator.paginate(1);
  Copy

  Memberof

  IgxPaginatorComponent

  Parameters

  • val: number

  Returns void

previousPage

• previousPage(): void

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

  this.paginator.previousPage();
  Copy

  Memberof

  IgxPaginatorComponent

  Returns void