Paginator component description
Properties
Section titled "Properties"overlaySettings
Section titled "overlaySettings"Sets custom OverlaySettings.
overlaySettings: IgrOverlaySettingsGets/Sets the current page of the paginator. The default is 0.
page: numberperPage
Section titled "perPage"Gets/Sets the number of visible items per page in the paginator. The default is 15.
perPage: numberresourceStrings
Section titled "resourceStrings"An accessor that sets the resource strings. By default it uses EN resources.
resourceStrings: IgrPaginatorResourceStringsselectOptions
Section titled "selectOptions"Sets custom options in the select of the paginator
selectOptions: number[]totalPages
Section titled "totalPages"Total pages calculated from totalRecords and perPage
totalPages: numbertotalRecords
Section titled "totalRecords"Sets the total records.
totalRecords: numberAccessors
Section titled "Accessors"isFirstPage
Section titled "isFirstPage"Returns if the current page is the first page.
get isFirstPage(): booleanReturns boolean
isLastPage
Section titled "isLastPage"Returns if the current page is the last page.
get isLastPage(): booleanReturns boolean
Methods
Section titled "Methods"nextPage
Section titled "nextPage"Goes to the next page of the PaginatorComponent, if the paginator is not already at the last page.
``
nextPage(): voidReturns void
paginate
Section titled "paginate"Goes to the desired page index. ``
paginate(val: number): voidParameters
- val:
number
Returns void
previousPage
Section titled "previousPage"Goes to the previous page of the PaginatorComponent, if the paginator is not already at the first page.
``
previousPage(): voidReturns void
Events
Section titled "Events"onPageChange
Section titled "onPageChange"onPageChange(args: CustomEvent<number>): voidParameters
- args:
CustomEvent<number>
Returns void
onPaging
Section titled "onPaging"onPaging(args: CustomEvent<IgrPageCancellableEventArgs>): voidParameters
Returns void
onPagingDone
Section titled "onPagingDone"onPagingDone(args: CustomEvent<IgrPageEventArgs>): voidParameters
- args:
CustomEvent<IgrPageEventArgs>
Returns void
onPerPageChange
Section titled "onPerPageChange"onPerPageChange(args: CustomEvent<number>): voidParameters
- args:
CustomEvent<number>