Class UmbPaginationManager

Hierarchy

EventTarget
- UmbPaginationManager

Constructors

constructor

new UmbPaginationManager(): UmbPaginationManager
Returns UmbPaginationManager
Inherited from EventTarget.constructor
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11586

Properties

`Readonly`currentPage

currentPage: Observable<number> = ...

`Readonly`pageSize

pageSize: Observable<number> = ...

`Readonly`skip

skip: Observable<number> = ...

`Readonly`totalItems

totalItems: Observable<number> = ...

`Readonly`totalPages

totalPages: Observable<number> = ...

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from EventTarget.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

clear

clear(): void
Clears the pagination manager values and resets them to their default values

Returns void
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:114

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getCurrentPageNumber

getCurrentPageNumber(): number
Gets the current page number

Returns number
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:78

getDisplayEnd

getDisplayEnd(): number
Gets the index of the last item on the current page (for display).

Returns number
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:156

getDisplayStart

getDisplayStart(): number
Gets the index of the first item on the current page (for display).

Returns number
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:147

getPageSize

getPageSize(): number
Gets the number of items per page

Returns number
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:41

getSkip

getSkip(): number
Gets the number of items to skip

Returns number
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:106

getTotalItems

getTotalItems(): number
Gets the total number of items

Returns number
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:50

getTotalPages

getTotalPages(): number
Gets the total number of pages

Returns number
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:69

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from EventTarget.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

setCurrentPageNumber

setCurrentPageNumber(pageNumber: number): void
Sets the current page number
Parameters
- pageNumber: number
Returns void
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:87

setPageSize

setPageSize(pageSize: number): void
Sets the number of items per page and recalculates the total number of pages
Parameters
- pageSize: number
Returns void
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:31

setTotalItems

setTotalItems(totalItems: number): void
Sets the total number of items and recalculates the total number of pages
Parameters
- totalItems: number
Returns void
Memberof
UmbPaginationManager
- Defined in src/packages/core/utils/pagination-manager/pagination.manager.ts:59

Class UmbPaginationManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns UmbPaginationManager

Properties

ReadonlycurrentPage

ReadonlypageSize

Readonlyskip

ReadonlytotalItems

ReadonlytotalPages

Methods

addEventListener

Parameters

Returns void

clear

Returns void

Memberof

dispatchEvent

Parameters

Returns boolean

getCurrentPageNumber

Returns number

Memberof

getDisplayEnd

Returns number

Memberof

getDisplayStart

Returns number

Memberof

getPageSize

Returns number

Memberof

getSkip

Returns number

Memberof

getTotalItems

Returns number

Memberof

getTotalPages

Returns number

Memberof

removeEventListener

Parameters

Returns void

setCurrentPageNumber

Parameters

Returns void

Memberof

setPageSize

Parameters

Returns void

Memberof

setTotalItems

Parameters

Returns void

Memberof

Settings

On This Page

`Readonly`currentPage

`Readonly`pageSize

`Readonly`skip

`Readonly`totalItems

`Readonly`totalPages