DocumentTimeline: DocumentTimeline() constructor
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2020.
The DocumentTimeline() constructor of the Web Animations API creates a new instance of the DocumentTimeline object associated with the active document of the current browsing context.
Syntax
new DocumentTimeline(options)
Parameters
optionsOptional-
An object specifying options for the new timeline. The following properties are available:
originTimeOptional-
A
numberthat specifies the zero time for theDocumentTimelineas a number of milliseconds relative toPerformance.timeOrigin. Defaults to0.
Examples
Origin time
A DocumentTimeline with an originTime of zero counts time
starting from Performance.timeOrigin. This is the same behavior
as Document.timeline.
const timeline = new DocumentTimeline();
console.log(timeline.currentTime === document.timeline.currentTime); // true
Setting a non-zero originTime will offset the DocumentTimeline
from Document.timeline by that amount:
const offsetTimeline = new DocumentTimeline({ originTime: 500 });
console.log(document.timeline.currentTime - offsetTimeline.currentTime); // 500
A DocumentTimeline relative to the current moment can be constructed with:
const nowTimeline = new DocumentTimeline({
originTime: document.timeline.currentTime,
});
console.log(nowTimeline.currentTime); // 0
Specifications
| Specification |
|---|
| Web Animations # dom-documenttimeline-documenttimeline |