@twick/timeline / Exports / CaptionElement

Class: CaptionElement

Hierarchy

• TrackElement

  ↳ CaptionElement

Table of contents

Constructors

• constructor

Properties

• animation
• e
• id
• name
• props
• s
• t
• trackId
• type

Methods

• accept
• getAnimation
• getDuration
• getEnd
• getId
• getName
• getPosition
• getProps
• getStart
• getText
• getTrackId
• getType
• setAnimation
• setEnd
• setId
• setName
• setPosition
• setProps
• setStart
• setText
• setTrackId
• setType

Constructors

constructor

• new CaptionElement(t, start, end): CaptionElement

Parameters

Name	Type
t	string
start	number
end	number

Returns

CaptionElement

Overrides

TrackElement.constructor

Defined in

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

Properties

animation

• Protected Optional animation: ElementAnimation

Inherited from

TrackElement.animation

Defined in

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

---

e

• Protected e: number

Inherited from

TrackElement.e

Defined in

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

---

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

---

props

• Protected props: Record<string, any>

Inherited from

TrackElement.props

Defined in

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

---

s

• Protected s: number

Inherited from

TrackElement.s

Defined in

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

---

t

• Protected t: string

Defined in

packages/timeline/src/core/elements/caption.element.ts:6

---

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/caption.element.ts:24

---

getAnimation

▸ getAnimation(): undefined | ElementAnimation

Returns

undefined | ElementAnimation

Inherited from

TrackElement.getAnimation

Defined in

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

---

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

---

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

---

getPosition

▸ getPosition(): Position

Returns

Position

Inherited from

TrackElement.getPosition

Defined in

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

---

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

---

getText

▸ getText(): string

Returns

string

Defined in

packages/timeline/src/core/elements/caption.element.ts:15

---

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?): CaptionElement

Parameters

Name	Type
animation?	ElementAnimation

Returns

CaptionElement

Inherited from

TrackElement.setAnimation

Defined in

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

---

setEnd

▸ setEnd(e): CaptionElement

Parameters

Name	Type
e	number

Returns

CaptionElement

Inherited from

TrackElement.setEnd

Defined in

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

---

setId

▸ setId(id): CaptionElement

Parameters

Name	Type
id	string

Returns

CaptionElement

Inherited from

TrackElement.setId

Defined in

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

---

setName

▸ setName(name): CaptionElement

Parameters

Name	Type
name	string

Returns

CaptionElement

Inherited from

TrackElement.setName

Defined in

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

---

setPosition

▸ setPosition(position): CaptionElement

Parameters

Name	Type
position	Position

Returns

CaptionElement

Inherited from

TrackElement.setPosition

Defined in

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

---

setProps

▸ setProps(props): CaptionElement

Parameters

Name	Type
props	Record<string, any>

Returns

CaptionElement

Inherited from

TrackElement.setProps

Defined in

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

---

setStart

▸ setStart(s): CaptionElement

Parameters

Name	Type
s	number

Returns

CaptionElement

Inherited from

TrackElement.setStart

Defined in

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

---

setText

▸ setText(t): CaptionElement

Parameters

Name	Type
t	string

Returns

CaptionElement

Defined in

packages/timeline/src/core/elements/caption.element.ts:19

---

setTrackId

▸ setTrackId(trackId): CaptionElement

Parameters

Name	Type
trackId	string

Returns

CaptionElement

Inherited from

TrackElement.setTrackId

Defined in

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

---

setType

▸ setType(type): CaptionElement

Parameters

Name	Type
type	string

Returns

CaptionElement

Inherited from

TrackElement.setType

Defined in

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