Class PageFlip

Class representing a main PageFlip object

Hierarchy

EventObject
- PageFlip

Index

Constructors

constructor

new PageFlip(inBlock: HTMLElement, setting: Record<string, number | string | boolean>): PageFlip

- Defined in PageFlip.ts:36
Create a new PageFlip instance

Parameters
- inBlock: HTMLElement
  
  Root HTML Element
- setting: Record<string, number | string | boolean>
  
  Configuration object
Returns PageFlip

Methods

destroy

destroy(): void

- Defined in PageFlip.ts:55
Destructor. Remove a root HTML element and all event handlers

Returns void

flip

flip(page: number, corner?: FlipCorner): void

- Defined in PageFlip.ts:193
Turn to the specified page number (with animation)

Parameters
- page: number
  
  New page number
- Default value corner: FlipCorner = FlipCorner.TOP
  
  Active page corner when turning
Returns void

flipNext

flipNext(corner?: FlipCorner): void

- Defined in PageFlip.ts:174
Turn to the next page (with animation)

Parameters
- Default value corner: FlipCorner = FlipCorner.TOP
  
  Active page corner when turning
Returns void

flipPrev

flipPrev(corner?: FlipCorner): void

- Defined in PageFlip.ts:183
Turn to the prev page (with animation)

Parameters
- Default value corner: FlipCorner = FlipCorner.TOP
  
  Active page corner when turning
Returns void

getBoundsRect

getBoundsRect(): PageRect

- Defined in PageFlip.ts:286
Get current book sizes and position

Returns PageRect

getCurrentPageIndex

getCurrentPageIndex(): number

- Defined in PageFlip.ts:240
Get the index of the current page in the page list (starts at 0)

Returns number

getFlipController

getFlipController(): Flip

- Defined in PageFlip.ts:268
Get current object responsible for flipping

Returns Flip

getOrientation

getOrientation(): Orientation

- Defined in PageFlip.ts:277
Get current page orientation

Returns Orientation

Сurrent orientation: portrait or landscape

getPage

getPage(pageIndex: number): Page

- Defined in PageFlip.ts:250
Get page from collection by number

Parameters
- pageIndex: number
Returns Page

getPageCollection

getPageCollection(): PageCollection

- Defined in PageFlip.ts:322
Get page collection

Returns PageCollection

getPageCount

getPageCount(): number

- Defined in PageFlip.ts:231
Get the total number of pages in a book

Returns number

getRender

getRender(): Render

- Defined in PageFlip.ts:259
Get the current rendering object

Returns Render

getSettings

getSettings(): FlipSetting

- Defined in PageFlip.ts:295
Get configuration object

Returns FlipSetting

getState

getState(): FlippingState

- Defined in PageFlip.ts:313
Get current flipping state

Returns FlippingState

getUI

getUI(): UI

- Defined in PageFlip.ts:304
Get UI object

Returns UI

loadFromHTML

loadFromHTML(items: NodeListOf<HTMLElement> | HTMLElement[]): void

- Defined in PageFlip.ts:97
Load pages from HTML elements on the HTML mode

Parameters
- items: NodeListOf<HTMLElement> | HTMLElement[]
  
  List of pages as HTML Element
Returns void

loadFromImages

loadFromImages(imagesHref: string[]): void

- Defined in PageFlip.ts:73
Load pages from images on the Canvas mode

Parameters
- imagesHref: string[]
  
  List of paths to images
Returns void

off

off(event: string): void

Inherited from EventObject.off
- Defined in Event/EventObject.ts:45
Removing all handlers from an event

Parameters
- event: string
  
  Event name
Returns void

on

on(eventName: string, callback: EventCallback): EventObject

Inherited from EventObject.on
- Defined in Event/EventObject.ts:30
Add new event handler

Parameters
- eventName: string
- callback: EventCallback
Returns EventObject

startUserTouch

startUserTouch(pos: Point): void

- Defined in PageFlip.ts:331
Start page turning. Called when a user clicks or touches

Parameters
- pos: Point
  
  Touch position in coordinates relative to the book
Returns void

turnToNextPage

turnToNextPage(): void

- Defined in PageFlip.ts:156
Turn to the next page (without animation)

Returns void

turnToPage

turnToPage(page: number): void

- Defined in PageFlip.ts:165
Turn to the specified page number (without animation)

Parameters
- page: number
  
  New page number
Returns void

turnToPrevPage

turnToPrevPage(): void

- Defined in PageFlip.ts:149
Turn to the previous page (without animation)

Returns void

update

update(): void

- Defined in PageFlip.ts:63
Update the render area. Re-show current page.

Returns void

updateFromHtml

updateFromHtml(items: NodeListOf<HTMLElement> | HTMLElement[]): void

- Defined in PageFlip.ts:135
Update current pages from HTML

Parameters
- items: NodeListOf<HTMLElement> | HTMLElement[]
  
  List of pages as HTML Element
Returns void

updateFromImages

updateFromImages(imagesHref: string[]): void

- Defined in PageFlip.ts:120
Update current pages from images

Parameters
- imagesHref: string[]
  
  List of paths to images
Returns void

updateOrientation

updateOrientation(newOrientation: Orientation): void

- Defined in PageFlip.ts:220
Call a page orientation change event trigger. Update UI and rendering area

Parameters
- newOrientation: Orientation
  
  New page orientation (portrait, landscape)
Returns void

updatePageIndex

updatePageIndex(newPage: number): void

- Defined in PageFlip.ts:211
Call a page number change event trigger

Parameters
- newPage: number
  
  New page Number
Returns void

updateState

updateState(newState: FlippingState): void

- Defined in PageFlip.ts:202
Call a state change event trigger

Parameters
- newState: FlippingState
  
  New state of the object
Returns void

userMove

userMove(pos: Point, isTouch: boolean): void

- Defined in PageFlip.ts:343
Called when a finger / mouse moves

Parameters
- pos: Point
  
  Touch position in coordinates relative to the book
- isTouch: boolean
  
  True if there was a touch event, not a mouse click
Returns void

userStop

userStop(pos: Point, isSwipe?: boolean): void

- Defined in PageFlip.ts:360
Сalled when the user has stopped touching

Parameters
- pos: Point
  
  Touch end position in coordinates relative to the book
- Default value isSwipe: boolean = false
  
  true if there was a mobile swipe event
Returns void

Generated using TypeDoc