Dokument

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Das Document-Interface repräsentiert jede in einem Browser geladene Webseite und dient als Einstiegspunkt in den Inhalt der Webseite, der der DOM-Baum ist.

Der DOM-Baum umfasst Elemente wie <body> und <table>, neben vielen anderen. Es bietet global Funktionen für das Dokument, wie das Abrufen der URL der Seite und das Erstellen neuer Elemente im Dokument.

Das Document-Interface beschreibt die allgemeinen Eigenschaften und Methoden für jede Art von Dokument. Abhängig vom Typ des Dokuments (z. B. HTML, XML, SVG, ...) steht eine größere API zur Verfügung: HTML-Dokumente, die mit dem Inhalts-Typ "text/html" serviert werden, implementieren auch das HTMLDocument-Interface, während XML- und SVG-Dokumente das XMLDocument-Interface implementieren.

Konstruktor

Document(): Erstellt ein neues Document-Objekt.

Instanzeigenschaften

Dieses Interface erbt auch vom Node und EventTarget Interface.

Document.activeElement Nur lesbar: Gibt das Element zurück, das derzeit den Fokus hat.
Document.adoptedStyleSheets: Fügt ein Array von erstellten Stylesheets hinzu, die vom Dokument verwendet werden sollen. Diese Stylesheets können auch mit Schatten-DOM-Teilbäumen desselben Dokuments geteilt werden.
Document.body: Gibt den <body> oder <frameset> Knoten des aktuellen Dokuments zurück.
Document.characterSet Nur lesbar: Gibt das Zeichensatz zurück, das vom Dokument verwendet wird.
Document.childElementCount Nur lesbar: Gibt die Anzahl der Kindelemente des aktuellen Dokuments zurück.
Document.children Nur lesbar: Gibt die Kindelemente des aktuellen Dokuments zurück.
Document.compatMode Nur lesbar: Gibt an, ob das Dokument im quirks oder im strict Modus gerendert wird.
Document.contentType Nur lesbar: Gibt den in der MIME-Header des aktuellen Dokuments spezifizierten Content-Type zurück.
Document.currentScript Nur lesbar: Gibt das <script>-Element zurück, dessen Skript derzeit verarbeitet wird und kein JavaScript-Modul ist.
Document.doctype Nur lesbar: Gibt die Document Type Definition (DTD) des aktuellen Dokuments zurück.
Document.documentElement Nur lesbar: Gibt das Element zurück, das ein direktes Kindelement des Dokuments ist. Für HTML-Dokumente ist dies normalerweise das HTMLHtmlElement-Objekt, welches das <html>-Element des Dokuments repräsentiert.
Document.documentURI Nur lesbar: Gibt den Dokumentstandort als Zeichenkette zurück.
Document.embeds Nur lesbar: Gibt eine HTMLCollection der eingebetteten <embed>-Elemente im Dokument zurück.
Document.featurePolicy Experimentell Nur lesbar: Gibt das FeaturePolicy-Interface mit den im Dokument angewendeten Funktionenrichtlinien zurück.
Document.firstElementChild Nur lesbar: Gibt das erste Kindelement des aktuellen Dokuments zurück.
Document.fonts: Gibt das FontFaceSet-Interface des aktuellen Dokuments zurück.
Document.forms Nur lesbar: Gibt eine HTMLCollection der <form>-Elemente im Dokument zurück.
Document.fragmentDirective Nur lesbar: Gibt die FragmentDirective für das aktuelle Dokument zurück.
Document.fullscreenElement Nur lesbar: Das Element, das sich aktuell im Vollbildmodus für dieses Dokument befindet.
Document.head Nur lesbar: Gibt das <head>-Element des aktuellen Dokuments zurück.
Document.hidden Nur lesbar: Gibt einen booleschen Wert zurück, der anzeigt, ob die Seite als ausgeblendet betrachtet wird oder nicht.
Document.images Nur lesbar: Gibt eine HTMLCollection der Bilder im Dokument zurück.
Document.implementation Nur lesbar: Gibt die mit dem aktuellen Dokument verknüpfte DOM-Implementierung zurück.
Document.lastElementChild Nur lesbar: Gibt das letzte Kindelement des aktuellen Dokuments zurück.
Document.links Nur lesbar: Gibt eine HTMLCollection der Hyperlinks im Dokument zurück.
Document.pictureInPictureElement Nur lesbar: Gibt das Element zurück, das derzeit im Bild-in-Bild-Modus in diesem Dokument präsentiert wird.
Document.pictureInPictureEnabled Nur lesbar: Gibt true zurück, wenn die Bild-in-Bild-Funktion aktiviert ist.
Document.plugins Nur lesbar: Gibt eine HTMLCollection der verfügbaren Plugins zurück.
Document.pointerLockElement Nur lesbar: Gibt das Element zurück, das als Ziel für Mausereignisse festgelegt wurde, während der Zeiger gesperrt ist. null, wenn die Sperrung aussteht, der Zeiger entsperrt ist oder wenn das Ziel in einem anderen Dokument ist.
Document.prerendering Nur lesbar Experimentell: Gibt einen Booleschen Wert zurück, der anzeigt, ob sich das Dokument derzeit im Prerendering-Prozess befindet, wie er über die Speculation Rules API initiiert wurde.
Document.scripts Nur lesbar: Gibt eine HTMLCollection der <script>-Elemente im Dokument zurück.
Document.scrollingElement Nur lesbar: Gibt eine Referenz auf das Element zurück, das das Dokument scrollt.
Document.styleSheets Nur lesbar: Gibt eine StyleSheetList von CSSStyleSheet-Objekten für Stylesheets zurück, die explizit in einem Dokument verlinkt oder eingebettet sind.
Document.timeline Nur lesbar: Gibt den Zeitstrahl als spezielle Instanz von DocumentTimeline zurück, der beim Laden der Seite automatisch erstellt wird.
Document.visibilityState Nur lesbar: Gibt einen string zurück, der den Sichtbarkeitszustand des Dokuments bezeichnet. Mögliche Werte sind visible, hidden, prerender und unloaded.

Erweiterungen für HTMLDocument

Das Document-Interface für HTML-Dokumente erbt vom HTMLDocument-Interface oder wird für solche Dokumente erweitert.

Document.cookie: Gibt eine durch Semikolon getrennte Liste der Cookies für dieses Dokument zurück oder setzt ein einzelnes Cookie.
Document.defaultView Nur lesbar: Gibt eine Referenz auf das window-Objekt zurück.
Document.designMode: Ruft die Möglichkeit ab/legt sie fest, das gesamte Dokument zu bearbeiten.
Document.dir: Ruft die Richtung (rtl/ltr) des Dokuments ab/setzt sie.
Document.fullscreenEnabled Nur lesbar: Gibt an, ob der Vollbildmodus verfügbar ist.
Document.lastModified Nur lesbar: Gibt das Datum zurück, an dem das Dokument zuletzt geändert wurde.
Document.location Nur lesbar: Gibt die URI des aktuellen Dokuments zurück.
Document.readyState Nur lesbar: Gibt den Ladezustand des Dokuments zurück.
Document.referrer Nur lesbar: Gibt die URI der Seite zurück, die zu dieser Seite verlinkt hat.
Document.title: Setzt oder erhält den Titel des aktuellen Dokuments.
Document.URL Nur lesbar: Gibt den Dokumentstandort als Zeichenkette zurück.

Veraltete Eigenschaften

Document.alinkColor Veraltet: Gibt die Farbe von aktiven Links im Dokumentkörper zurück oder setzt sie.
Document.all Veraltet: Bietet Zugriff auf alle Elemente im Dokument — es gibt eine HTMLAllCollection zurück, die an der Dokumentknoten verankert ist. Dies ist eine veraltete, nicht standardisierte Eigenschaft und sollte nicht verwendet werden.
Document.anchors Veraltet Nur lesbar: Gibt eine Liste aller Anker im Dokument zurück.
Document.applets Veraltet Nur lesbar: Gibt eine leere HTMLCollection zurück. Veraltete Eigenschaft, die früher die Liste der Applets innerhalb eines Dokuments zurückgab.
Document.bgColor Veraltet: Ruft die Hintergrundfarbe des aktuellen Dokuments ab/setzt sie.
Document.charset Veraltet Nur lesbar: Alias von Document.characterSet. Verwenden Sie stattdessen diese Eigenschaft.
Document.domain Veraltet: Ruft die Domäne des aktuellen Dokuments ab/setzt sie.
Document.fgColor Veraltet: Ruft die Vordergrundfarbe oder Textfarbe des aktuellen Dokuments ab/setzt sie.
Document.fullscreen Veraltet: Gibt true zurück, wenn sich das Dokument im Vollbildmodus befindet.
Document.inputEncoding Veraltet Nur lesbar: Alias von Document.characterSet. Verwenden Sie stattdessen diese Eigenschaft.
Document.lastStyleSheetSet Veraltet Nur lesbar Nicht standardisiert: Gibt den Namen des zuletzt aktivierten Stylesheets-Sets zurück. Hat den Wert null, bis das Stylesheet geändert wird, indem der Wert von selectedStyleSheetSet gesetzt wird.
Document.linkColor Veraltet: Ruft die Farbe von Hyperlinks im Dokument ab/setzt sie.
Document.preferredStyleSheetSet Veraltet Nur lesbar Nicht standardisiert: Gibt das bevorzugte Stylesheet-Set zurück, wie vom Seitenautor angegeben.
Document.rootElement Veraltet: Wie Document.documentElement, jedoch nur für <svg>-Wurzelelemente. Verwenden Sie stattdessen diese Eigenschaft.
Document.selectedStyleSheetSet Veraltet Nicht standardisiert: Gibt zurück, welches Stylesheet-Set derzeit in Verwendung ist.
Document.styleSheetSets Veraltet Nur lesbar Nicht standardisiert: Gibt eine Liste der im Dokument verfügbaren Stylesheet-Sets zurück.
Document.vlinkColor Veraltet: Ruft die Farbe von besuchten Hyperlinks ab/setzt sie.
Document.xmlEncoding Veraltet: Gibt die Kodierung zurück, wie sie in der XML-Deklaration festgelegt wurde.
Document.xmlStandalone Veraltet: Gibt true zurück, wenn die XML-Deklaration angibt, dass das Dokument eigenständig ist (z. B., Ein externer Teil des DTD beeinflusst den Inhalt des Dokuments), andernfalls false.
Document.xmlVersion Veraltet: Gibt die Versionsnummer zurück, wie sie in der XML-Deklaration angegeben ist oder "1.0", wenn die Deklaration fehlt.

Instanzmethoden

Dieses Interface erbt auch von den Node und EventTarget Interfaces.

Document.adoptNode(): Adoptiert einen Knoten aus einem externen Dokument.
Document.append(): Fügt eine Menge von Node-Objekten oder Zeichenfolgen nach dem letzten Kindelement des Dokuments ein.
Document.browsingTopics() Experimentell Nicht standardisiert: Gibt ein Versprechen zurück, das mit einem Array von Objekten erfüllt wird, die die Top-Themen für den Nutzer repräsentieren, eines aus jeder der letzten drei Epochen. Standardmäßig verursacht die Methode auch, dass der Browser den aktuellen Seitenbesuch aufzeichnet, wie vom Aufrufer beobachtet, sodass der Hostname der Seite später in der Themenberechnung verwendet werden kann. Siehe die Topics API für weitere Details.
Document.captureEvents() Veraltet: Siehe Window.captureEvents.
Document.caretPositionFromPoint(): Gibt ein CaretPosition-Objekt zurück, das den DOM-Knoten enthält, der die Einfügemarke enthält, und den Zeichenoffset der Einfügemarke innerhalb dieses Knotens.
Document.caretRangeFromPoint() Nicht standardisiert: Ruft ein Range-Objekt für das Dokumentfragment unter den angegebenen Koordinaten ab.
Document.createAttribute(): Erstellt ein neues Attr-Objekt und gibt es zurück.
Document.createAttributeNS(): Erstellt ein neues Attributknoten in einem angegebenen Namensraum und gibt es zurück.
Document.createCDATASection(): Erstellt einen neuen CDATA-Knoten und gibt ihn zurück.
Document.createComment(): Erstellt einen neuen Kommentarknoten und gibt ihn zurück.
Document.createDocumentFragment(): Erstellt ein neues Dokumentfragment.
Document.createElement(): Erstellt ein neues Element mit dem angegebenen Tag-Namen.
Document.createElementNS(): Erstellt ein neues Element mit dem angegebenen Tag-Namen und Namensraum-URI.
Document.createEvent() Veraltet: Erstellt ein Ereignisobjekt.
Document.createNodeIterator(): Erstellt ein NodeIterator-Objekt.
Document.createProcessingInstruction(): Erstellt ein neues ProcessingInstruction-Objekt.
Document.createRange(): Erstellt ein Range-Objekt.
Document.createTextNode(): Erstellt ein Textknoten.
Document.createTouch() Veraltet Nicht standardisiert: Erstellt ein Touch-Objekt.
Document.createTouchList() Veraltet Nicht standardisiert: Erstellt ein TouchList-Objekt.
Document.createTreeWalker(): Erstellt ein TreeWalker-Objekt.
Document.elementFromPoint(): Gibt das oberste Element an den angegebenen Koordinaten zurück.
Document.elementsFromPoint(): Gibt ein Array aller Elemente an den angegebenen Koordinaten zurück.
Document.enableStyleSheetsForSet() Veraltet Nicht standardisiert: Aktiviert die Stylesheets für das angegebene Stylesheet-Set.
Document.exitFullscreen(): Beendet das Anzeigen des Vollbildelements des Dokuments im Vollbildmodus.
Document.exitPictureInPicture(): Entfernt das Video aus dem schwebenden Bild-in-Bild-Fenster zurück in seinen ursprünglichen Container.
Document.exitPointerLock(): Gibt die Zeigersperre frei.
Document.getAnimations(): Gibt ein Array aller Animation-Objekte zurück, die derzeit in Kraft sind, deren Zielelemente Nachkommen des Dokuments sind.
Document.getBoxQuads() Experimentell: Gibt eine Liste von DOMQuad-Objekten zurück, die die CSS-Fragmente des Knotens darstellen.
Document.getElementById(): Gibt ein Objekt zurück, das sich auf das identifizierte Element bezieht.
Document.getElementsByClassName(): Gibt eine Liste von Elementen mit dem angegebenen Klassennamen zurück.
Document.getElementsByTagName(): Gibt eine Liste von Elementen mit dem angegebenen Tag-Namen zurück.
Document.getElementsByTagNameNS(): Gibt eine Liste von Elementen mit dem angegebenen Tag-Namen und Namensraum zurück.
Document.getSelection(): Gibt ein Selection-Objekt zurück, das den vom Benutzer ausgewählten Textbereich oder die aktuelle Position der Einfügemarke darstellt.
Document.hasStorageAccess(): Gibt ein Promise zurück, das mit einem booleschen Wert erfüllt wird, der angibt, ob das Dokument Zugriff auf unparteiische Cookies hat.
Document.hasUnpartitionedCookieAccess(): Neuer Name für Document.hasStorageAccess().
Document.importNode(): Gibt einen Klon eines Knotens aus einem externen Dokument zurück.
Document.mozSetImageElement() Nicht standardisiert: Ermöglicht Ihnen, das Element zu ändern, das als Hintergrundbild für eine festgelegte Element-ID verwendet wird.
Document.prepend(): Fügt eine Menge von Node-Objekten oder Zeichenfolgen vor dem ersten Kindelement des Dokuments ein.
Document.querySelector(): Gibt das erste Elementknoten innerhalb des Dokuments zurück, in Dokumentreihenfolge, das den angegebenen Selektoren entspricht.
Document.querySelectorAll(): Gibt eine Liste aller Elementknoten innerhalb des Dokuments zurück, die den angegebenen Selektoren entsprechen.
Document.releaseCapture() Nicht standardisiert: Gibt die aktuelle Mausaufnahme frei, wenn sie sich auf einem Element in diesem Dokument befindet.
Document.releaseEvents() Veraltet: Siehe Window.releaseEvents().
Document.replaceChildren(): Ersetzt die vorhandenen Kinder eines Dokuments durch eine angegebene neue Menge von Kindern.
Document.requestStorageAccess(): Erlaubt einem Dokument, das in einem Drittanbieter-Kontext geladen wird (d. h. eingebettet in einem <iframe>), Zugriff auf unparteiische Cookies zu beantragen, in Fällen, in denen Benutzeragenten standardmäßig den Zugriff auf unparteiische Cookies durch in einem Drittanbieter-Kontext geladene Seiten blockieren, um die Privatsphäre zu verbessern.
Document.requestStorageAccessFor() Experimentell: Erlaubt Top-Level-Sites, im Namen von eingebetteten Inhalten, die von einer anderen Site derselben zusammengehörigen Website-Gruppe stammen, Zugriff auf Drittpartei-Cookies zu beantragen.
Document.startViewTransition(): Startet eine neue Ansichtstransition und gibt ein ViewTransition-Objekt zurück, um sie darzustellen.

Das Document-Interface ist mit dem XPathEvaluator-Interface erweitert:

Document.createExpression(): Übersetzt ein XPathExpression, das dann für (wiederholte) Auswertungen verwendet werden kann.
Document.createNSResolver() Veraltet: Gibt den Eingabeknoten unverändert zurück.
Document.evaluate(): Bewertet einen XPath-Ausdruck.

Erweiterung für HTML-Dokumente

Das Document-Interface für HTML-Dokumente erbt vom HTMLDocument-Interface oder wird für solche Dokumente erweitert:

Document.clear() Veraltet: Diese Methode bewirkt nichts.
Document.close(): Schließt einen Dokumentstream zum Schreiben.
Document.execCommand() Veraltet: Führt in einem editierbaren Dokument einen Formatierungsbefehl aus.
Document.getElementsByName(): Gibt eine Liste von Elementen mit dem angegebenen Namen zurück.
Document.hasFocus(): Gibt true zurück, wenn sich der Fokus derzeit irgendwo innerhalb des angegebenen Dokuments befindet.
Document.open(): Öffnet einen Dokumentstream zum Schreiben.
Document.queryCommandEnabled() Veraltet Nicht standardisiert: Gibt true zurück, wenn der Formatierungsbefehl im aktuellen Bereich ausgeführt werden kann.
Document.queryCommandIndeterm() Veraltet: Gibt true zurück, wenn der Formatierungsbefehl im aktuellen Bereich in einem unbestimmten Zustand ist.
Document.queryCommandState() Veraltet Nicht standardisiert: Gibt true zurück, wenn der Formatierungsbefehl im aktuellen Bereich ausgeführt wurde.
Document.queryCommandSupported() Veraltet Nicht standardisiert: Gibt true zurück, wenn der Formatierungsbefehl im aktuellen Bereich unterstützt wird.
Document.queryCommandValue() Veraltet: Gibt den aktuellen Wert des aktuellen Bereichs für einen Formatierungsbefehl zurück.
Document.write(): Schreibt Text in ein Dokument.
Document.writeln(): Schreibt eine Zeile Text in ein Dokument.

Statische Methoden

Dieses Interface erbt auch von den Node und EventTarget Interfaces.

Document.parseHTMLUnsafe(): Erstellt ein neues Document-Objekt aus einem HTML-String ohne Durchführung einer Überprüfung. Der String kann deklarative Schattenwurzeln enthalten.

Ereignisse

Hören Sie diese Ereignisse unter Verwendung von addEventListener() oder indem Sie einen Ereignis-Listener der oneventname-Eigenschaft dieses Interfaces zuweisen. Zusätzlich zu den unten aufgeführten Ereignissen können viele Ereignisse von Knoten stammen, die im Dokumentbaum enthalten sind.

afterscriptexecute Nicht standardisiert: Wird ausgelöst, wenn ein statisches <script>-Element das Ausführen seines Skripts abgeschlossen hat.
beforescriptexecute Nicht standardisiert: Wird ausgelöst, wenn ein statisches <script>-Element kurz davor ist, mit der Ausführung zu beginnen.
prerenderingchange Experimentell: Wird auf einem vorgerenderten Dokument ausgelöst, wenn es aktiviert wird (d. h. der Benutzer die Seite anzeigt).
securitypolicyviolation: Wird ausgelöst, wenn eine Inhaltsrichtlinie verletzt wird.
visibilitychange: Wird ausgelöst, wenn der Inhalt eines Tabs sichtbar wird oder ausgeblendet wurde.

Zwischenablage-Ereignisse

copy: Wird ausgelöst, wenn der Benutzer eine Kopieraktion über die Benutzeroberfläche des Browsers initiiert.
cut: Wird ausgelöst, wenn der Benutzer eine Ausschneideaktion über die Benutzeroberfläche des Browsers initiiert.
paste: Wird ausgelöst, wenn der Benutzer eine Einfügeaktion über die Benutzeroberfläche des Browsers initiiert.

Vollbildereignisse

fullscreenchange: Wird ausgelöst, wenn das Document in den oder aus dem Vollbildmodus wechselt.
fullscreenerror: Wird ausgelöst, wenn ein Fehler beim Versuch auftritt, in den oder aus dem Vollbildmodus zu wechseln.

Lade- und Entladeereignisse

DOMContentLoaded: Wird ausgelöst, wenn das Dokument vollständig geladen und analysiert wurde, ohne auf das Laden von Stylesheets, Bildern und Unterrahmen zu warten.
readystatechange: Wird ausgelöst, wenn sich das readyState-Attribut eines Dokuments geändert hat.

Zeigersperre-Ereignisse

pointerlockchange: Wird ausgelöst, wenn der Zeiger gesperrt/entsperrt wird.
pointerlockerror: Wird ausgelöst, wenn das Sperren des Zeigers fehlgeschlagen ist.

Scrollereignisse

scroll: Wird ausgelöst, wenn die Dokumentansicht oder ein Element gescrollt wurde.
scrollend: Wird ausgelöst, wenn die Dokumentansicht oder ein Element das Scrollen abgeschlossen hat.
scrollsnapchange Experimentell: Wird am Scroll-Container am Ende eines Scroll-Vorgangs ausgelöst, wenn ein neues Scroll-Snap-Ziel ausgewählt wurde.
scrollsnapchanging Experimentell: Wird am Scroll-Container ausgelöst, wenn der Browser ein neues Scroll-Snap-Ziel erkennt, das sich in Bearbeitung befindet, d. h. es wird ausgewählt, wenn die aktuelle Scroll-Geste endet.

Auswahlereignisse

selectionchange: Wird ausgelöst, wenn die aktuelle Textauswahl in einem Dokument geändert wurde.

Spezifikationen

Specification
DOM Standard # interface-document
HTML Standard # the-document-object
CSSOM View Module # extensions-to-the-document-interface
Pointer Lock 2.0 # extensions-to-the-document-interface
Selection API # extensions-to-document-interface

Browser-Kompatibilität

BCD tables only load in the browser