Document
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since juillet 2015.
* Some parts of this feature may have varying levels of support.
L'interface Document
représente n'importe quelle page web chargée dans le navigateur et sert de point d'entrée pour accéder au contenu de la page qui est formé par l'arbre du DOM.
L'arbre du DOM inclut les éléments tels que <body>
, <table>
et tous les autres présents dans la page. Il fournit des fonctionnalités à l'ensemble du document et permet, par exemple, d'obtenir l'URL de la page et de créer de nouveaux éléments dans le document.
L'interface Document
décrit les propriétés et méthodes communes à toutes sortes de documents. Selon le type de document (par exemple HTML, XML, SVG, …), une API plus grande pourra être disponible : les documents HTML, servis avec le type de contenu "text/html"
implémenteront également l'interface HTMLDocument
tandis que les documents XML et SVG implémenteront l'interface XMLDocument
.
Constructeur
Document()
-
Crée un nouvel objet
Document
.
Propriétés d'instance
Cette interface hérite également des interfaces Node
et EventTarget
.
Document.activeElement
Lecture seule-
Retourne l'objet
Element
correspondant à l'élément qui possède la sélection. Document.adoptedStyleSheets
-
Ajoute un tableau de feuilles de style construites à utiliser par le document. Ces feuilles de style peuvent aussi être partagées avec les sous-arbres DOM d'ombre (shadow DOM) du même document.
Document.body
-
Retourne le nœud
<body>
ou<frameset>
du document courant. Document.characterSet
Lecture seule-
Retourne le jeu de caractères utilisé par le document.
Document.childElementCount
Lecture seule-
Retourne le nombre d'éléments enfants pour le document courant.
Document.children
Lecture seule-
Retourne les éléments enfants pour le document courant.
Document.compatMode
Lecture seule-
Indique si le document est rendu à l'écran selon le mode quirks ou strict.
Document.contentType
Lecture seule-
Retourne le type MIME du document courant.
Document.currentScript
Lecture seule-
Retourne l'élément
<script>
dont le script est actuellement en cours de traitement et qui n'est pas un module JavaScript (angl.). Document.doctype
Lecture seule-
Retourne la définition du type de document (Document Type Definition ou DTD) du document courant.
Document.documentElement
Lecture seule-
Retourne l'objet
Element
correspondant à l'élément qui est un enfant direct du document. Pour les documents HTML, il s'agit normalement d'un objetHTMLHtmlElement
qui représente l'élément<html>
du document. Document.documentURI
Lecture seule-
Retourne l'emplacement du document sous la forme d'une chaîne de caractères.
Document.embeds
Lecture seule-
Retourne un objet
HTMLCollection
des éléments embarqués (via<embed>
) dans le document. Document.featurePolicy
Expérimental Lecture seule-
Retourne l'interface
FeaturePolicy
avec les politiques de fonctionnalités appliquées au document. Document.firstElementChild
Lecture seule-
Retourne le premier élément enfant du document courant.
Document.fonts
-
Retourne l'interface
FontFaceSet
pour le document courant. Document.forms
Lecture seule-
Retourne un objet
HTMLCollection
des éléments<form>
du document. Document.fragmentDirective
Lecture seule-
Retourne l'objet
FragmentDirective
pour le document courant. Document.fullscreenElement
Lecture seule-
Retourne l'élément actuellement en mode plein écran pour ce document.
Document.head
Lecture seule-
Retourne l'élément
<head>
pour le document courant. -
Retourne une valeur booléenne qui indique si la page est considérée masquée ou non.
Document.images
Lecture seule-
Retourne un objet
HTMLCollection
des images du document. Document.implementation
Lecture seule-
Retourne l'implémentation du DOM associée au document courant.
Document.lastElementChild
Lecture seule-
Retourne le dernier élément enfant du document courant.
Document.links
Lecture seule-
Retourne un objet
HTMLCollection
contenant l'ensemble des hyperliens du document. Document.pictureInPictureElement
Lecture seule-
Retourne l'objet
Element
pour l'élément affiché en mode d'incrustation vidéo (picture-in-picture) pour ce document. Document.pictureInPictureEnabled
Lecture seule-
Retourne
true
si la fonctionnalité d'incrustation vidéo est activée. Document.plugins
Lecture seule-
Retourne un objet
HTMLCollection
contenant les plugins disponibles. Document.pointerLockElement
Lecture seule-
Retourne l'élément définit comme cible pour les évènements de souris pendant que le pointeur est verrouillé. Cette propriété vaut
null
si le verrouillage est en cours, si le pointeur est déverrouillé ou si la cible est située dans un autre document. Document.prerendering
Lecture seule Expérimental-
: Retourne un booléen indiquant si le document est en cours de pré-rendu, lorsqu'un pré-rendu est initié via la Speculation Rules API.
Document.scripts
Lecture seule-
Retourne un objet
HTMLCollection
contenant les éléments<script>
du document. Document.scrollingElement
Lecture seule-
Retourne une référence à l'objet
Element
correspondant à l'élément qui fait défiler le document.Document.styleSheets
Lecture seule -
Retourne un objet
StyleSheetList
contenant les objetsCSSStyleSheet
pour les feuilles de style CSS liées explicitement ou embarquées dans le document. Document.timeline
Lecture seule-
Retourne la chronologie, sous la forme d'une instance
DocumentTimeline
, qui est automatiquement créée au chargement de la page. Document.visibilityState
Lecture seule-
Retourne une chaîne de caractères qui indique l'état de visibilité du document. Les valeurs possibles sont
visible
,hidden
,prerender
, etunloaded
.
Extensions pour HTMLDocument
L'interface Document
pour les documents HTML hérite de l'interface HTMLDocument
ou est étendue pour ces documents.
-
Retourne une liste, dont les éléments sont séparés par des points-virgules, des cookies du document ou permet de définir un cookie.
Document.defaultView
Lecture seule-
Retourne une référence à l'objet de la fenêtre.
Document.designMode
-
Permet d'accéder ou de définir la possibilité d'éditer l'ensemble du document.
Document.dir
-
Permet d'accéder ou de définir la directionnalité (écriture de droite à gauche ou de gauche à droite) du document.
Document.fullscreenEnabled
Lecture seule-
Indique si le mode plein écran est disponible.
Document.lastModified
Lecture seule-
Retourne la date à laquelle le document a été modifié pour la dernière fois.
Document.location
Lecture seule-
Retourne l'URI du document courant.
Document.readyState
Lecture seule-
Retourne l'état de chargement du document.
Document.referrer
Lecture seule-
Retourne l'URI de la page qui a lié vers cette page.
Document.title
-
Permet d'accéder ou de définir le titre du document courant.
Document.URL
Lecture seule-
Retourne l'emplacement du document sous la forme d'une chaîne de caractères. Propriétés nommées
-
Certains éléments du document sont également exposés comme propriétés :
- Pour chaque élément HTML
<embed>
,<form>
,<iframe>
,<img>
et<object>
, sa propriéténame
(si elle n'est pas vide) est exposée. Par exemple, si le document contient<form name="my_form">
, alorsdocument["my_form"]
(et son équivalentdocument.my_form
) retourne une référence vers cet élément. - Pour chaque élément HTML
<object>
, sa propriétéid
(si elle n'est pas vide) est exposée. - Pour chaque élément HTML
<img>
avec unname
non vide, sa propriétéid
(si elle n'est pas vide) est exposée.
Si une propriété correspond à un seul élément, cet élément est directement retourné. Si cet élément unique est une iframe, alors sa propriété
contentWindow
est retournée à la place. Si la propriété correspond à plusieurs éléments, alors un objetHTMLCollection
contenant tous ces éléments est retourné. - Pour chaque élément HTML
Propriétés dépréciées
Document.alinkColor
Obsolète-
Retourne ou définit la couleur des liens actifs dans le corps du document.
Document.all
Obsolète-
Donne accès à tous les éléments du document — retourne un objet
HTMLAllCollection
enraciné sur le nœud document. Propriété héritée, non standard, à ne pas utiliser. Document.anchors
Obsolète Lecture seule-
Retourne la liste de toutes les ancres du document.
Document.applets
Obsolète Lecture seule-
Retourne un objet
HTMLCollection
vide. Propriété héritée qui retournait la liste des applets du document. Document.bgColor
Obsolète-
Obtient ou définit la couleur d'arrière-plan du document courant.
Document.charset
Obsolète Lecture seule-
Alias de
Document.characterSet
. Utilisez cette propriété à la place. Document.domain
Obsolète-
Obtient ou définit le domaine du document courant.
Document.fgColor
Obsolète-
Obtient ou définit la couleur de premier plan, ou couleur du texte, du document courant.
Document.fullscreen
Obsolète-
Retourne
true
lorsque le document est en mode plein écran. Document.inputEncoding
Obsolète Lecture seule-
Alias de
Document.characterSet
. Utilisez cette propriété à la place. Document.lastStyleSheetSet
Obsolète Lecture seule Non standard-
Retourne le nom de l'ensemble de feuilles de style qui a été activé en dernier. Vaut
null
tant que l'ensemble n'a pas été changé viaselectedStyleSheetSet
. Document.linkColor
Obsolète-
Obtient ou définit la couleur des hyperliens du document.
Document.preferredStyleSheetSet
Obsolète Lecture seule Non standard-
Retourne l'ensemble de feuilles de style préféré tel que spécifié par l'auteur·ice de la page.
Document.rootElement
Obsolète-
Comme
Document.documentElement
, mais uniquement pour les éléments racines<svg>
. Utilisez cette propriété à la place. Document.selectedStyleSheetSet
Obsolète Non standard-
Retourne l'ensemble de feuilles de style actuellement utilisé.
Document.styleSheetSets
Obsolète Lecture seule Non standard-
Retourne la liste des ensembles de feuilles de style disponibles sur le document.
Document.vlinkColor
Obsolète-
Obtient ou définit la couleur des liens visités.
Document.xmlEncoding
Obsolète-
Retourne l'encodage déterminé par la déclaration XML.
Document.xmlStandalone
Obsolète-
Retourne
true
si la déclaration XML spécifie que le document est autonome (par exemple, une partie externe de la DTD affecte le contenu du document), sinonfalse
. Document.xmlVersion
Obsolète-
Retourne le numéro de version tel que spécifié dans la déclaration XML ou
"1.0"
si la déclaration est absente.
Méthodes d'instance
Cette interface hérite également des interfaces Node
et EventTarget
.
Document.adoptNode()
-
Adopte un nœud d'un document externe.
Document.append()
-
Insère un ensemble d'objets
Node
ou d'objetsDOMString
après le dernier enfant du document. Document.ariaNotify()
Expérimental Non standard-
Définit qu'une chaîne de caractères donnée doit être annoncée par un lecteur d'écran.
Document.browsingTopics()
Expérimental Non standard-
Retourne une promesse qui se résout avec un tableau d'objets représentant les sujets principaux pour l'utilisateur·ice, un pour chacune des trois dernières époques. Par défaut, la méthode fait aussi enregistrer par le navigateur la visite de la page courante telle qu'observée par l'appelant·e, afin que le nom d'hôte de la page puisse ensuite être utilisé dans le calcul des sujets. Voir la Topics API pour plus de détails.
Document.captureEvents()
Obsolète-
Voir
Window.captureEvents
. Document.caretPositionFromPoint()
-
Retourne un objet
CaretPosition
qui contient le nœud DOM contenant le curseur et le décalage du curseur au sein de ce nœud. Document.caretRangeFromPoint()
Non standard-
Obtient un objet
Range
pour le fragment de document situé aux coordonnées indiquées. Document.createAttribute()
-
Crée un nouvel objet
Attr
et le renvoie. Document.createAttributeNS()
-
Crée un nouveau nœud d'attribut dans un espace de noms donné et le renvoie.
Document.createCDATASection()
-
Crée un nouveau nœud CDATA et le renvoie.
Document.createComment()
-
Crée un nouveau nœud de commentaire et le renvoie.
Document.createDocumentFragment()
-
Crée un nouveau fragment de document.
Document.createElement()
-
Crée un nouvel élément avec le nom de balise indiqué.
Document.createElementNS()
-
Crée un nouvel élément avec le nom de balise indiqué et l'espace de noms passé via un URI.
Document.createEvent()
Obsolète-
Crée un objet d'évènement.
Document.createNodeIterator()
-
Crée un objet
NodeIterator
. Document.createProcessingInstruction()
-
Crée un nouvel objet
ProcessingInstruction
. Document.createRange()
-
Crée un objet
Range
. Document.createTextNode()
-
Crée un nœud texte.
Document.createTouch()
Obsolète Non standard-
Crée un objet
Touch
. Document.createTouchList()
Obsolète Non standard-
Crée un objet
TouchList
. Document.createTreeWalker()
-
Crée un objet
TreeWalker
. Document.elementFromPoint()
-
Retourne l'élément situé le plus en haut pour les coordonnées indiquées.
Document.elementsFromPoint()
-
Retourne un tableau de tous les éléments situés aux coordonnées indiquées.
Document.enableStyleSheetsForSet()
Obsolète Non standard-
Active les feuilles de styles pour l'ensemble de feuilles de styles indiqué.
Document.exitPictureInPicture()
-
Retire la vidéo de la fenêtre d'incrustation vidéo pour la replacer dans son conteneur original.
Document.exitPointerLock()
-
Relâche le verrou du pointeur.
Document.getAnimations()
-
Retourne un tableau contenant tous les objets
Animation
actuellement actifs et dont les éléments cibles sont des descendants du document courant. Document.getBoxQuads()
Expérimental-
Retourne une liste d'objets
DOMQuad
qui représente les fragments CSS du nœud. Document.getElementById()
-
Retourne une référence objet vers l'élément identifié.
Document.getElementsByClassName()
-
Retourne une liste d'éléments avec le nom de classe indiqué.
Document.getElementsByTagName()
-
Retourne une liste d'éléments avec la balise indiquée.
Document.getElementsByTagNameNS()
-
Retourne une liste d'éléments avec le nom de balise et pour l'espace de noms indiqués.
Document.getSelection()
-
Retourne un objet
Selection
qui représente la portion de texte sélectionnée par l'utilisatrice ou l'utilisateur, ou la position du curseur. Document.hasStorageAccess()
-
Retourne un objet
Promise
qui est résolu avec une valeur booléenne selon que le document a accès à du stockage de premier rang. Document.importNode()
-
Retourne un clone d'un nœud d'un document externe.
Document.moveBefore()
-
Déplace un nœud (
Node
) donné à l'intérieur du nœud DOMDocument
en tant qu'enfant direct, avant un nœud de référence donné, sans retirer puis réinsérer le nœud. Document.mozSetImageElement()
Non standard-
Permet de changer l'élément utilisé comme image d'arrière-plan pour un identifiant d'élément spécifié.
Document.prepend()
-
Insère un ensemble d'objet
Node
ou une chaîne de caractères avant le premier enfant du document. Document.querySelector()
-
Retourne le premier nœud
Element
au sein du document, selon l'ordre du document, qui correspond aux sélecteurs indiqués. Document.querySelectorAll()
-
Retourne une liste de tous les nœuds
Element
du document qui correspondent aux sélecteurs indiqués. Document.releaseCapture()
Non standard-
Relâche la capture de la souris si celle-ci est sur un élément du document courant.
Document.releaseEvents()
Obsolète-
Voir
Window.releaseEvents()
. Document.replaceChildren()
-
Remplace l'enfant existant du document avec un ensemble de nouveaux enfants indiqué.
Document.requestStorageAccess()
-
Permet à un document chargé dans un contexte tiers (c'est-à-dire intégré dans un
<iframe>
) de demander l'accès aux cookies non partitionnés, dans les cas où les agents utilisateurs bloquent par défaut l'accès à ces cookies pour les sites chargés dans un contexte tiers afin d'améliorer la confidentialité. Document.requestStorageAccessFor()
Expérimental-
Permet aux sites de premier niveau de demander l'accès aux cookies tiers pour le compte d'un contenu intégré provenant d'un autre site du même ensemble de sites liés.
Document.startViewTransition()
-
Démarre une nouvelle transition de vue et retourne un objet
ViewTransition
pour la représenter.
L'interface Document
est étendue avec l'interface XPathEvaluator
:
Document.createExpression()
-
Compile une
XPathExpression
qui peut ensuite être utilisée pour des évaluations (répétées). Document.createNSResolver()
Obsolète-
Retourne le nœud passé en entrée tel quel.
Document.evaluate()
-
Évalue une expression XPath.
Extension pour les documents HTML
Pour les documents HTML, l'interface Document
hérite de l'interface HTMLDocument
ou est étendue pour ces documents :
Document.clear()
Obsolète-
Pour la majorité des navigateurs récents, y compris pour les versions récentes de Firefox et d'Internet Explorer, cette méthode ne fait rien.
Document.close()
-
Ferme le flux d'écriture sur un document.
Document.execCommand()
Obsolète-
Pour un document éditable, exécute une commande de formatage.
Document.getElementsByName()
-
Retourne une liste des éléments avec le nom indiqué.
Document.hasFocus()
-
Retourne
true
si la sélection est situé à l'intérieur du document indiqué. Document.open()
-
Ouvre le flux d'écriture sur un document.
Document.queryCommandEnabled()
Obsolète Non standard-
Retourne
true
si la commande de formatage peut être exécutée sur l'intervalle indiqué. Document.queryCommandIndeterm()
Obsolète-
Retourne
true
si la commande de formatage est dans un état indéterminé pour l'intervalle courant. Document.queryCommandState()
Obsolète Non standard-
Retourne
true
si la commande de formatage a été exécutée sur l'intervalle courant. Document.queryCommandSupported()
Obsolète Non standard-
Retourne
true
si la commande de formatage est prise en charge sur l'intervalle courant. Document.queryCommandValue()
Obsolète-
Retourne la valeur de l'intervalle courant pour une commande de formatage.
Document.write()
Obsolète-
Écrit du texte dans un document.
Document.writeln()
Obsolète-
Écrit une ligne de texte dans un document.
Méthodes statiques
Cette interface hérite également des interfaces Node
et EventTarget
.
Document.parseHTML()
-
Crée un nouvel objet
Document
à partir d'une chaîne HTML, de façon sécurisée contre les attaques XSS, avec une étape de sanitisation. Document.parseHTMLUnsafe()
-
Crée un nouvel objet
Document
à partir d'une chaîne HTML sans effectuer de sanitisation. La chaîne de caractères peut contenir des racines d'ombre déclaratives.
Évènements
L'écoute de ces évènements peut être effectuée avec addEventListener()
ou en affectant un gestionnaire d'évènement à la propriété on<nomdevenement>
correspondante à cette interface.
afterscriptexecute
Non standard Obsolète-
Déclenché lorsqu'un élément statique
<script>
finit d'exécuter son script. beforescriptexecute
Non standard Obsolète-
Déclenché lorsqu'un élément statique
<script>
est sur le point de commencer son exécution. prerenderingchange
Expérimental-
Déclenché sur un document pré-rendu lorsqu'il est activé (c'est-à-dire lorsque l'utilisateur·ice affiche la page).
securitypolicyviolation
-
Déclenché lorsqu'une politique de sécurité du contenu est violée.
visibilitychange
-
Déclenché lorsque le contenu d'un onglet devient visible ou est masqué.
Évènements liés aux animations
animationcancel
-
Déclenché lorsqu'une animation est interrompue de façon inattendue. Également disponible avec la propriété
onanimationcancel
. animationend
-
Déclenché lorsqu'une animation s'est terminée normalement. Également disponible avec la propriété
onanimationend
. animationiteration
-
Déclenché lorsqu'une itération d'une animation est terminée. Également disponible avec la propriété
onanimationiteration
. animationstart
-
Déclenché au démarrage d'une animation. Également disponible avec la propriété
onanimationstart
.
Évènements liés au mode plein écran
fullscreenchange
-
Déclenché lorsque le
Document
entre ou sort du mode plein écran. fullscreenerror
-
Déclenché lorsqu'une erreur se produit lors d'une tentative d'entrée ou de sortie du mode plein écran.
Évènements de chargement et de déchargement
DOMContentLoaded
-
Déclenché lorsque le document a été complètement chargé et analysé, sans attendre la fin du chargement des feuilles de style, des images et des sous-cadres.
readystatechange
-
Déclenché lorsque l'attribut
readyState
d'un document a changé.
Évènements de verrouillage du pointeur
pointerlockchange
-
Déclenché lorsque le pointeur est verrouillé ou déverrouillé.
pointerlockerror
-
Déclenché lorsque le verrouillage du pointeur a échoué.
Évènements de défilement
scroll
-
Déclenché lorsque la vue du document ou un élément a été défilé.
scrollend
-
Déclenché lorsque la vue du document ou un élément a terminé son défilement.
scrollsnapchange
Expérimental-
Déclenché sur le conteneur de défilement à la fin d'une opération de défilement lorsqu'une nouvelle cible d'accrochage a été sélectionnée.
scrollsnapchanging
Expérimental-
Déclenché sur le conteneur de défilement lorsque le navigateur détermine qu'une nouvelle cible d'accrochage est en attente, c'est-à-dire qu'elle sera sélectionnée à la fin du geste de défilement en cours.
Évènements de sélection
selectionchange
-
Déclenché lorsque la sélection textuelle courante d'un document a changé.
Évènements propagés
Tous les évènements qui se propagent n'atteignent pas forcément l'objet Document
. Seuls les évènements suivants peuvent être écoutés sur l'objet Document
par l'utilisateur·ice :
abort
auxclick
beforeinput
beforematch
beforetoggle
blur
cancel
canplay
canplaythrough
change
click
close
contextlost
contextmenu
contextrestored
copy
cuechange
cut
dblclick
drag
dragend
dragenter
dragleave
dragover
dragstart
drop
durationchange
emptied
ended
error
focus
formdata
input
invalid
keydown
keypress
keyup
load
loadeddata
loadedmetadata
loadstart
mousedown
mouseenter
mouseleave
mousemove
mouseout
mouseover
mouseup
paste
pause
play
playing
progress
ratechange
reset
resize
scroll
scrollend
securitypolicyviolation
seeked
seeking
select
slotchange
stalled
submit
suspend
timeupdate
toggle
volumechange
waiting
wheel
Spécifications
Compatibilité des navigateurs
Loading…