Class PageCollection

Сlass representing a collection of pages

Hierarchy

PageCollection
- ImagePageCollection
- HTMLPageCollection

Index

Methods

Methods

destroy

destroy(): void

- Defined in Collection/PageCollection.ts:44
Clear pages list

Returns void

getBottomPage

getBottomPage(direction: FlipDirection): Page

- Defined in Collection/PageCollection.ts:182
Get Next page at the time of flipping

Parameters
- direction: FlipDirection
Returns Page

getCurrentPageIndex

getCurrentPageIndex(): number

- Defined in Collection/PageCollection.ts:226
Get the number of the current spread in book

Returns number

getCurrentSpreadIndex

getCurrentSpreadIndex(): number

- Defined in Collection/PageCollection.ts:249
Index of the current page in list

Returns number

getFlippingPage

getFlippingPage(direction: FlipDirection): Page

- Defined in Collection/PageCollection.ts:156
Get flipping page depending on the direction

Parameters
- direction: FlipDirection
Returns Page

getPage

getPage(pageIndex: number): Page

- Defined in Collection/PageCollection.ts:117
Get page by index

Parameters
- pageIndex: number
Returns Page

getPageCount

getPageCount(): number

- Defined in Collection/PageCollection.ts:101
Get the total number of pages

Returns number

getPages

getPages(): Page[]

- Defined in Collection/PageCollection.ts:108
Get the pages list

Returns Page[]

getSpreadIndexByPage

getSpreadIndexByPage(pageNum: number): number

- Defined in Collection/PageCollection.ts:89
Get spread index by page number

Parameters
- pageNum: number
  
  page index
Returns number

Abstract load

load(): void

- Defined in Collection/PageCollection.ts:39
Load pages

Returns void

nextBy

nextBy(current: Page): Page

- Defined in Collection/PageCollection.ts:130
Get the next page from the specified

Parameters
- current: Page
Returns Page

prevBy

prevBy(current: Page): Page

- Defined in Collection/PageCollection.ts:143
Get previous page from specified

Parameters
- current: Page
Returns Page

setCurrentSpreadIndex

setCurrentSpreadIndex(newIndex: number): void

- Defined in Collection/PageCollection.ts:258
Set new spread index as current

Parameters
- newIndex: number
  
  new spread index
Returns void

show

show(pageNum?: number): void

- Defined in Collection/PageCollection.ts:234
Show specified page

Parameters
- Default value pageNum: number = null
  
  Page index (from 0s)
Returns void

showNext

showNext(): void

- Defined in Collection/PageCollection.ts:206
Show next spread

Returns void

showPrev

showPrev(): void

- Defined in Collection/PageCollection.ts:216
Show prev spread

Returns void

Generated using TypeDoc