Class: ImageElement

Hierarchy

• TrackElement

  ↳ ImageElement

  ↳↳ EmojiElement

Table of contents

Constructors

• constructor

Methods

• getId
• getType
• getStart
• getEnd
• getDuration
• getTrackId
• getProps
• getMetadata
• getName
• getAnimation
• getOpacity
• setId
• setType
• setStart
• setEnd
• setTrackId
• setName
• setAnimation
• setOpacity
• setMetadata
• getTransition
• setTransition
• getParentSize
• getFrame
• getFrameEffects
• getBackgroundColor
• getObjectFit
• getSrc
• getRotation
• setRotation
• getPosition
• updateImageMeta
• setPosition
• setSrc
• setObjectFit
• setFrame
• setParentSize
• setMediaFilter
• setBackgroundColor
• setProps
• setFrameEffects
• addFrameEffect
• accept

Properties

• frameEffects
• frame

Constructors

constructor

• new ImageElement(src, parentSize): ImageElement

Parameters

Name	Type
src	string
parentSize	Size

Returns

ImageElement

Overrides

TrackElement.constructor

Defined in

core/elements/image.element.ts:16

Methods

getId

▸ getId(): string

Returns

string

Inherited from

TrackElement.getId

Defined in

core/elements/base.element.ts:31

---

getType

▸ getType(): string

Returns

string

Inherited from

TrackElement.getType

Defined in

core/elements/base.element.ts:35

---

getStart

▸ getStart(): number

Returns

number

Inherited from

TrackElement.getStart

Defined in

core/elements/base.element.ts:39

---

getEnd

▸ getEnd(): number

Returns

number

Inherited from

TrackElement.getEnd

Defined in

core/elements/base.element.ts:43

---

getDuration

▸ getDuration(): number

Returns

number

Inherited from

TrackElement.getDuration

Defined in

core/elements/base.element.ts:47

---

getTrackId

▸ getTrackId(): string

Returns

string

Inherited from

TrackElement.getTrackId

Defined in

core/elements/base.element.ts:51

---

getProps

▸ getProps(): Record<string, any>

Returns

Record<string, any>

Inherited from

TrackElement.getProps

Defined in

core/elements/base.element.ts:55

---

getMetadata

▸ getMetadata(): undefined | ElementMetadata

Returns

undefined | ElementMetadata

Inherited from

TrackElement.getMetadata

Defined in

core/elements/base.element.ts:59

---

getName

▸ getName(): string

Returns

string

Inherited from

TrackElement.getName

Defined in

core/elements/base.element.ts:63

---

getAnimation

▸ getAnimation(): undefined | ElementAnimation

Returns

undefined | ElementAnimation

Inherited from

TrackElement.getAnimation

Defined in

core/elements/base.element.ts:67

---

getOpacity

▸ getOpacity(): number

Returns

number

Inherited from

TrackElement.getOpacity

Defined in

core/elements/base.element.ts:82

---

setId

▸ setId(id): ImageElement

Parameters

Name	Type
id	string

Returns

ImageElement

Inherited from

TrackElement.setId

Defined in

core/elements/base.element.ts:86

---

setType

▸ setType(type): ImageElement

Parameters

Name	Type
type	string

Returns

ImageElement

Inherited from

TrackElement.setType

Defined in

core/elements/base.element.ts:91

---

setStart

▸ setStart(s): ImageElement

Parameters

Name	Type
s	number

Returns

ImageElement

Inherited from

TrackElement.setStart

Defined in

core/elements/base.element.ts:96

---

setEnd

▸ setEnd(e): ImageElement

Parameters

Name	Type
e	number

Returns

ImageElement

Inherited from

TrackElement.setEnd

Defined in

core/elements/base.element.ts:101

---

setTrackId

▸ setTrackId(trackId): ImageElement

Parameters

Name	Type
trackId	string

Returns

ImageElement

Inherited from

TrackElement.setTrackId

Defined in

core/elements/base.element.ts:106

---

setName

▸ setName(name): ImageElement

Parameters

Name	Type
name	string

Returns

ImageElement

Inherited from

TrackElement.setName

Defined in

core/elements/base.element.ts:111

---

setAnimation

▸ setAnimation(animation?): ImageElement

Parameters

Name	Type
animation?	ElementAnimation

Returns

ImageElement

Inherited from

TrackElement.setAnimation

Defined in

core/elements/base.element.ts:116

---

setOpacity

▸ setOpacity(opacity): ImageElement

Parameters

Name	Type
opacity	number

Returns

ImageElement

Inherited from

TrackElement.setOpacity

Defined in

core/elements/base.element.ts:132

---

setMetadata

▸ setMetadata(metadata?): ImageElement

Parameters

Name	Type
metadata?	ElementMetadata

Returns

ImageElement

Inherited from

TrackElement.setMetadata

Defined in

core/elements/base.element.ts:142

---

getTransition

▸ getTransition(): undefined | ElementTransitionJSON

Returns

undefined | ElementTransitionJSON

Inherited from

TrackElement.getTransition

Defined in

core/elements/base.element.ts:147

---

setTransition

▸ setTransition(transition): this

Parameters

Name	Type
transition	undefined | ElementTransitionJSON

Returns

this

Inherited from

TrackElement.setTransition

Defined in

core/elements/base.element.ts:151

---

getParentSize

▸ getParentSize(): Size

Returns

Size

Defined in

core/elements/image.element.ts:31

---

getFrame

▸ getFrame(): Frame

Returns

Frame

Defined in

core/elements/image.element.ts:35

---

getFrameEffects

▸ getFrameEffects(): undefined | ElementFrameEffect[]

Returns

undefined | ElementFrameEffect[]

Defined in

core/elements/image.element.ts:39

---

getBackgroundColor

▸ getBackgroundColor(): string

Returns

string

Defined in

core/elements/image.element.ts:43

---

getObjectFit

▸ getObjectFit(): ObjectFit

Returns

ObjectFit

Defined in

core/elements/image.element.ts:47

---

getSrc

▸ getSrc(): string

Returns

string

Defined in

core/elements/image.element.ts:51

---

getRotation

▸ getRotation(): number

Returns

number

Overrides

TrackElement.getRotation

Defined in

core/elements/image.element.ts:55

---

setRotation

▸ setRotation(rotation): ImageElement

Parameters

Name	Type
rotation	number

Returns

ImageElement

Overrides

TrackElement.setRotation

Defined in

core/elements/image.element.ts:59

---

getPosition

▸ getPosition(): Position

Returns

Position

Overrides

TrackElement.getPosition

Defined in

core/elements/image.element.ts:64

---

updateImageMeta

▸ updateImageMeta(updateFrame?): Promise<void>

Parameters

Name	Type	Default value
updateFrame	boolean	true

Returns

Promise<void>

Defined in

core/elements/image.element.ts:71

---

setPosition

▸ setPosition(position): ImageElement

Parameters

Name	Type
position	Position

Returns

ImageElement

Overrides

TrackElement.setPosition

Defined in

core/elements/image.element.ts:86

---

setSrc

▸ setSrc(src): Promise<ImageElement>

Parameters

Name	Type
src	string

Returns

Promise<ImageElement>

Defined in

core/elements/image.element.ts:92

---

setObjectFit

▸ setObjectFit(objectFit): ImageElement

Parameters

Name	Type
objectFit	ObjectFit

Returns

ImageElement

Defined in

core/elements/image.element.ts:98

---

setFrame

▸ setFrame(frame): ImageElement

Parameters

Name	Type
frame	Frame

Returns

ImageElement

Defined in

core/elements/image.element.ts:103

---

setParentSize

▸ setParentSize(parentSize): ImageElement

Parameters

Name	Type
parentSize	Size

Returns

ImageElement

Defined in

core/elements/image.element.ts:109

---

setMediaFilter

▸ setMediaFilter(mediaFilter): ImageElement

Parameters

Name	Type
mediaFilter	string

Returns

ImageElement

Defined in

core/elements/image.element.ts:114

---

setBackgroundColor

▸ setBackgroundColor(backgroundColor): ImageElement

Parameters

Name	Type
backgroundColor	string

Returns

ImageElement

Defined in

core/elements/image.element.ts:119

---

setProps

▸ setProps(props): ImageElement

Parameters

Name	Type
props	Omit<any, "src">

Returns

ImageElement

Overrides

TrackElement.setProps

Defined in

core/elements/image.element.ts:124

---

setFrameEffects

▸ setFrameEffects(frameEffects?): ImageElement

Parameters

Name	Type
frameEffects?	ElementFrameEffect[]

Returns

ImageElement

Defined in

core/elements/image.element.ts:129

---

addFrameEffect

▸ addFrameEffect(frameEffect): ImageElement

Parameters

Name	Type
frameEffect	ElementFrameEffect

Returns

ImageElement

Defined in

core/elements/image.element.ts:134

---

accept

▸ accept<T>(visitor): T

Type parameters

Name
T

Parameters

Name	Type
visitor	ElementVisitor<T>

Returns

T

Overrides

TrackElement.accept

Defined in

core/elements/image.element.ts:139

Properties

frameEffects

• Optional frameEffects: ElementFrameEffect[]

Defined in

core/elements/image.element.ts:12

---

frame

• frame: Frame

Defined in

core/elements/image.element.ts:13