Interface TSRTimelineObj<TContent>

Type Parameters

  • TContent extends {
        deviceType: DeviceType;
    }

Hierarchy

Properties

children? classes? content disabled? enable id isGroup? isLookahead? keyframes? layer lookaheadForLayer? priority? seamless?

Properties

Optional children

children?: TSRTimelineObj<TSRTimelineContent>[]

Optional classes

classes?: string[]

A list of classes on this Timeline-object. classes can be referenced by other objects using the syntax: ".className"

content

content: TContent & TimelineDatastoreReferencesContent

The payload of the timeline-object. Can be anything you want.

Optional disabled

disabled?: boolean

If set to true, the object will be excluded when resolving the timeline.

enable

enable: Timeline.TimelineEnable | Timeline.TimelineEnable[]

Expression (or array of expressions) defining when the Timeline-object will play

id

id: string

ID of the object. Must be unique!

Optional isGroup

isGroup?: boolean

Optional isLookahead

isLookahead?: boolean

Only set to true when an object is inserted by lookahead

Optional keyframes

keyframes?: Timeline.TimelineKeyframe<Partial<TContent & TimelineDatastoreReferencesContent>>[]

Keyframes can be used to modify the content of an object. When a keyframe is active, the content of the keyframe will be merged into the parent object.

layer

layer: string | number

The layer where the object is played. If set to undefined, "" or null, the object is treated as "transparent", ie it won't collide with other objects, nor be present in the resolved state.

Optional lookaheadForLayer

lookaheadForLayer?: string | number

Only valid when isLookahead is true. Set so that a lookahead object knows what layer it belongs to

Optional priority

priority?: number

Priority. Affects which object "wins" when there are two colliding objects on the same layer. If the two colliding objects have the same priority, the one who started playing last wins. Otherwise, the one with the highest priority wins (ie 9 wins over 0). Defaults to 0

Optional seamless

seamless?: boolean

If set to true, colliding timeline-instances will be merged into a single one. This could be useful if want the instance.start times to not be reset unexpectedly.

Settings

Member Visibility

Theme

Generated using TypeDoc