PerformanceMark: PerformanceMark() コンストラクター
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2022年5月以降、すべてのブラウザーで利用可能です。
PerformanceMark() コンストラクターは、指定された名前のタイムスタンプを作成します。
performance.mark() とは異なり、コンストラクターが作成するパフォーマンスマークはブラウザーのパフォーマンスタイムラインに追加されません。つまり、Performance インターフェイスの getEntries*() メソッド(getEntries()、getEntriesByName()、getEntriesByType())を呼び出しても、これらのマークの項目は表示されません。
構文
js
new PerformanceMark(name)
new PerformanceMark(name, markOptions)
引数
name-
文字列で、マークの名前を表します。
markOptions省略可-
オブジェクトで、タイムスタンプとマークの追加メタデータを指定します。
detail省略可-
マークに記載する任意のメタデータ。既定値は
nullです。 startTime省略可-
DOMHighResTimeStampで、マークの時刻として使用されます。既定値はperformance.now()です。
返値
PerformanceMark オブジェクトです。
例外
SyntaxError: Thrown このメソッドに指定されたnameが、PerformanceTimingインターフェイスにすでに存在する場合に発生します。TypeError:startTimeが負の数の場合に発生します。
例外
次の例は、パフォーマンス項目がどのように構成され、ブラウザーのパフォーマンスタイムラインの一部にならないことを示しています。
js
new PerformanceMark("squirrel");
new PerformanceMark("monkey");
new PerformanceMark("dog");
const allEntries = performance.getEntriesByType("mark");
console.log(allEntries.length);
// 0
仕様書
| 仕様書 |
|---|
| User Timing> # dom-performancemark-constructor> |