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: stringoverlaySettings
Section titled "overlaySettings"overlaySettings: IgcOverlaySettingspage: numberperPage
Section titled "perPage"perPage: numberresourceStrings
Section titled "resourceStrings"resourceStrings: IgcPaginatorResourceStringsselectOptions
Section titled "selectOptions"selectOptions: number[]totalPages
Section titled "totalPages"totalPages: numbertotalRecords
Section titled "totalRecords"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"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 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
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>