Performance API
The PerformanceMark() constructor creates a DOMHighResTimeStamp with the given name.
Unlike Performance.mark, performance marks created by the constructor aren't added to the browser's performance timeline. This means that calls to the Performance interface's getEntries*() methods (Performance.getEntries, Performance.getEntriesByName or Performance.getEntriesByType) won't show entries for these marks.
Syntax
new PerformanceMark(name)
new PerformanceMark(name, markOptions)
Parameters
name- : A string representing the name of the mark.
markOptions- : An object for specifying a timestamp and additional metadata for the mark.
detail- : Arbitrary metadata to include in the mark. Defaults to
null.devtools- : Some browsers have use a structured
devtoolsobject within thedetailobject as part of an Extensibility API that surfaces these in custom tracks in performance traces. See the Chrome's Extensibility API documentation for more information.dataType- : A string which must be set to
marker. Identifies as a marker.
- : A string which must be set to
color- : Defaults to
"primary". Must be one of"primary","primary-light","primary-dark","secondary","secondary-light","secondary-dark","tertiary","tertiary-light","tertiary-dark","error".
- : Defaults to
properties- : Array of key-value pairs. Values can be any JSON-compatible type.
tooltipText- : Short description for tooltip.
- : Some browsers have use a structured
- : Arbitrary metadata to include in the mark. Defaults to
startTime- : DOMHighResTimeStamp to use as the mark time. Defaults to performance.now().
- : An object for specifying a timestamp and additional metadata for the mark.
Return value
A PerformanceMark object.
Exceptions
- SyntaxError: Thrown if the
namegiven to this method already exists in the PerformanceTiming interface. - TypeError: Thrown if
startTimeis negative.
Examples
Creating named markers
The following example shows how PerformanceMark entries are constructed and then aren't part of the browser's performance timeline.
new PerformanceMark("squirrel");
new PerformanceMark("monkey");
new PerformanceMark("dog");
const allEntries = performance.getEntriesByType("mark");
console.log(allEntries.length);
// 0
DevTools Extensibility API
For browsers that support the Extensibility API you can use the detail parameter to provide more details in a devtools object that will be used to display this in performance profiles:
// Marker indicating when the processed image was uploaded
performance.mark("Image Upload", {
detail: {
devtools: {
dataType: "marker",
color: "secondary",
properties: [
["Image Size", "2.5MB"],
["Upload Destination", "Cloud Storage"],
],
tooltipText: "Processed image uploaded",
},
},
});
Specifications
Browser compatibility
See also
- Performance.mark
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
