diff options
Diffstat (limited to 'files/fr/web/api/performanceobserverentrylist/getentries/index.html')
| -rw-r--r-- | files/fr/web/api/performanceobserverentrylist/getentries/index.html | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/files/fr/web/api/performanceobserverentrylist/getentries/index.html b/files/fr/web/api/performanceobserverentrylist/getentries/index.html new file mode 100644 index 0000000000..4d24a1550a --- /dev/null +++ b/files/fr/web/api/performanceobserverentrylist/getentries/index.html @@ -0,0 +1,115 @@ +--- +title: PerformanceObserverEntryList.getEntries() +slug: Web/API/PerformanceObserverEntryList/getEntries +tags: + - API + - Method + - Méthode + - PerformanceObserverEntryList + - Reference + - Performance Web +translation_of: Web/API/PerformanceObserverEntryList/getEntries +--- +<div>{{APIRef("Performance Timeline API")}}</div> + +<p class="summary">La méthode <strong><code>getEntries()</code></strong> de l'interface <a href="/fr/docs/Web/API/PerformanceObserverEntryList"><code>PerformanceObserverEntryList</code></a> retourne une liste d'objets explicitement <em>observés</em> d'<a href="/fr/docs/Web/API/PerformanceEntry">entrées de performance</a> pour un filtre donné. Les membres de la liste sont déterminés par l'ensemble des <a href="/fr/docs/Web/API/PerformanceEntry/entryType">types d'entrée</a> spécifiés dans l'appel à la méthode <a href="/fr/docs/Web/API/PerformanceObserver/observe"><code>observe()</code></a>. La liste est disponible dans la fonction de rappel de l'observateur (en tant que premier paramètre de la fonction de rappel).</p> + +<div class="notecard note"> + <p><strong>Remarque :</strong> Cette interface est exposée à <a href="/fr/docs/Web/API/Window"><code>Window</code></a> et <a href="/fr/docs/Web/API/Worker"><code>Worker</code></a>.</p> +</div> + +<h2 id="Syntax">Syntaxe</h2> + +<pre class="brush: js">let <var>entries</var> = list.getEntries(); +<var>entries</var> = list.getEntries(<var>PerformanceEntryFilterOptions</var>);</pre> + +<p>Utilisation spécifique :</p> + +<pre class="brush: js"><var>entries</var> = list.getEntries({name: "entry_name", entryType: "mark"});</pre> + +<h3 id="Parameters">Paramètres</h3> + +<dl> + <dt><code><em>PerformanceEntryFilterOptions</em></code> {{optional_inline}}</dt> + <dd>Est un dictionnaire <code>PerformanceEntryFilterOptions</code>, comportant les champs suivants : + <ul> + <li><code>"name"</code>, le nom d'une entrée de performance.</li> + <li><code>"entryType"</code>, le type d'entrée. Les types d'entrée valides sont énumérés dans la propriété <a href="/fr/docs/Web/API/PerformanceEntry/entryType"><code>PerformanceEntry.entryType</code></a>.</li> + <li><code>"initiatorType"</code>, le type de la ressource initiatrice (par exemple un élément HTML). Les valeurs sont définies par la propriété <a href="/fr/docs/Web/API/PerformanceResourceTiming/initiatorType"><code>PerformanceResourceTiming.initiatorType</code></a>.</li> + </ul> + Ce paramètre n'est actuellement pas pris en charge par Chrome ou Opera. + </dd> +</dl> + +<h3 id="Return_Value">Valeur de retour</h3> + +<p>Une liste d'objets <a href="/fr/docs/Web/API/PerformanceEntry"><code>PerformanceEntry</code></a> explicitement <em>observés</em> qui répondent aux critères du filtre. Les éléments seront dans l'ordre chronologique basé sur les <a href="/fr/docs/Web/API/PerformanceEntry/startTime"><code>startTime</code></a> des entrées. Si aucun objet répondant au filtre n'est trouvé, une liste vide est renvoyée. Si aucun argument n'est fourni, toutes les entrées sont renvoyées.</p> + +<h2 id="Example">Exemple</h2> + +<pre class="brush: js">function print_perf_entry(pe) { + console.log("name: " + pe.name + + "; entryType: " + pe.entryType + + "; startTime: " + pe.startTime + + "; duration: " + pe.duration); +} + +// Crée un observateur pour tous les types d'événements de performance +const observe_all = new PerformanceObserver(function(list, obs) { + let perfEntries; + + // Imprime toutes les entrées + perfEntries = list.getEntries(); + for (let i = 0; i < perfEntries.length; i++) { + print_perf_entry(perfEntries[i]); + } + + // Imprime les entrées nommées "Begin" avec le type "mark". + perfEntries = list.getEntriesByName("Begin", "mark"); + for (let i = 0; i < perfEntries.length; i++) { + print_perf_entry(perfEntries[i]); + } + + // Imprime les entrées de type "mark". + perfEntries = list.getEntriesByType("mark"); + for (let i = 0; i < perfEntries.length; i++) { + print_perf_entry(perfEntries[i]); + } +}); +// inscrire tous les types d'événements de performance +observe_all.observe({entryTypes: ['frame', 'mark', 'measure', 'navigation', 'resource', 'server']}); + +const observe_frame = new PerformanceObserver(function(list, obs) { + let perfEntries = list.getEntries(); + // Ne devrait avoir que des entrées "frame" + for (let i = 0; i < perfEntries.length; i++) { + print_perf_entry(perfEntries[i]); + } +}); +// inscrire à l'événement "frame" uniquement +observe_frame.observe({entryTypes: ['frame']}); +</pre> + +<h2 id="Specifications">Spécifications</h2> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">Spécification</th> + <th scope="col">Statut</th> + <th scope="col">Commentaire</th> + </tr> + </thead> + <tbody> + <tr> + <td>{{SpecName('Performance Timeline Level 2', + '#dom-performanceobserverentrylist-getentries', 'getEntries()')}}</td> + <td>{{Spec2('Performance Timeline Level 2')}}</td> + <td>Définition initiale.</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility">Compatibilité des navigateurs</h2> + +<p>{{Compat("api.PerformanceObserverEntryList.getEntries")}}</p> |
