document.evaluate
=================

La méthode **`evaluate()`** renvoie un `XPathResult` (en-US) basé sur une expression XPath et d'autres paramètres donnés.

Syntaxe
-------


```js
var xpathResult = document.evaluate(
  xpathExpression,
  contextNode,
  namespaceResolver,
  resultType,
  result,
);
```


* `xpathExpression` est une chaîne de caractères représentant le XPath à évaluer.
* `contextNode` spécifie le noeud de contexte pour la requête (voir XPath specification) . Il est courant de transmettre un document en tant que nœud de contexte.
* `namespaceResolver` est une fonction qui recevra tous les préfixes d'espace de noms et devrait renvoyer une chaîne représentant l'URI de l'espace de noms associé à ce préfixe. Il sera utilisé pour résoudre les préfixes dans le XPath lui-même, afin qu'ils puissent être mis en correspondance avec le document. `null` est commun pour les documents HTML ou lorsque aucun préfixe d'espace de noms n'est utilisé.
* `resultType` est un nombre entier qui correspond au type de résultat `XPathResult` à retourner. Utilisez des propriétés de constantes nommées, comme `XPathResult.ANY_TYPE` du constructeur de XPathResult , lequel correspond à un nombre entier compris entre 0 et 9.
* `result` est un `XPathResult` existant à utiliser pour les résultats. `null` est le plus commun et va créer un nouveau XPathResult
Exemples
--------


```js
 var headings  =  document .  evaluate  ( " / html / body //h2", document, null, XPathResult.ANY\_TYPE, null);
 /\* Cherche le document pour tout élément h2.
 \* Le résultat sera probablement un itérateur de noeuds non ordonné. \*/
 var thisHeading  =  headings .  iterateNext  (  )  ;
 var alertText  =   "Level 2 headings in this document are:\n"  ;
 while   ( thisHeading )   {
  alertText  +  =  thisHeading . textContent  +   "\n"  ;
  thisHeading  =  headings .  iterateNext  (  )  ;
 }
 alert  ( alertText )  ;   // Alerte le texte de tout élément h2
```


Note : dans l'exemple ci-dessus, un XPath plus verbeux est préféré aux raccourcis communs tels que `//h2`. Généralement, des sélecteurs XPath plus spécifiques, comme dans l'exemple ci-dessus, améliorent de façon significative les performances, en particulier pour les documents très volumineux. C'est parce que l'évaluation de la requête ne perd pas de temps à visiter des noeuds inutiles. L'utilisation de // est généralement lente car elle visite tous les nœuds de la racine et tous les sous-nœuds à la recherche de correspondances possibles.

Une optimisation supplémentaire peut être obtenue en utilisant soigneusement le paramètre de contexte. Par exemple, si vous savez que le contenu que vous recherchez se trouve quelque part dans la balise body, vous pouvez utiliser ceci :


```js
document.evaluate(" . //h2", document.body, null, XPathResult.ANY\_TYPE, null);
```


Remarquez ci-dessus, `document.body` a été utilisé comme contexte plutôt que comme document, de sorte que le XPath commence à partir de l'élément body. (Dans cet exemple, le `"."` est important pour indiquer que l'interrogation doit commencer à partir du noeud contextuel, document.body . Si le "." est omis (en quittant `//h2`), la requête démarrera à partir du noeud racine ( `html`) ce qui serait plus inutile.)

Voir Introduction à l'utilisation de XPath avec JavaScript pour plus d'informations.

Notes
-----

* Les expressions XPath peuvent être évaluées sur les documents HTML et XML.
* Lors de l'utilisation de document.evaluate() dans FF2 ; dans FF3, il faut utiliser someXMLDoc.evaluate() si l'on évalue quelque chose d'autre que le document actuel.
Types de résultats
------------------

Ce sont des valeurs prises en charge pour le paramètre `resultType` de la méthode `evaluate` :

|  |  |  |
| --- | --- | --- |
| Type de résultat | Valeur | Description |
| `ANY_TYPE` | 0 | Quel que soit le type, résulte naturellement de l'expression donnée. |
| `NUMBER_TYPE` | 1 | 
 Un ensemble de résultats contenant un seul nombre. Utile, par exemple,
 dans une expression XPath utilisant la fonction count().
  |
| `STRING_TYPE` | 2 | Un ensemble de résultats contenant une seule chaîne de caractères. |
| `BOOLEAN_TYPE` | 3 | 
 Un ensemble de résultats contenant une seule valeur booléenne. Utile
 pour, par exemple, une expression XPath utilisant la fonction not().
  |
| `UNORDERED_NODE_ITERATOR_TYPE` | 4 | 
 Un ensemble de résultats contenant tous les nœuds correspondant à
 l'expression. Les nœuds de cet ensemble ne sont pas nécessairement dans
 le même ordre que celui de leur apparition dans le document.
  |
| `ORDERED_NODE_ITERATOR_TYPE` | 5 | 
 Un ensemble de résultats contenant tous les noeuds correspondant à
 l'expression. Les nœuds de cet ensemble sont dans le même ordre que
 celui de leur apparition dans le document .
  |
| `UNORDERED_NODE_SNAPSHOT_TYPE` | 6 | 
 Un ensemble de résultats contenant des instantanés de tous les nœuds
 correspondant à l'expression. Les nœuds de cet ensemble ne sont pas
 nécessairement dans le même ordre que celui de leur apparition dans le
 document .
  |
| `ORDERED_NODE_SNAPSHOT_TYPE` | 7 | 
 Un ensemble de résultats contenant des instantanés de tous les nœuds
 correspondant à l'expression. Les nœuds de cet ensemble sont dans le
 même ordre que celui de leur apparition dans le document .
  |
| `ANY_UNORDERED_NODE_TYPE` | 8 | 
 Un ensemble de résultats contenant un seul nœud correspondant à
 l'expression. Le noeud n'est pas nécessairement le premier noeud du
 document qui correspond à l'expression.
  |
| `FIRST_ORDERED_NODE_TYPE` | 9 | 
 Un ensemble de résultats contenant le premier nœud du document qui
 correspond à l'expression.
  |

Les résultats des types `NODE_ITERATOR` contiennent des références aux noeuds du document. La modification d'un nœud invalidera l'itérateur. Après avoir modifié un nœud, tenter de parcourir les résultats entraînera une erreur.

Les résultats des types `NODE_SNAPSHOT` sont des instantanés, qui sont essentiellement des listes de nœuds correspondants. Vous pouvez apporter des modifications au document en modifiant les nœuds de capture instantanée. La modification du document n'invalide pas l'instantané. Toutefois, si le document est modifié, l'instantané peut ne pas correspondre à l'état actuel du document, car les nœuds peuvent avoir été déplacés, modifiés, ajoutés ou supprimés.

Spécifications
--------------

| Specification |
| --- |
| DOM Standard # dom-xpathevaluatorbase-evaluate |

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Voir aussi
----------

* DOM : document.createExpression
* XPath Code Snippets
* Vérifier le support du navigateur