Interface ResolvedTimelineObjectInstance<TContent>

Type Parameters

Hierarchy

Properties

children? classes? content disabled? enable id instance isGroup? keyframes? layer priority? resolved seamless?

Properties

Optional children

children?: TimelineObject<Content>[]

Children object of the group. If provided, also set .isGroup property to true.

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

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: TimelineEnable | TimelineEnable[]

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

id

id: string

ID of the object. Must be unique!

instance

instance: TimelineObjectInstance

Optional isGroup

isGroup?: boolean

Optional keyframes

keyframes?: TimelineKeyframe<Partial<TContent>>[]

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 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 which started playing last wins. Otherwise, the one with the highest priority wins (ie 9 wins over 0). Defaults to 0

resolved

resolved: {
    directReferences: Reference[];
    firstResolved: boolean;
    instances: TimelineObjectInstance[];
    isKeyframe: boolean;
    isSelfReferencing: boolean;
    levelDeep: number;
    parentId: undefined | string;
    resolvedConflicts: boolean;
    resolvedReferences: boolean;
    resolving: boolean;
}

Type declaration

  • directReferences: Reference[]

    Ids of all other objects that directly affects this object (ie through direct reference, classes, etc)

  • firstResolved: boolean

    Is set to true when object is resolved first time, and isn't reset thereafter

  • instances: TimelineObjectInstance[]

    Instances of the object on the timeline

  • isKeyframe: boolean

    True if object is a keyframe

  • isSelfReferencing: boolean

    True if object is referencing itself (only directly, not indirectly via another object)

  • levelDeep: number

    A number that increases the more levels inside of a group the objects is. 0 = no parent

  • parentId: undefined | string

    Id of the parent object (for children in groups or keyframes)

  • resolvedConflicts: boolean

    Is set to true when object's conflicts has been resolved

  • resolvedReferences: boolean

    Is set to true when object's references has been resolved

  • resolving: boolean

    Is set to true while object is being resolved (to prevent circular references)

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

On This Page

Generated using TypeDoc