Class PAGImageLayer

Hierarchy

PAGLayer
- PAGImageLayer

Methods

`Static` make

make(width: number, height: number, duration: number): PAGImageLayer
Make a empty PAGImageLayer with specified size.
Parameters
- width: number
- height: number
- duration: number
Returns PAGImageLayer
- Defined in src/pag-image-layer.ts:15

contentDuration

contentDuration(): number
Returns the content duration in microseconds, which indicates the minimal length required for replacement.

Returns number
- Defined in src/pag-image-layer.ts:25

getVideoRanges

getVideoRanges(): PAGVideoRange[]
Returns the time ranges of the source video for replacement.

Returns PAGVideoRange[]
- Defined in src/pag-image-layer.ts:31

replaceImage

replaceImage(pagImage: PAGImage): void
[Deprecated] Replace the original image content with the specified PAGImage object. Passing in null for the image parameter resets the layer to its default image content. The replaceImage() method modifies all associated PAGImageLayers that have the same editableIndex to this layer.
Parameters
- pagImage: PAGImage
Returns void
- Defined in src/pag-image-layer.ts:43

setImage

setImage(pagImage: PAGImage): void
Replace the original image content with the specified PAGImage object. Passing in null for the image parameter resets the layer to its default image content. The setImage() method only modifies the content of the calling PAGImageLayer.
Parameters
- pagImage: PAGImage
Returns void
- Defined in src/pag-image-layer.ts:53

layerTimeToContent

layerTimeToContent(layerTime: number): number
Converts the time from the PAGImageLayer's timeline to the replacement content's timeline. The time is in microseconds.
Parameters
- layerTime: number
Returns number
- Defined in src/pag-image-layer.ts:60

contentTimeToLayer

contentTimeToLayer(contentTime: number): number
Converts the time from the replacement content's timeline to the PAGLayer's timeline. The time is in microseconds.
Parameters
- contentTime: number
Returns number
- Defined in src/pag-image-layer.ts:67

imageBytes

imageBytes(): null | Uint8Array
The default image data of this layer, which is webp format.

Returns null | Uint8Array
- Defined in src/pag-image-layer.ts:73

uniqueID

uniqueID(): number
Returns a globally unique id for this object.

Returns number
Inherited from PAGLayer.uniqueID
- Defined in src/pag-layer.ts:20

layerType

layerType(): LayerType
Returns the type of layer.

Returns LayerType
Inherited from PAGLayer.layerType
- Defined in src/pag-layer.ts:26

layerName

layerName(): string
Returns the name of the layer.

Returns string
Inherited from PAGLayer.layerName
- Defined in src/pag-layer.ts:32

matrix

matrix(): Matrix
A matrix object containing values that alter the scaling, rotation, and translation of the layer. Altering it does not change the animation matrix, and it will be concatenated to current animation matrix for displaying.

Returns Matrix
Inherited from PAGLayer.matrix
- Defined in src/pag-layer.ts:40

setMatrix

setMatrix(matrix: Matrix): void
Parameters
- matrix: Matrix
Returns void
Inherited from PAGLayer.setMatrix
- Defined in src/pag-layer.ts:46

resetMatrix

resetMatrix(): void
Resets the matrix to its default value.

Returns void
Inherited from PAGLayer.resetMatrix
- Defined in src/pag-layer.ts:52

getTotalMatrix

getTotalMatrix(): Matrix
The final matrix for displaying, it is the combination of the matrix property and current matrix from animation.

Returns Matrix
Inherited from PAGLayer.getTotalMatrix
- Defined in src/pag-layer.ts:59

alpha

alpha(): number
Returns the current alpha of the layer if previously set.

Returns number
Inherited from PAGLayer.alpha
- Defined in src/pag-layer.ts:67

setAlpha

setAlpha(opacity: Number): void
Set the alpha of the layer, which will be concatenated to the current animation opacity for displaying.
Parameters
- opacity: Number
Returns void
Inherited from PAGLayer.setAlpha
- Defined in src/pag-layer.ts:74

visible

visible(): boolean
Whether or not the layer is visible.

Returns boolean
Inherited from PAGLayer.visible
- Defined in src/pag-layer.ts:81

setVisible

setVisible(visible: boolean): void
Set the visible of the layer.
Parameters
- visible: boolean
Returns void
Inherited from PAGLayer.setVisible
- Defined in src/pag-layer.ts:87

editableIndex

editableIndex(): number
Ranges from 0 to PAGFile.numTexts - 1 if the layer type is text, or from 0 to PAGFile.numImages -1 if the layer type is image, otherwise returns -1.

Returns number
Inherited from PAGLayer.editableIndex
- Defined in src/pag-layer.ts:94

parent

parent(): PAGComposition
Returns the parent PAGComposition of current PAGLayer.

Returns PAGComposition
Inherited from PAGLayer.parent
- Defined in src/pag-layer.ts:100

markers

markers(): Vector<Marker>
Returns the markers of this layer.

Returns Vector<Marker>
Inherited from PAGLayer.markers
- Defined in src/pag-layer.ts:108

localTimeToGlobal

localTimeToGlobal(localTime: number): number
Converts the time from the PAGLayer's (local) timeline to the PAGSurface (global) timeline. The time is in microseconds.
Parameters
- localTime: number
Returns number
Inherited from PAGLayer.localTimeToGlobal
- Defined in src/pag-layer.ts:117

globalToLocalTime

globalToLocalTime(globalTime: number): number
Converts the time from the PAGSurface (global) to the PAGLayer's (local) timeline timeline. The time is in microseconds.
Parameters
- globalTime: number
Returns number
Inherited from PAGLayer.globalToLocalTime
- Defined in src/pag-layer.ts:124

duration

duration(): number
The duration of the layer in microseconds, indicates the length of the visible range.

Returns number
Inherited from PAGLayer.duration
- Defined in src/pag-layer.ts:130

frameRate

frameRate(): number
Returns the frame rate of this layer.

Returns number
Inherited from PAGLayer.frameRate
- Defined in src/pag-layer.ts:136

startTime

startTime(): number
The start time of the layer in microseconds, indicates the start position of the visible range in parent composition. It could be negative value.

Returns number
Inherited from PAGLayer.startTime
- Defined in src/pag-layer.ts:143

setStartTime

setStartTime(time: number): void
Set the start time of the layer, in microseconds.
Parameters
- time: number
Returns void
Inherited from PAGLayer.setStartTime
- Defined in src/pag-layer.ts:149

currentTime

currentTime(): number
The current time of the layer in microseconds, the layer is invisible if currentTime is not in the visible range (startTime <= currentTime < startTime + duration).

Returns number
Inherited from PAGLayer.currentTime
- Defined in src/pag-layer.ts:156

setCurrentTime

setCurrentTime(time: number): void
Set the current time of the layer, in microseconds.
Parameters
- time: number
Returns void
Inherited from PAGLayer.setCurrentTime
- Defined in src/pag-layer.ts:162

getProgress

getProgress(): number
Returns the current progress of play position, the value ranges from 0.0 to 1.0.

Returns number
Inherited from PAGLayer.getProgress
- Defined in src/pag-layer.ts:168

setProgress

setProgress(percent: number): void
Set the progress of play position, the value ranges from 0.0 to 1.0. A value of 0.0 represents the frame at startTime. A value of 1.0 represents the frame at the end of duration.
Parameters
- percent: number
Returns void
Inherited from PAGLayer.setProgress
- Defined in src/pag-layer.ts:175

preFrame

preFrame(): void
Set the progress of play position to the previous frame.

Returns void
Inherited from PAGLayer.preFrame
- Defined in src/pag-layer.ts:181

nextFrame

nextFrame(): void
Set the progress of play position to the next frame.

Returns void
Inherited from PAGLayer.nextFrame
- Defined in src/pag-layer.ts:187

getBounds

getBounds(): Rect
Returns a rectangle that defines the original area of the layer, which is not transformed by the matrix.

Returns Rect
Inherited from PAGLayer.getBounds
- Defined in src/pag-layer.ts:194

trackMatteLayer

trackMatteLayer(): PAGLayer
Returns trackMatte layer of this layer.

Returns PAGLayer
Inherited from PAGLayer.trackMatteLayer
- Defined in src/pag-layer.ts:200

excludedFromTimeline

excludedFromTimeline(): boolean
Indicate whether this layer is excluded from parent's timeline. If set to true, this layer's current time will not change when parent's current time changes.

Returns boolean
Inherited from PAGLayer.excludedFromTimeline
- Defined in src/pag-layer.ts:209

setExcludedFromTimeline

setExcludedFromTimeline(value: boolean): void
Set the excludedFromTimeline flag of this layer.
Parameters
- value: boolean
Returns void
Inherited from PAGLayer.setExcludedFromTimeline
- Defined in src/pag-layer.ts:215

isPAGFile

isPAGFile(): boolean
Returns true if this layer is a PAGFile.

Returns boolean
Inherited from PAGLayer.isPAGFile
- Defined in src/pag-layer.ts:221

asTypeLayer

asTypeLayer(): PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Returns this layer as a type layer.

Returns PAGImageLayer | PAGLayer | PAGSolidLayer | PAGTextLayer
Inherited from PAGLayer.asTypeLayer
- Defined in src/pag-layer.ts:227

isDelete

isDelete(): boolean
Returns boolean
Inherited from PAGLayer.isDelete
- Defined in src/pag-layer.ts:231

destroy

destroy(): void
Returns void
Inherited from PAGLayer.destroy
- Defined in src/pag-layer.ts:235

Constructors

constructor

new PAGImageLayer(wasmIns: any): PAGImageLayer
Parameters
- wasmIns: any
Returns PAGImageLayer
Inherited from PAGLayer.constructor
- Defined in src/pag-layer.ts:14

Properties

wasmIns

wasmIns: any

isDestroyed

isDestroyed: boolean = false

Generated using TypeDoc