PerformanceScrollTiming Class
- Experimental (WEBPLATEXP0022)
A scroll of the user (https://github.com/MicrosoftEdge/MSEdgeExplainers/blob/main/PerformanceScrollTiming/explainer.md): the frames that displayed a scroll of a scrolling box by the wheel, the keys, a touch or a scrollbar, from its first input to its end (its scrollend event), reported to the scroll performance observers of its window.
[Experimental("WEBPLATEXP0022", UrlFormat = "https://github.com/meziantou/Meziantou.Framework/blob/main/src/Meziantou.Framework.WebPlatform/docs/experimental-apis.md#{0}")]
public sealed class PerformanceScrollTiming : PerformanceEntryRemarks
The entries are measured on the clock of the event loop: the frames are its rendering updates.
See also
- Inheritance
PerformanceEntryPerformanceScrollTiming
Properties
| Name | Description |
|---|---|
| CheckerboardTime | Gets 0: the contents are painted with the frames (there is no checkerboarding). |
| DeltaX | Gets the horizontal distance of the scroll, in CSS pixels (positive to the right). |
| DeltaY | Gets the vertical distance of the scroll, in CSS pixels (positive downwards). |
| Duration | Gets the time from the start of the scroll to its last change of the scroll position (including the animation of a smooth scroll and the snap of its end). |
| EntryType | Gets scroll. |
| FirstFrameTime | Gets the time of the first frame (rendering update) that displayed the scroll. |
| FramesExpected | Gets the number of frames at 60 Hz during the scroll (ceil(duration / 16.67)), at least the number of frames produced (an instant scroll has no duration but is displayed by a frame). |
| FramesProduced | Gets the number of frames (rendering updates) whose scroll position differed from the one of the previous frame. |
| Name | Gets scroll. |
| ScrollSource | Gets the input of the scroll: wheel, keyboard, touch, or other (a scrollbar). |
| StartTime | Gets the time of the first input of the scroll, in milliseconds relative to the time origin of the window. |
| Target | Gets the scrolled node: the scroll container, or the document for the viewport. It is null when the node is not connected anymore or is in a shadow tree. |
CheckerboardTime
ScrollTiming.csGets 0: the contents are painted with the frames (there is no checkerboarding).
public double CheckerboardTime { get; }DeltaX
ScrollTiming.csGets the horizontal distance of the scroll, in CSS pixels (positive to the right).
public int DeltaX { get; }DeltaY
ScrollTiming.csGets the vertical distance of the scroll, in CSS pixels (positive downwards).
public int DeltaY { get; }Duration
ScrollTiming.csGets the time from the start of the scroll to its last change of the scroll position (including the animation of a smooth scroll and the snap of its end).
public new double Duration { get; }EntryType
ScrollTiming.csGets scroll.
public new string EntryType { get; }FirstFrameTime
ScrollTiming.csGets the time of the first frame (rendering update) that displayed the scroll.
public double FirstFrameTime { get; }FramesExpected
ScrollTiming.csGets the number of frames at 60 Hz during the scroll (ceil(duration / 16.67)), at least the number of frames produced (an instant scroll has no duration but is displayed by a frame).
public uint FramesExpected { get; }FramesProduced
ScrollTiming.csGets the number of frames (rendering updates) whose scroll position differed from the one of the previous frame.
public uint FramesProduced { get; }Name
ScrollTiming.csGets scroll.
public new string Name { get; }ScrollSource
ScrollTiming.csGets the input of the scroll: wheel, keyboard, touch, or other (a scrollbar).
public string ScrollSource { get; }StartTime
ScrollTiming.csGets the time of the first input of the scroll, in milliseconds relative to the time origin of the window.
public new double StartTime { get; }Target
ScrollTiming.csGets the scrolled node: the scroll container, or the document for the viewport. It is null when the node is not connected anymore or is in a shadow tree.
public Node? Target { get; }