Interface ProgressEvent

A single progress report during a model load.

When total is present the phase is determinate and a real progress bar can be rendered; when absent only activity (a heartbeat) is being reported.

interface ProgressEvent {
    completed: number;
    elapsedMs: number;
    memoryMb?: number;
    phase: ProgressPhase;
    total?: number;
    unit: ProgressUnit;
}

Properties

completed elapsedMs memoryMb? phase total? unit

Properties

Readonlycompleted

completed: number

Units completed so far in this phase (monotonic within the phase).

ReadonlyelapsedMs

elapsedMs: number

Milliseconds since the tracker (i.e. the load) started.

Optional ReadonlymemoryMb

memoryMb?: number

Coarse used-JS-heap sample in MB, when the environment exposes one.

Readonlyphase

phase: ProgressPhase

Optional Readonlytotal

total?: number

Units total for this phase, when cheaply knowable up front.

Readonlyunit

unit: ProgressUnit

Settings

Member Visibility

On This Page

Properties