Interface TemporalPlaybackOptionsExperimental

Options for createTemporalPlayback.

interface TemporalPlaybackOptions {
    apply?: ((window: TemporalWindow) => void | Promise<void>);
    baseQuery?: Readonly<Record<string, unknown>> & {
        where?: string;
    };
    extent: readonly [TemporalInstant, TemporalInstant];
    formatWhere?: ((window: TemporalWindow, timeField: string) => string);
    frameIntervalMs?: number;
    handle?: TemporalFilterHandle;
    layer?: {
        layerIds: readonly string[];
        map: TemporalFilterMap;
    };
    loop?: boolean;
    stepMs?: number;
    timeField?: string;
    windowMs: number;
}

Properties

apply? baseQuery? extent formatWhere? frameIntervalMs? handle? layer? loop? stepMs? timeField? windowMs

Properties

Optional Readonlyapply

apply?: ((window: TemporalWindow) => void | Promise<void>)

Custom sink; use instead of (or in addition to) handle/layer.

Optional Readonly ExperimentalbaseQuery

baseQuery?: Readonly<Record<string, unknown>> & {
    where?: string;
}

Extra query properties merged under the generated where (handle binding).

Readonly Experimentalextent

extent: readonly [TemporalInstant, TemporalInstant]

Full playable time extent as [start, end].

Optional ReadonlyformatWhere

formatWhere?: ((window: TemporalWindow, timeField: string) => string)

Override the generated where clause (handle binding). The default is <timeField> >= <startMs> AND <timeField> < <endMs>.

Optional Readonly ExperimentalframeIntervalMs

frameIntervalMs?: number

Wall-clock delay between frames.

Default

500

Optional Readonly Experimentalhandle

handle?: TemporalFilterHandle

Bridge binding: a MountedSource (or anything with a Query-shaped setFilter). Each window becomes a where clause on timeField.

Optional Readonly Experimentallayer

layer?: {
    layerIds: readonly string[];
    map: TemporalFilterMap;
}

MapLibre binding: client-side setFilter over already-materialized layers. Each window becomes a numeric range filter on timeField composed (all) with the layer's filter at bind time, so bridge geometry filters survive. Requires numeric (epoch ms) properties.

Optional Readonly Experimentalloop

loop?: boolean

Restart from the extent start after the last window.

Default

false

Optional Readonly ExperimentalstepMs

stepMs?: number

How far the window advances per frame.

Default

windowMs (non-overlapping windows)

Optional Readonly ExperimentaltimeField

timeField?: string

Feature property holding the feature's time. Required with handle/layer.

Readonly ExperimentalwindowMs

windowMs: number

Window length in milliseconds.

Settings

Member Visibility

On This Page

Properties