performance.mark()
mark()
メソッドは、ブラウザーのパフォーマンスエントリーバッファーに、指定された名前でtimestamp
を作成します。
アプリケーション定義のタイムスタンプは、Performance
インタフェースの getEntries*()
メソッド (getEntries()
、getEntriesByName()
またはgetEntriesByType()
) のいずれかによって取得できます。
mark()
は内部的にデータを PerformanceEntry
として格納します。
注: この機能は Web Worker 内で利用可能です
構文
performance.mark(name);
performance.mark(measureName, markOptions)
引数
- name
-
DOMString
で、マークの名前を表します。このメソッドで指定されたname
がすでにPerformanceTiming
インターフェイスに存在していた場合は、SyntaxError
が発生します。 markOptions
省略可-
このマークのためにタイムスタンプと追加のメタデータを指定するためのオブジェクトです。
detail
-
マークに含める任意のメタデータです。
startTime
-
マークの時刻として使用する
DOMHighResTimeStamp
です。
返値
- entry
-
生成された
PerformanceMark
エントリーです。
例
次の例は、mark()
を使用して PerformanceMark
エントリーを作成および取得する方法を示しています。
// たくさんの mark を作成します。
performance.mark("squirrel");
performance.mark("squirrel");
performance.mark("monkey");
performance.mark("monkey");
performance.mark("dog");
performance.mark("dog");
// PerformanceMark エントリーをすべて取得します。
const allEntries = performance.getEntriesByType("mark");
console.log(allEntries.length);
// 6
// "monkey" PerformanceMark エントリーをすべて入手します。
const monkeyEntries = performance.getEntriesByName("monkey");
console.log(monkeyEntries.length);
// 2
// すべての mark を消去します。
performance.clearMarks();
仕様書
Specification |
---|
User Timing # dom-performance-mark |
ブラウザーの互換性
BCD tables only load in the browser