Class HTMLRender

Class responsible for rendering the HTML book

Hierarchy

Render
- HTMLRender

Index

Constructors

constructor

new HTMLRender(app: PageFlip, setting: FlipSetting, element: HTMLElement, items: NodeListOf<HTMLElement> | HTMLElement[]): HTMLRender

Overrides Render.__constructor
- Defined in Render/HTMLRender.ts:22
Parameters
- app: PageFlip
  
  PageFlip object
- setting: FlipSetting
  
  Configuration object
- element: HTMLElement
  
  Parent HTML Element
- items: NodeListOf<HTMLElement> | HTMLElement[]
  
  List of pages as HTML Element
Returns HTMLRender

Methods

clearShadow

clearShadow(): void

Overrides Render.clearShadow
- Defined in Render/HTMLRender.ts:44
Returns void

convertRectToGlobal

convertRectToGlobal(rect: RectPoints, direction?: FlipDirection): RectPoints

Inherited from Render.convertRectToGlobal
- Defined in Render/Render.ts:480
Casting the coordinates of the corners of the rectangle in the coordinates relative to the window

Parameters
- rect: RectPoints
  
  Coordinates of the corners of the rectangle relative to the work page
- Optional direction: FlipDirection
  
  Current flipping direction
Returns RectPoints

Coordinates of the corners of the rectangle relative to the window

convertToBook

convertToBook(pos: Point): Point

Inherited from Render.convertToBook
- Defined in Render/Render.ts:410
Coordinate conversion function. Window coordinates -> to book coordinates

Parameters
- pos: Point
  
  Global coordinates relative to the window
Returns Point

Coordinates relative to the book

convertToGlobal

convertToGlobal(pos: Point, direction?: FlipDirection): Point

Inherited from Render.convertToGlobal
- Defined in Render/Render.ts:454
Coordinate conversion function. Coordinates relative to the work page -> Window coordinates

Parameters
- pos: Point
  
  Coordinates relative to the work page
- Optional direction: FlipDirection
  
  Current flipping direction
Returns Point

Global coordinates relative to the window

convertToPage

convertToPage(pos: Point, direction?: FlipDirection): Point

Inherited from Render.convertToPage
- Defined in Render/Render.ts:431
Coordinate conversion function. Window coordinates -> to current coordinates of the working page

Parameters
- pos: Point
  
  Global coordinates relative to the window
- Optional direction: FlipDirection
  
  Current flipping direction
Returns Point

Coordinates relative to the work page

finishAnimation

finishAnimation(): void

Inherited from Render.finishAnimation
- Defined in Render/Render.ts:171
End the current animation process and call the callback

Returns void

getBlockHeight

getBlockHeight(): number

Inherited from Render.getBlockHeight
- Defined in Render/Render.ts:301
Get parent block offset height

Returns number

getBlockWidth

getBlockWidth(): number

Inherited from Render.getBlockWidth
- Defined in Render/Render.ts:294
Get parent block offset width

Returns number

getDirection

getDirection(): FlipDirection

Inherited from Render.getDirection
- Defined in Render/Render.ts:308
Get current flipping direction

Returns FlipDirection

getOrientation

getOrientation(): Orientation

Inherited from Render.getOrientation
- Defined in Render/Render.ts:331
Get current book orientation

Returns Orientation

getRect

getRect(): PageRect

Inherited from Render.getRect
- Defined in Render/Render.ts:315
Сurrent size and position of the book

Returns PageRect

getSettings

getSettings(): FlipSetting

Inherited from Render.getSettings
- Defined in Render/Render.ts:324
Get configuration object

Returns FlipSetting

isSafari

isSafari(): boolean

Inherited from Render.isSafari
- Defined in Render/Render.ts:419
Returns boolean

setBottomPage

setBottomPage(page: Page): void

Inherited from Render.setBottomPage
- Defined in Render/Render.ts:378
Set next page at the time of flipping

Parameters
- page: Page
Returns void

setDirection

setDirection(direction: FlipDirection): void

Inherited from Render.setDirection
- Defined in Render/Render.ts:349
Set flipping direction

Parameters
- direction: FlipDirection
Returns void

setFlippingPage

setFlippingPage(page: Page): void

Inherited from Render.setFlippingPage
- Defined in Render/Render.ts:392
Set currently flipping page

Parameters
- page: Page
Returns void

setLeftPage

setLeftPage(page: Page): void

Overrides Render.setLeftPage
- Defined in Render/HTMLRender.ts:387
Parameters
- page: Page
Returns void

setPageRect

setPageRect(pageRect: RectPoints): void

Inherited from Render.setPageRect
- Defined in Render/Render.ts:340
Set page area while flipping

Parameters
- pageRect: RectPoints
Returns void

setRightPage

setRightPage(page: Page): void

Overrides Render.setRightPage
- Defined in Render/HTMLRender.ts:380
Parameters
- page: Page
Returns void

setShadowData

setShadowData(pos: Point, angle: number, t: number, direction: FlipDirection): void

Overrides Render.setShadowData
- Defined in Render/HTMLRender.ts:59
Parameters
- pos: Point
- angle: number
- t: number
- direction: FlipDirection
Returns void

start

start(): void

Inherited from Render.start
- Defined in Render/Render.ts:134
Running requestAnimationFrame, and rendering process

Returns void

startAnimation

startAnimation(frames: FrameAction[], duration: number, onAnimateEnd: AnimationSuccessAction): void

Inherited from Render.startAnimation
- Defined in Render/Render.ts:152
Start a new animation process

Parameters
- frames: FrameAction[]
  
  Frame list
- duration: number
  
  total animation duration
- onAnimateEnd: AnimationSuccessAction
  
  Animation callback function
Returns void

update

update(): void

Overrides Render.update
- Defined in Render/HTMLRender.ts:394
Returns void

Generated using TypeDoc