aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/performanceobserver/observe/index.html
blob: 9d56b7143741c0bb5ae9aee5470ce136e5ddb35c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
---
title: PerformanceObserver.observe()
slug: Web/API/PerformanceObserver/observe
tags:
  - API
  - PerformanceObserver
  - Web パフォーマンス
  - パフォーマンス
  - メソッド
  - リファレンス
translation_of: Web/API/PerformanceObserver/observe
---
<div>{{APIRef("Performance Timeline API")}}</div>

<p><span class="seoSummary">監視するパフォーマンスエントリタイプのセットを指定するには、<strong>{{domxref("PerformanceObserver")}}</strong> インターフェイスの<strong><code>observe()</code></strong> メソッドを使用します。</span>パフォーマンスエントリタイプは {{domxref("DOMString")}} オブジェクトの配列として指定され、それぞれが1つのエントリタイプを命名します。型名は{{SectionOnPage("/ja/docs/Web/API/PerformanceEntry/entryType", "パフォーマンスエントリタイプ名")}}に記載されています。</p>

<p>一致するパフォーマンスエントリが記録されると、パフォーマンスオブザーバーのコールバック関数 ({{domxref("PerformanceObserver")}}) の作成時に設定されたコールバック関数が呼び出されます。</p>

<h2 id="構文">構文</h2>

<pre class="syntaxbox"><em>observer</em>.observe(<em>options</em>);
</pre>

<h3 id="パラメータ">パラメータ</h3>

<dl>
 <dt><code>options</code></dt>
 <dd>1つのメンバを持つ <code>PerformanceObserverInit</code> ディクショナリ
 <ul>
  <li>"<code>entryTypes</code>" は {{domxref("DOMString")}} オブジェクトの配列で、それぞれが監視対象のパフォーマンスエントリの種類を1つ指定します。有効な型名のリストについては {{domxref("PerformanceEntry.entryType")}} を参照してください。認識されない型は無視されますが、ブラウザは開発者がコードをデバッグするのに役立つ警告メッセージをコンソールに出力するかもしれません。有効な型が見つからない場合、<code>observe()</code> は効果がありません。</li>
 </ul>
 </dd>
</dl>

<h2 id="例"></h2>

<p>この例では、2つの <code>PerformanceObservers</code> を作成して設定します。1つは<code>"mark"</code><code>"frame"</code> イベントを監視し、もう1つは <code>"measure"</code> イベントを監視します。</p>

<pre class="brush: js">var observer = new PerformanceObserver(function(list, obj) {
  var entries = list.getEntries();
  for (var i=0; i &lt; entries.length; i++) {
    // Process "mark" and "frame" events
  }
});
observer.observe({entryTypes: ["mark", "frame"]});

function perf_observer(list, observer) {
  // Process the "measure" event
}
var observer2 = new PerformanceObserver(perf_observer);
observer2.observe({entryTypes: ["measure"]});
</pre>

<h2 id="仕様">仕様</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">仕様書</th>
   <th scope="col">ステータス</th>
   <th scope="col">コメント</th>
  </tr>
  <tr>
   <td>{{SpecName('Performance Timeline Level 2', '#dom-performanceobserver-observe', 'observe()')}}</td>
   <td>{{Spec2('Performance Timeline Level 2')}}</td>
   <td><code>observe()</code> メソッドの初期定義</td>
  </tr>
 </tbody>
</table>

<h2 id="ブラウザの互換性">ブラウザの互換性</h2>

<div>
<p>{{Compat("api.PerformanceObserver.observe")}}</p>
</div>