webchalk-animate - v0.31.0
    Preparing search index...

    Interface AnimSequenceConfig

    An object containing configuration options used to define the timing and details of the animation sequence.

    interface AnimSequenceConfig {
        autoplays: boolean;
        autoplaysNextSequence: boolean;
        description: string;
        jumpTag: string;
        playbackRate: number;
    }
    Index

    Properties

    autoplays autoplaysNextSequence description jumpTag playbackRate

    Properties

    autoplays: boolean

    If true, this sequence will automatically play after the previous sequence in the same timeline finishes.

    • If this sequence is not part of a timeline or is at the beginning of a timeline, this option has no effect.
    false
    autoplaysNextSequence: boolean

    If true, the next sequence in the same timeline will automatically play after this sequence finishes.

    • If this sequence is not part of a timeline or is at the end of a timeline, this option has no effect.
    false
    description: string

    A string that is logged when debugging mode is enabled.

    '<blank sequence description>'
    jumpTag: string

    A string that can be used to identify the sequence as a jump point (like a bookmark in a document). Pass it as an argument to AnimTimeline.jumpToSequenceTag to jump to the sequence.

    ''
    playbackRate: number

    The base playback rate of the sequence (ignoring any multipliers from a parent timeline).

    • Example: A value of 1 means 100% (the typical playback rate), and 0.5 means 50% speed.
    • Example: If the playbackRate of the parent timeline is 4 and the playbackRate of this sequence is 5, the playbackRate property is still 5, but the sequence would run at 4 * 5 = 20x speed.

    Settings

    Member Visibility

    On This Page

    Properties