Frame

Frame

new Frame(pFrameDataopt)

Create this frame class instance.
Source:
Parameters:
Name Type Attributes Description
pFrameData Array <optional>
 The frame data that is used to build this frame.

Classes

Frame

Methods

export() → {Array}

Exports this frame's data into proper vyi format.
Source:
Returns:
Type:
Array
An array of data related to this frame in the proper vyi format.

getDataURL() → {DataURL}

Gets the data URL of this frame.
Source:
Returns:
Type:
DataURL
- The base64 data of this image.

getDelay() → {number}

Gets the delay of this frame.
Source:
Returns:
Type:
number
The delay of this frame.

getHeight() → {number}

Gets the height of the frame.
Source:
Returns:
Type:
number
The height of the frame.

getIndex() → {number}

Gets the index of this frame.
Source:
Returns:
Type:
number
The index of this frame.

getParent() → {Icon}

Gets the icon this frame belongs to.
Source:
Returns:
Type:
Icon
The icon this frame belongs to.

getSize() → {Object}

Gets the width and height of this frame and returns it.
Source:
Returns:
Type:
Object
An object with the width and height of this frame.

getVyi() → {VYI}

Gets the vyi this frame belongs to.
Source:
Returns:
Type:
VYI
The vyi this frame belongs to.

getWidth() → {number}

Gets the width of the frame.
Source:
Returns:
Type:
number
The width of the frame.

setDataURL(pDataURL) → {self}

Sets the data url of this frame.
Source:
Parameters:
Name Type Description
pDataURL DataURL The base64 data of this image.
Returns:
Type:
self
This frame instance.

setDelay(pDelay) → {self}

Sets the delay of this frame in ms.
Source:
Parameters:
Name Type Description
pDelay number The delay in ms to set this frame to.
Returns:
Type:
self
This frame instance.