Cette page a été traduite à partir de l'anglais par la communauté.Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.
Document
Baseline Widely available *
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.
* Certaines parties de cette fonctionnalité peuvent bénéficier de prise en charge variables.
L'interfaceDocument 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é parl'arbre du DOM.
L'arbre du DOM inclut les éléments tels que<body>,<table> ettous 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'interfaceDocument décrit les propriétés et méthodes communes à toutes sortes de documents. Selon le type de document (par exempleHTML,XML, SVG, …), une API plus grande pourra être disponible : les documents HTML, servis avec le type de contenu"text/html" implémenteront également l'interfaceHTMLDocument tandis que les documents XML et SVG implémenteront l'interfaceXMLDocument.
Dans cet article
Constructeur
Document()Crée un nouvel objet
Document.
Propriétés d'instance
Cette interface hérite également des interfacesNode etEventTarget.
Document.activeElementLecture seuleRetourne l'objet
Elementcorrespondant à l'élément qui possède la sélection.Document.adoptedStyleSheetsAjoute 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.bodyRetourne le nœud
<body>ou<frameset>du document courant.Document.characterSetLecture seuleRetourne le jeu de caractères utilisé par le document.
Document.childElementCountLecture seuleRetourne le nombre d'éléments enfants pour le document courant.
Document.childrenLecture seuleRetourne les éléments enfants pour le document courant.
Document.compatModeLecture seuleIndique si le document est rendu à l'écran selon le modequirks oustrict.
Document.contentTypeLecture seuleRetourne le type MIME du document courant.
Document.currentScriptLecture seuleRetourne l'élément
<script>dont le script est actuellement en cours de traitement etqui n'est pas un module JavaScript(angl.).Document.doctypeLecture seuleRetourne la définition du type de document (Document Type Definition ou DTD) du document courant.
Document.documentElementLecture seuleRetourne l'objet
Elementcorrespondant à l'élément qui est un enfant direct du document. Pour les documents HTML, il s'agit normalement d'un objetHTMLHtmlElementqui représente l'élément<html>du document.Document.documentURILecture seuleRetourne l'emplacement du document sous la forme d'une chaîne de caractères.
Document.embedsLecture seuleRetourne un objet
HTMLCollectiondes éléments embarqués (via<embed>) dans le document.Document.featurePolicyExpérimentalLecture seuleRetourne l'interface
FeaturePolicyavec les politiques de fonctionnalités appliquées au document.Document.firstElementChildLecture seuleRetourne le premier élément enfant du document courant.
Document.fontsRetourne l'interface
FontFaceSetpour le document courant.Document.formsLecture seuleRetourne un objet
HTMLCollectiondes éléments<form>du document.Document.fragmentDirectiveLecture seuleRetourne l'objet
FragmentDirectivepour le document courant.Document.fullscreenElementLecture seuleRetourne l'élément actuellement en mode plein écran pour ce document.
Document.headLecture seuleRetourne l'élément
<head>pour le document courant.Document.hiddenLecture seuleRetourne une valeur booléenne qui indique si la page est considérée masquée ou non.
Document.imagesLecture seuleRetourne un objet
HTMLCollectiondes images du document.Document.implementationLecture seuleRetourne l'implémentation du DOM associée au document courant.
Document.lastElementChildLecture seuleRetourne le dernier élément enfant du document courant.
Document.linksLecture seuleRetourne un objet
HTMLCollectioncontenant l'ensemble des hyperliens du document.Document.pictureInPictureElementLecture seuleRetourne l'objet
Elementpour l'élément affiché en mode d'incrustation vidéo (picture-in-picture) pour ce document.Document.pictureInPictureEnabledLecture seuleRetourne
truesi la fonctionnalité d'incrustation vidéo est activée.Document.pluginsLecture seuleRetourne un objet
HTMLCollectioncontenant les plugins disponibles.Document.pointerLockElementLecture seuleRetourne l'élément définit comme cible pour les évènements de souris pendant que le pointeur est verrouillé. Cette propriété vaut
nullsi le verrouillage est en cours, si le pointeur est déverrouillé ou si la cible est située dans un autre document.Document.prerenderingLecture seuleExpérimental: Retourne un booléen indiquant si le document est en cours de pré-rendu, lorsqu'un pré-rendu est initié via laSpeculation Rules API.
Document.scriptsLecture seuleRetourne un objet
HTMLCollectioncontenant les éléments<script>du document.Document.scrollingElementLecture seuleRetourne une référence à l'objet
Elementcorrespondant à l'élément qui fait défiler le document.Document.styleSheetsLecture seuleRetourne un objet
StyleSheetListcontenant les objetsCSSStyleSheetpour les feuilles de style CSS liées explicitement ou embarquées dans le document.Document.timelineLecture seuleRetourne la chronologie, sous la forme d'une instance
DocumentTimeline, qui est automatiquement créée au chargement de la page.Document.visibilityStateLecture seuleRetourne une chaîne de caractères qui indique l'état de visibilité du document. Les valeurs possibles sont
visible,hidden,prerender, etunloaded.
Extensions pourHTMLDocument
L'interfaceDocument pour les documents HTML hérite de l'interfaceHTMLDocument ou est étendue pour ces documents.
Document.cookieRetourne 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.defaultViewLecture seuleRetourne une référence à l'objet de la fenêtre.
Document.designModePermet d'accéder ou de définir la possibilité d'éditer l'ensemble du document.
Document.dirPermet d'accéder ou de définir la directionnalité (écriture de droite à gauche ou de gauche à droite) du document.
Document.fullscreenEnabledLecture seuleIndique si le mode plein écran est disponible.
Document.lastModifiedLecture seuleRetourne la date à laquelle le document a été modifié pour la dernière fois.
Document.locationLecture seuleRetourne l'URI du document courant.
Document.readyStateLecture seuleRetourne l'état de chargement du document.
Document.referrerLecture seuleRetourne l'URI de la page qui a lié vers cette page.
Document.titlePermet d'accéder ou de définir le titre du document courant.
Document.URLLecture seuleRetourne 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 unnamenon 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é
contentWindowest retournée à la place. Si la propriété correspond à plusieurs éléments, alors un objetHTMLCollectioncontenant tous ces éléments est retourné.- Pour chaque élément HTML
Propriétés dépréciées
Document.alinkColorObsolèteRetourne ou définit la couleur des liens actifs dans le corps du document.
Document.allObsolèteDonne accès à tous les éléments du document — retourne un objet
HTMLAllCollectionenraciné sur le nœud document. Propriété héritée, non standard, à ne pas utiliser.Document.anchorsObsolèteLecture seuleRetourne la liste de toutes les ancres du document.
Document.appletsObsolèteLecture seuleRetourne un objet
HTMLCollectionvide. Propriété héritée qui retournait la liste des applets du document.Document.bgColorObsolèteObtient ou définit la couleur d'arrière-plan du document courant.
Document.charsetObsolèteLecture seuleAlias de
Document.characterSet. Utilisez cette propriété à la place.Document.domainObsolèteObtient ou définit le domaine du document courant.
Document.fgColorObsolèteObtient ou définit la couleur de premier plan, ou couleur du texte, du document courant.
Document.fullscreenObsolèteRetourne
truelorsque le document est enmode plein écran.Document.inputEncodingObsolèteLecture seuleAlias de
Document.characterSet. Utilisez cette propriété à la place.Document.lastStyleSheetSetObsolèteLecture seuleNon standardRetourne le nom de l'ensemble de feuilles de style qui a été activé en dernier. Vaut
nulltant que l'ensemble n'a pas été changé viaselectedStyleSheetSet.Document.linkColorObsolèteObtient ou définit la couleur des hyperliens du document.
Document.preferredStyleSheetSetObsolèteLecture seuleNon standardRetourne l'ensemble de feuilles de style préféré tel que spécifié par l'auteur·ice de la page.
Document.rootElementObsolèteComme
Document.documentElement, mais uniquement pour les éléments racines<svg>. Utilisez cette propriété à la place.Document.selectedStyleSheetSetObsolèteNon standardRetourne l'ensemble de feuilles de style actuellement utilisé.
Document.styleSheetSetsObsolèteLecture seuleNon standardRetourne la liste des ensembles de feuilles de style disponibles sur le document.
Document.vlinkColorObsolèteObtient ou définit la couleur des liens visités.
Document.xmlEncodingObsolèteRetourne l'encodage déterminé par la déclaration XML.
Document.xmlStandaloneObsolèteRetourne
truesi 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.xmlVersionObsolèteRetourne 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 interfacesNode etEventTarget.
Document.adoptNode()Adopte un nœud d'un document externe.
Document.append()Insère un ensemble d'objets
Nodeou d'objetsDOMStringaprès le dernier enfant du document.Document.ariaNotify()ExpérimentalNon standardDéfinit qu'une chaîne de caractères donnée doit être annoncée par un lecteur d'écran.
Document.browsingTopics()ExpérimentalNon standardRetourne 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 laTopics API pour plus de détails.
Document.captureEvents()ObsolèteVoir
Window.captureEvents.Document.caretPositionFromPoint()Retourne un objet
CaretPositionqui contient le nœud DOM contenant le curseur et le décalage du curseur au sein de ce nœud.Document.caretRangeFromPoint()Non standardObtient un objet
Rangepour le fragment de document situé aux coordonnées indiquées.Document.createAttribute()Crée un nouvel objet
Attret 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èteCré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èteNon standardCrée un objet
Touch.Document.createTouchList()ObsolèteNon standardCré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èteNon standardActive 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
Animationactuellement actifs et dont les éléments cibles sont des descendants du document courant.Document.getBoxQuads()ExpérimentalRetourne une liste d'objets
DOMQuadqui 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
Selectionqui 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
Promisequi 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 DOMDocumenten 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 standardPermet 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
Nodeou une chaîne de caractères avant le premier enfant du document.Document.querySelector()Retourne le premier nœud
Elementau 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
Elementdu document qui correspondent aux sélecteurs indiqués.Document.releaseCapture()Non standardRelâche la capture de la souris si celle-ci est sur un élément du document courant.
Document.releaseEvents()ObsolèteDocument.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érimentalPermet 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êmeensemble de sites liés.
Document.startViewTransition()Démarre une nouvelletransition de vue et retourne un objet
ViewTransitionpour la représenter.
L'interfaceDocument est étendue avec l'interfaceXPathEvaluator :
Document.createExpression()Compile une
XPathExpressionqui peut ensuite être utilisée pour des évaluations (répétées).Document.createNSResolver()ObsolèteRetourne 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'interfaceDocument hérite de l'interfaceHTMLDocument ou est étendue pour ces documents :
Document.clear()ObsolètePour 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ètePour un document éditable, exécute une commande de formatage.
Document.getElementsByName()Retourne une liste des éléments avec le nom indiqué.
Document.hasFocus()Retourne
truesi la sélection est situé à l'intérieur du document indiqué.Document.open()Ouvre le flux d'écriture sur un document.
Document.queryCommandEnabled()ObsolèteNon standardRetourne
truesi la commande de formatage peut être exécutée sur l'intervalle indiqué.Document.queryCommandIndeterm()ObsolèteRetourne
truesi la commande de formatage est dans un état indéterminé pour l'intervalle courant.Document.queryCommandState()ObsolèteNon standardRetourne
truesi la commande de formatage a été exécutée sur l'intervalle courant.Document.queryCommandSupported()ObsolèteNon standardRetourne
truesi la commande de formatage est prise en charge sur l'intervalle courant.Document.queryCommandValue()ObsolèteRetourne 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 interfacesNode etEventTarget.
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 avecaddEventListener() ou en affectant un gestionnaire d'évènement à la propriétéon<nomdevenement> correspondante à cette interface.
afterscriptexecuteNon standardObsolèteDéclenché lorsqu'un élément statique
<script>finit d'exécuter son script.beforescriptexecuteNon standardObsolèteDéclenché lorsqu'un élément statique
<script>est sur le point de commencer son exécution.prerenderingchangeExpérimentalDéclenché sur un document pré-rendu lorsqu'il est activé (c'est-à-dire lorsque l'utilisateur·ice affiche la page).
securitypolicyviolationDéclenché lorsqu'une politique de sécurité du contenu est violée.
visibilitychangeDéclenché lorsque le contenu d'un onglet devient visible ou est masqué.
Évènements liés aux animations
animationcancelDéclenché lorsqu'une animation est interrompue de façon inattendue. Également disponible avec la propriété
onanimationcancel.animationendDéclenché lorsqu'une animation s'est terminée normalement. Également disponible avec la propriété
onanimationend.animationiterationDéclenché lorsqu'une itération d'une animation est terminée. Également disponible avec la propriété
onanimationiteration.animationstartDéclenché au démarrage d'une animation. Également disponible avec la propriété
onanimationstart.
Évènements liés au mode plein écran
fullscreenchangeDéclenché lorsque le
Documententre ou sort du modeplein écran.fullscreenerrorDéclenché lorsqu'une erreur se produit lors d'une tentative d'entrée ou de sortie du modeplein écran.
Évènements de chargement et de déchargement
DOMContentLoadedDé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.
readystatechangeDéclenché lorsque l'attribut
readyStated'un document a changé.
Évènements de verrouillage du pointeur
pointerlockchangeDéclenché lorsque le pointeur est verrouillé ou déverrouillé.
pointerlockerrorDéclenché lorsque le verrouillage du pointeur a échoué.
Évènements de défilement
scrollDéclenché lorsque la vue du document ou un élément a été défilé.
scrollendDéclenché lorsque la vue du document ou un élément a terminé son défilement.
scrollsnapchangeExpérimentalDé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.
scrollsnapchangingExpérimentalDé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
selectionchangeDé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'objetDocument. Seuls les évènements suivants peuvent être écoutés sur l'objetDocument par l'utilisateur·ice :
abortauxclickbeforeinputbeforematchbeforetoggleblurcancelcanplaycanplaythroughchangeclickclosecontextlostcontextmenucontextrestoredcopycuechangecutdblclickdragdragenddragenterdragleavedragoverdragstartdropdurationchangeemptiedendederrorfocusformdatainputinvalidkeydownkeypresskeyuploadloadeddataloadedmetadataloadstartmousedownmouseentermouseleavemousemovemouseoutmouseovermouseuppastepauseplayplayingprogressratechangeresetresizescrollscrollendsecuritypolicyviolationseekedseekingselectslotchangestalledsubmitsuspendtimeupdatetogglevolumechangewaitingwheel