@twick/timeline / Exports / ImageElement

Class: ImageElement

Hierarchy

• TrackElement

  ↳ ImageElement

Table of contents

Constructors

• constructor

Properties

• animation
• backgroundColor
• e
• frame
• frameEffects
• id
• name
• objectFit
• parentSize
• props
• s
• trackId
• type

Methods

• accept
• addFrameEffect
• getAnimation
• getBackgroundColor
• getDuration
• getEnd
• getFrame
• getFrameEffects
• getId
• getName
• getObjectFit
• getParentSize
• getPosition
• getProps
• getStart
• getTrackId
• getType
• setAnimation
• setBackgroundColor
• setEnd
• setFrame
• setFrameEffects
• setId
• setMediaFilter
• setName
• setObjectFit
• setParentSize
• setPosition
• setProps
• setSrc
• setStart
• setTrackId
• setType
• updateImageMeta

Constructors

constructor

• new ImageElement(src, parentSize): ImageElement

Parameters

Name	Type
src	string
parentSize	Size

Returns

ImageElement

Overrides

TrackElement.constructor

Defined in

packages/timeline/src/core/elements/image.element.ts:16

Properties

animation

• Protected Optional animation: ElementAnimation

Inherited from

TrackElement.animation

Defined in

packages/timeline/src/core/elements/base.element.ts:13

---

backgroundColor

• Protected backgroundColor: string

Defined in

packages/timeline/src/core/elements/image.element.ts:9

---

e

• Protected e: number

Inherited from

TrackElement.e

Defined in

packages/timeline/src/core/elements/base.element.ts:10

---

frame

• frame: Frame

Defined in

packages/timeline/src/core/elements/image.element.ts:13

---

frameEffects

• Optional frameEffects: ElementFrameEffect[]

Defined in

packages/timeline/src/core/elements/image.element.ts:12

---

id

• Protected id: string

Inherited from

TrackElement.id

Defined in

packages/timeline/src/core/elements/base.element.ts:7

---

name

• Protected name: string

Inherited from

TrackElement.name

Defined in

packages/timeline/src/core/elements/base.element.ts:12

---

objectFit

• Protected objectFit: ObjectFit

Defined in

packages/timeline/src/core/elements/image.element.ts:11

---

parentSize

• Protected parentSize: Size

Defined in

packages/timeline/src/core/elements/image.element.ts:10

---

props

• Protected props: ImageProps

Overrides

TrackElement.props

Defined in

packages/timeline/src/core/elements/image.element.ts:14

---

s

• Protected s: number

Inherited from

TrackElement.s

Defined in

packages/timeline/src/core/elements/base.element.ts:9

---

trackId

• Protected trackId: string

Inherited from

TrackElement.trackId

Defined in

packages/timeline/src/core/elements/base.element.ts:11

---

type

• Protected type: string

Inherited from

TrackElement.type

Defined in

packages/timeline/src/core/elements/base.element.ts:8

Methods

accept

▸ accept<T>(visitor): T

Type parameters

Name
T

Parameters

Name	Type
visitor	ElementVisitor<T>

Returns

T

Overrides

TrackElement.accept

Defined in

packages/timeline/src/core/elements/image.element.ts:126

---

addFrameEffect

▸ addFrameEffect(frameEffect): ImageElement

Parameters

Name	Type
frameEffect	ElementFrameEffect

Returns

ImageElement

Defined in

packages/timeline/src/core/elements/image.element.ts:121

---

getAnimation

▸ getAnimation(): undefined | ElementAnimation

Returns

undefined | ElementAnimation

Inherited from

TrackElement.getAnimation

Defined in

packages/timeline/src/core/elements/base.element.ts:59

---

getBackgroundColor

▸ getBackgroundColor(): string

Returns

string

Defined in

packages/timeline/src/core/elements/image.element.ts:43

---

getDuration

▸ getDuration(): number

Returns

number

Inherited from

TrackElement.getDuration

Defined in

packages/timeline/src/core/elements/base.element.ts:43

---

getEnd

▸ getEnd(): number

Returns

number

Inherited from

TrackElement.getEnd

Defined in

packages/timeline/src/core/elements/base.element.ts:39

---

getFrame

▸ getFrame(): Frame

Returns

Frame

Defined in

packages/timeline/src/core/elements/image.element.ts:35

---

getFrameEffects

▸ getFrameEffects(): undefined | ElementFrameEffect[]

Returns

undefined | ElementFrameEffect[]

Defined in

packages/timeline/src/core/elements/image.element.ts:39

---

getId

▸ getId(): string

Returns

string

Inherited from

TrackElement.getId

Defined in

packages/timeline/src/core/elements/base.element.ts:27

---

getName

▸ getName(): string

Returns

string

Inherited from

TrackElement.getName

Defined in

packages/timeline/src/core/elements/base.element.ts:55

---

getObjectFit

▸ getObjectFit(): ObjectFit

Returns

ObjectFit

Defined in

packages/timeline/src/core/elements/image.element.ts:47

---

getParentSize

▸ getParentSize(): Size

Returns

Size

Defined in

packages/timeline/src/core/elements/image.element.ts:31

---

getPosition

▸ getPosition(): Position

Returns

Position

Overrides

TrackElement.getPosition

Defined in

packages/timeline/src/core/elements/image.element.ts:51

---

getProps

▸ getProps(): Record<string, any>

Returns

Record<string, any>

Inherited from

TrackElement.getProps

Defined in

packages/timeline/src/core/elements/base.element.ts:51

---

getStart

▸ getStart(): number

Returns

number

Inherited from

TrackElement.getStart

Defined in

packages/timeline/src/core/elements/base.element.ts:35

---

getTrackId

▸ getTrackId(): string

Returns

string

Inherited from

TrackElement.getTrackId

Defined in

packages/timeline/src/core/elements/base.element.ts:47

---

getType

▸ getType(): string

Returns

string

Inherited from

TrackElement.getType

Defined in

packages/timeline/src/core/elements/base.element.ts:31

---

setAnimation

▸ setAnimation(animation?): ImageElement

Parameters

Name	Type
animation?	ElementAnimation

Returns

ImageElement

Inherited from

TrackElement.setAnimation

Defined in

packages/timeline/src/core/elements/base.element.ts:100

---

setBackgroundColor

▸ setBackgroundColor(backgroundColor): ImageElement

Parameters

Name	Type
backgroundColor	string

Returns

ImageElement

Defined in

packages/timeline/src/core/elements/image.element.ts:106

---

setEnd

▸ setEnd(e): ImageElement

Parameters

Name	Type
e	number

Returns

ImageElement

Inherited from

TrackElement.setEnd

Defined in

packages/timeline/src/core/elements/base.element.ts:85

---

setFrame

▸ setFrame(frame): ImageElement

Parameters

Name	Type
frame	Frame

Returns

ImageElement

Defined in

packages/timeline/src/core/elements/image.element.ts:90

---

setFrameEffects

▸ setFrameEffects(frameEffects?): ImageElement

Parameters

Name	Type
frameEffects?	ElementFrameEffect[]

Returns

ImageElement

Defined in

packages/timeline/src/core/elements/image.element.ts:116

---

setId

▸ setId(id): ImageElement

Parameters

Name	Type
id	string

Returns

ImageElement

Inherited from

TrackElement.setId

Defined in

packages/timeline/src/core/elements/base.element.ts:70

---

setMediaFilter

▸ setMediaFilter(mediaFilter): ImageElement

Parameters

Name	Type
mediaFilter	string

Returns

ImageElement

Defined in

packages/timeline/src/core/elements/image.element.ts:101

---

setName

▸ setName(name): ImageElement

Parameters

Name	Type
name	string

Returns

ImageElement

Inherited from

TrackElement.setName

Defined in

packages/timeline/src/core/elements/base.element.ts:95

---

setObjectFit

▸ setObjectFit(objectFit): ImageElement

Parameters

Name	Type
objectFit	ObjectFit

Returns

ImageElement

Defined in

packages/timeline/src/core/elements/image.element.ts:85

---

setParentSize

▸ setParentSize(parentSize): ImageElement

Parameters

Name	Type
parentSize	Size

Returns

ImageElement

Defined in

packages/timeline/src/core/elements/image.element.ts:96

---

setPosition

▸ setPosition(position): ImageElement

Parameters

Name	Type
position	Position

Returns

ImageElement

Overrides

TrackElement.setPosition

Defined in

packages/timeline/src/core/elements/image.element.ts:73

---

setProps

▸ setProps(props): ImageElement

Parameters

Name	Type
props	Omit<any, "src">

Returns

ImageElement

Overrides

TrackElement.setProps

Defined in

packages/timeline/src/core/elements/image.element.ts:111

---

setSrc

▸ setSrc(src): Promise<ImageElement>

Parameters

Name	Type
src	string

Returns

Promise<ImageElement>

Defined in

packages/timeline/src/core/elements/image.element.ts:79

---

setStart

▸ setStart(s): ImageElement

Parameters

Name	Type
s	number

Returns

ImageElement

Inherited from

TrackElement.setStart

Defined in

packages/timeline/src/core/elements/base.element.ts:80

---

setTrackId

▸ setTrackId(trackId): ImageElement

Parameters

Name	Type
trackId	string

Returns

ImageElement

Inherited from

TrackElement.setTrackId

Defined in

packages/timeline/src/core/elements/base.element.ts:90

---

setType

▸ setType(type): ImageElement

Parameters

Name	Type
type	string

Returns

ImageElement

Inherited from

TrackElement.setType

Defined in

packages/timeline/src/core/elements/base.element.ts:75

---

updateImageMeta

▸ updateImageMeta(updateFrame?): Promise<void>

Parameters

Name	Type	Default value
updateFrame	boolean	true

Returns

Promise<void>

Defined in

packages/timeline/src/core/elements/image.element.ts:58