eligius
    Preparing search index...

    Interface IPositionSourceConfig

    Configuration for a position source.

    Position sources drive timeline position. They are resolved dynamically via the resource importer using the systemName property.

    Built-in position sources:

    • RafPositionSource: RAF-based, drives timeline by elapsed time
    • ScrollPositionSource: Scroll-based, drives timeline by scroll position
    • VideoPositionSource: Video.js-based, drives timeline by video playback
    // RAF-based position source
    const rafConfig: IPositionSourceConfig = {
      systemName: 'RafPositionSource',
      tickInterval: 1000,
    };

    // Scroll-based position source
    const scrollConfig: IPositionSourceConfig = {
      systemName: 'ScrollPositionSource',
      selector: '.scroll-container',
    };

    // Video-based position source
    const videoConfig: IPositionSourceConfig = {
      systemName: 'VideoPositionSource',
      selector: '#video-player',
      poster: '/poster.jpg',
    };
    interface IPositionSourceConfig {
        poster?: string;
        selector?: string;
        systemName: string;
        tickInterval?: number;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Additional configuration options passed to the position source constructor. Use this for custom position source implementations.

    Index

    Properties

    poster? selector? systemName tickInterval?

    Properties

    poster?: string

    Optional poster image URL (video sources).

    selector?: string

    CSS selector for sources that need a DOM element (scroll, video).

    systemName: string

    Name of the position source class to instantiate. Resolved via the resource importer.

    Built-in options: 'RafPositionSource', 'ScrollPositionSource', 'VideoPositionSource'

    tickInterval?: number

    Interval between position updates in milliseconds (RAF sources).

    1000

    Settings

    Member Visibility

    On This Page

    Properties