range
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2017.
Introduction
L'objet Range
(littéralement : "étendue" ou "portée", ici : "segment") représente un fragment de document qui peut contenir des nœuds et des parties de nœuds texte dans un document donné.
Un segment peut être crée en utilisant la méthode createRange de l'objet document. Les objets range peuvent également être récupérés en utilisant la méthode getRangeAt de l'objet selection.
Propriétés
- collapsed
-
Renvoie un booléen indiquant si le point de départ et le point final du segment sont confondus.
- commonAncestorContainer
-
Renvoie le nœud le plus profond qui contient à la fois les nœuds
startContainer
etendContainer
. - endContainer
-
Renvoie le nœud dans lequel le segment se termine.
- endOffset
-
Renvoie un nombre représentant l'endroit où le segment se termine dans
endContainer
. - startContainer
-
Renvoie le nœud dans lequel le segment débute.
- startOffset
-
Renvoie un nombre représentant l'endroit où le segment débute dans
startContainer
.
Méthodes
Méthodes de positionnement
Ces méthodes permettent de définir le début et la fin d'un segment.
- setStart
-
Définit le point de départ d'un segment.
- setEnd
-
Définit le point final d'un segment.
- setStartBefore
-
Définit le point de départ d'un segment relativement à un autre nœud.
- setStartAfter
-
Définit le point de départ d'un segment relativement à un autre nœud.
- setEndBefore
-
Définit le point final d'un segment relativement à un autre nœud.
- setEndAfter
-
Définit le point final d'un segment relativement à un autre nœud.
- selectNode
-
Le contenu du segment devient le nœud et son contenu.
- selectNodeContents
-
le contenu du segment devient le contenu du nœud.
- collapse
-
Replie le segment sur l'un de ses points frontières.
Méthodes de modification
Ces méthodes recupèrent les nœuds d'un segment et modifient le contenu d'un segment.
- cloneContents
-
Renvoie un fragment de document où sont copiés les nœuds d'un segment.
- deleteContents
-
Supprime du document le contenu d'un segment.
- extractContents
-
Déplace le contenu d'un segment, de l'arbre du document vers un fragment de document.
- insertNode
-
Insère un nœud au début d'un segment.
- surroundContents
-
Déplace le contenu d'un segment dans un nouveau nœud.
Autres méthodes
- compareBoundaryPoints
-
Compare les points frontières de deux segments.
- cloneRange
-
Renvoie un objet
Range
avec des points frontières identiques à ceux du segment cloné. - detach
-
Supprime le segment afin d'améliorer la performance.
- toString
-
Renvoie le texte du segment.
Les méthodes Gecko
Cette section décrit les méthodes de range qui sont particulières à Mozilla et ne font pas partie des spécifications DOM W3C.
- compareNode Obsolète
-
Renvoie une constante qui indique si le nœud est avant, après, dans ou englobe le segment.
- comparePoint
-
Renvoie -1, 0, ou 1, indiquant si le point se trouve avant, après, ou dans le segment.
- createContextualFragment
-
Renvoie un fragment de document créé à partir d'un morceau de code donné.
- intersectsNode Obsolète
-
Renvoie un booléen indiquant si un nœud donné a une intersection avec le segment.
- isPointInRange
-
Renvoie un booléen indiquant si le point donné est dans le segment.