Class WorkerPAGView

Hierarchy

WorkerPAGView

Index

Methods

init duration play pause stop setRepeatCount getProgress currentFrame setProgress scaleMode setScaleMode flush getDebugData destroy

Constructors

Properties

key worker isDestroyed

Methods

`Static` init

init(file: WorkerPAGFile, canvas: HTMLCanvasElement, initOptions?: PAGViewOptions): Promise<WorkerPAGView>
Create pag view.

Returns
Parameters
- file: WorkerPAGFile
  
  pag file.
- canvas: HTMLCanvasElement
  
  target render canvas.
- Optional initOptions: PAGViewOptions
  
  pag view options
Returns Promise<WorkerPAGView>
- Defined in src/worker/pag-view.ts:19

duration

duration(): Promise<number>
The duration of current composition in microseconds.

Returns Promise<number>
- Defined in src/worker/pag-view.ts:51

play

play(): Promise<undefined>
Start the animation.

Returns Promise<undefined>
- Defined in src/worker/pag-view.ts:61

pause

pause(): Promise<void>
Pause the animation.

Returns Promise<void>
- Defined in src/worker/pag-view.ts:67

stop

stop(): Promise<void>
Stop the animation.

Returns Promise<void>
- Defined in src/worker/pag-view.ts:73

setRepeatCount

setRepeatCount(repeatCount: number): Promise<void>
Set the number of times the animation will repeat. The default is 1, which means the animation will play only once. 0 means the animation will play infinity times.
Parameters
- repeatCount: number
Returns Promise<void>
- Defined in src/worker/pag-view.ts:80

getProgress

getProgress(): Promise<number>
Returns the current progress of play position, the value is from 0.0 to 1.0. It is applied only when the composition is not null.

Returns Promise<number>
- Defined in src/worker/pag-view.ts:91

currentFrame

currentFrame(): Promise<number>
Returns the current frame.

Returns Promise<number>
- Defined in src/worker/pag-view.ts:101

setProgress

setProgress(progress: number): Promise<undefined>
Set the progress of play position, the value is from 0.0 to 1.0.
Parameters
- progress: number
Returns Promise<undefined>
- Defined in src/worker/pag-view.ts:111

scaleMode

scaleMode(): Promise<number>
Returns the current scale mode.

Returns Promise<number>
- Defined in src/worker/pag-view.ts:124

setScaleMode

setScaleMode(value: PAGScaleMode): Promise<void>
Specifies the rule of how to scale the pag content to fit the surface size. The matrix changes when this method is called.
Parameters
- value: PAGScaleMode
Returns Promise<void>
- Defined in src/worker/pag-view.ts:135

flush

flush(): Promise<boolean>
Call this method to render current position immediately. If the play() method is already called, there is no need to call it. Returns true if the content has changed.

Returns Promise<boolean>
- Defined in src/worker/pag-view.ts:146

getDebugData

getDebugData(): Promise<DebugData>
Returns Promise<DebugData>
- Defined in src/worker/pag-view.ts:150

destroy

destroy(): void
Returns void
- Defined in src/worker/pag-view.ts:158

Constructors

constructor

new WorkerPAGView(worker: Worker, key: number): WorkerPAGView
Parameters
- worker: Worker
- key: number
Returns WorkerPAGView
- Defined in src/worker/pag-view.ts:44

Properties

key

key: number

worker

worker: Worker

isDestroyed

isDestroyed: boolean = false

Generated using TypeDoc