Paginator component description
Constructors
Section titled "Constructors"IgcPaginatorComponent
new IgcPaginatorComponent(args: any[]): IgcPaginatorComponentReturns IgcPaginatorComponent
Properties
Section titled "Properties"tagName
Section titled "tagName"The tagName read-only property of the Element interface returns the tag name of the element on which it's called.
tagName: stringAccessors
Section titled "Accessors"isFirstPage
Section titled "isFirstPage"Returns if the current page is the first page.
get isFirstPage(): boolean
Returns boolean
isLastPage
Section titled "isLastPage"Returns if the current page is the last page.
get isLastPage(): boolean
Returns boolean
overlaySettings
Section titled "overlaySettings"get overlaySettings(): IgcOverlaySettings
Returns IgcOverlaySettings
Sets custom OverlaySettings.
set overlaySettings(value: IgcOverlaySettings): voidParameters
- value:
IgcOverlaySettings
Returns void
get page(): number
Returns number
Gets/Sets the current page of the paginator. The default is 0.
set page(value: number): voidParameters
- value:
number
Returns void
perPage
Section titled "perPage"get perPage(): number
Returns number
Gets/Sets the number of visible items per page in the paginator. The default is 15.
set perPage(value: number): voidParameters
- value:
number
Returns void
resourceStrings
Section titled "resourceStrings"get resourceStrings(): IgcPaginatorResourceStrings
Returns IgcPaginatorResourceStrings
An accessor that sets the resource strings. By default it uses EN resources.
set resourceStrings(value: IgcPaginatorResourceStrings): voidParameters
- value:
IgcPaginatorResourceStrings
Returns void
selectOptions
Section titled "selectOptions"get selectOptions(): number[]
Returns number[]
Sets custom options in the select of the paginator
set selectOptions(value: number[]): voidParameters
- value:
number[]
Returns void
totalPages
Section titled "totalPages"get totalPages(): number
Returns number
Total pages calculated from totalRecords and perPage
set totalPages(value: number): voidParameters
- value:
number
Returns void
totalRecords
Section titled "totalRecords"get totalRecords(): number
Returns number
Sets the total records.
set totalRecords(value: number): voidParameters
- value:
number
Returns void
Methods
Section titled "Methods"addEventListener
Section titled "addEventListener"Inherited from: EventEmitterMixin<IgcPaginatorComponentEventMap, Constructor<LitElement>>(LitElement)
addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): voidParameters
- type:
K - listener:
object - options:
boolean | AddEventListenerOptions
Returns void
nextPage
Section titled "nextPage"Goes to the next page of the paginator, 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 paginator, if the paginator is not already at the first page.
previousPage(): voidReturns void
removeEventListener
Section titled "removeEventListener"Inherited from: EventEmitterMixin<IgcPaginatorComponentEventMap, Constructor<LitElement>>(LitElement)
removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): voidParameters
- type:
K - listener:
object - options:
boolean | EventListenerOptions
Returns void
register
Section titled "register"register(): voidReturns void
Events
Section titled "Events"pageChange
Section titled "pageChange"Emitted after the current page is changed.
pageChange: CustomEvent<number>paging
Section titled "paging"Emitted before paging is performed.
paging: CustomEvent<IgcPageCancellableEventArgs>pagingDone
Section titled "pagingDone"Emitted after paging is performed.
pagingDone: CustomEvent<IgcPageEventArgs>perPageChange
Section titled "perPageChange"Emitted when perPage property value of the paginator is changed.
perPageChange: CustomEvent<number>