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.

* Some parts of this feature may have varying levels of support.

Das Document-Interface repräsentiert jede Webseite, die im Browser geladen ist, und dient als Einstiegspunkt in den Inhalt der Webseite, welche den DOM-Baum darstellt.

Der DOM-Baum umfasst Elemente wie <body> und <table> neben vielen anderen. Er bietet Funktionalitäten global für das Dokument, wie zum Beispiel, wie man die URL der Seite erhält und neue Elemente im Dokument erstellt.

Das Document-Interface beschreibt die gemeinsamen Eigenschaften und Methoden für alle Arten von Dokumenten. Abhängig vom Dokumenttyp (z.B. HTML, XML, SVG, …) ist eine umfangreichere API verfügbar: HTML-Dokumente, die mit dem Inhaltstyp "text/html" geliefert werden, implementieren ebenfalls das HTMLDocument-Interface, während XML- und SVG-Dokumente das XMLDocument-Interface implementieren.

Konstruktor

Document(): Erstellt ein neues Document-Objekt.

Instanz-Eigenschaften

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.activeElement Schreibgeschützt: Gibt das Element zurück, das derzeit den Fokus hat.
Document.adoptedStyleSheets: Fügt dem Dokument ein Array von konstruierten Stylesheets hinzu. Diese Stylesheets können auch mit Shadow DOM Unterbäumen desselben Dokuments geteilt werden.
Document.body: Gibt den <body>- oder <frameset>-Knoten des aktuellen Dokuments zurück.
Document.characterSet Schreibgeschützt: Gibt das Zeichensatz zurück, das vom Dokument verwendet wird.
Document.childElementCount Schreibgeschützt: Gibt die Anzahl der Kind-Elemente des aktuellen Dokuments zurück.
Document.children Schreibgeschützt: Gibt die Kind-Elemente des aktuellen Dokuments zurück.
Document.compatMode Schreibgeschützt: Gibt an, ob das Dokument im Quirks- oder Strict-Modus gerendert wird.
Document.contentType Schreibgeschützt: Gibt den Content-Type aus dem MIME-Header des aktuellen Dokuments zurück.
Document.currentScript Schreibgeschützt: Gibt das <script>-Element zurück, dessen Skript derzeit verarbeitet wird und kein JavaScript-Modul ist.
Document.doctype Schreibgeschützt: Gibt die Document Type Definition (DTD) des aktuellen Dokuments zurück.
Document.documentElement Schreibgeschützt: Gibt das Element zurück, das ein direkter Nachfolger des Dokuments ist. Bei HTML-Dokumenten ist dies normalerweise das HTMLHtmlElement-Objekt, das das <html>-Element des Dokuments repräsentiert.
Document.documentURI Schreibgeschützt: Gibt den Dokumentstandort als Zeichenkette zurück.
Document.embeds Schreibgeschützt: Gibt eine HTMLCollection der eingebetteten <embed>-Elemente im Dokument zurück.
Document.featurePolicy Experimentell Schreibgeschützt: Gibt das FeaturePolicy- Interface mit den auf das Dokument angewendeten Funktionsrichtlinien zurück.
Document.firstElementChild Schreibgeschützt: Gibt das erste Kind-Element des aktuellen Dokuments zurück.
Document.fonts: Gibt das FontFaceSet-Interface des aktuellen Dokuments zurück.
Document.forms Schreibgeschützt: Gibt eine HTMLCollection der <form>-Elemente im Dokument zurück.
Document.fragmentDirective Schreibgeschützt: Gibt das FragmentDirective für das aktuelle Dokument zurück.
Document.fullscreenElement Schreibgeschützt: Das Element, das sich derzeit im Vollbildmodus für dieses Dokument befindet.
Document.head Schreibgeschützt: Gibt das <head>-Element des aktuellen Dokuments zurück.
Document.hidden Schreibgeschützt: Gibt einen Booleschen Wert zurück, der angibt, ob die Seite als versteckt betrachtet wird oder nicht.
Document.images Schreibgeschützt: Gibt eine HTMLCollection der Bilder im Dokument zurück.
Document.implementation Schreibgeschützt: Gibt die dem aktuellen Dokument zugeordnete DOM-Implementierung zurück.
Document.lastElementChild Schreibgeschützt: Gibt das letzte Kind-Element des aktuellen Dokuments zurück.
Document.links Schreibgeschützt: Gibt eine HTMLCollection der Hyperlinks im Dokument zurück.
Document.pictureInPictureElement Schreibgeschützt: Gibt das Element zurück, das derzeit im Bild-in-Bild-Modus in diesem Dokument präsentiert wird.
Document.pictureInPictureEnabled Schreibgeschützt: Gibt true zurück, wenn die Bild-in-Bild-Funktion aktiviert ist.
Document.plugins Schreibgeschützt: Gibt eine HTMLCollection der verfügbaren Plugins zurück.
Document.pointerLockElement Schreibgeschützt: Gibt das Element zurück, das als Ziel für Mausereignisse festgelegt ist, während der Zeiger gesperrt ist. null, wenn die Sperrung aussteht, der Zeiger entsperrt ist oder wenn sich das Ziel in einem anderen Dokument befindet.
Document.prerendering Schreibgeschützt Experimentell: Gibt einen Booleschen Wert zurück, der angibt, ob das Dokument derzeit im Prozess des Prerendings ist, wie es über die Speculation Rules API initiiert wurde.
Document.scripts Schreibgeschützt: Gibt eine HTMLCollection der <script>-Elemente im Dokument zurück.
Document.scrollingElement Schreibgeschützt: Gibt eine Referenz auf das Element zurück, das das Dokument scrollt.
Document.styleSheets Schreibgeschützt: Gibt eine StyleSheetList von CSSStyleSheet-Objekten für Stylesheets zurück, die explizit in ein Dokument eingebunden oder eingebettet sind.
Document.timeline Schreibgeschützt: Gibt Timeline als spezielle Instanz von DocumentTimeline zurück, die beim Laden der Seite automatisch erstellt wird.
Document.visibilityState Schreibgeschützt: Gibt einen string zurück, der den Sichtbarkeitszustand des Dokuments angibt. 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 Schreibgeschützt: Gibt eine Referenz auf das Fensterobjekt zurück.
Document.designMode: Ruft die Fähigkeit ab oder legt fest, das gesamte Dokument zu bearbeiten.
Document.dir: Ruft die Richtung (rtl/ltr) des Dokuments ab oder legt diese fest.
Document.fullscreenEnabled Schreibgeschützt: Gibt an, ob der Vollbildmodus verfügbar ist.
Document.lastModified Schreibgeschützt: Gibt das Datum zurück, an dem das Dokument zuletzt geändert wurde.
Document.location Schreibgeschützt: Gibt die URI des aktuellen Dokuments zurück.
Document.readyState Schreibgeschützt: Gibt den Ladezustand des Dokuments zurück.
Document.referrer Schreibgeschützt: Gibt die URI der Seite zurück, die auf diese Seite verwiesen hat.
Document.title: Ruft den Titel des aktuellen Dokuments ab oder legt ihn fest.
Document.URL Schreibgeschützt: Gibt den Dokumentstandort als Zeichenkette zurück.

Veraltete Eigenschaften

Document.alinkColor Veraltet: Gibt die Farbe der aktiven Links im Dokumentenbody zurück oder setzt sie.
Document.all Veraltet: Bietet Zugriff auf alle Elemente im Dokument — es gibt ein HTMLAllCollection zurück, das an der Dokumentknoten verwurzelt ist. Dies ist eine veraltete, nicht standardisierte Eigenschaft und sollte nicht verwendet werden.
Document.anchors Veraltet Schreibgeschützt: Gibt eine Liste aller Anker im Dokument zurück.
Document.applets Veraltet Schreibgeschützt: Gibt eine leere HTMLCollection zurück. Eine veraltete Eigenschaft, die früher die Liste der Applets in einem Dokument zurückgab.
Document.bgColor Veraltet: Ruft die Hintergrundfarbe des aktuellen Dokuments ab oder legt sie fest.
Document.charset Veraltet Schreibgeschützt: Alias von Document.characterSet. Verwenden Sie stattdessen diese Eigenschaft.
Document.domain Veraltet: Ruft die Domain des aktuellen Dokuments ab oder legt sie fest.
Document.fgColor Veraltet: Ruft die Vordergrundfarbe oder Textfarbe des aktuellen Dokuments ab oder legt sie fest.
Document.fullscreen Veraltet: Gibt true zurück, wenn das Dokument im Vollbildmodus ist.
Document.inputEncoding Veraltet Schreibgeschützt: Alias von Document.characterSet. Verwenden Sie stattdessen diese Eigenschaft.
Document.lastStyleSheetSet Veraltet Schreibgeschützt Nicht standardisiert: Gibt den Namen des letzten aktivierten Stylesheet-Sets zurück. Hat den Wert null, bis das Stilesheet durch Setzen des Werts von selectedStyleSheetSet geändert wird.
Document.linkColor Veraltet: Ruft die Farbe der Hyperlinks im Dokument ab oder legt sie fest.
Document.preferredStyleSheetSet Veraltet Schreibgeschützt Nicht standardisiert: Gibt das bevorzugte Stylesheet-Set zurück, wie es vom Seitenautor angegeben wurde.
Document.rootElement Veraltet: Ähnlich wie Document.documentElement, jedoch nur für <svg>-Wurzelelemente. Verwenden Sie diese Eigenschaft stattdessen.
Document.selectedStyleSheetSet Veraltet Nicht standardisiert: Gibt das zurzeit verwendete Stylesheet-Set zurück.
Document.styleSheetSets Veraltet Schreibgeschützt Nicht standardisiert: Gibt eine Liste der auf dem Dokument verfügbaren Stylesheet-Sets zurück.
Document.vlinkColor Veraltet: Ruft die Farbe besuchter Hyperlinks ab oder legt sie fest.
Document.xmlEncoding Veraltet: Gibt die Kodierung gemäß der XML-Deklaration zurück.
Document.xmlStandalone Veraltet: Gibt true zurück, wenn die XML-Deklaration angibt, dass das Dokument eigenständig ist (z.B., ein externer Teil der DTD wirkt sich auf den Inhalt des Dokuments aus), andernfalls false.
Document.xmlVersion Veraltet: Gibt die Versionsnummer zurück, wie in der XML-Deklaration angegeben oder "1.0", wenn die Deklaration fehlt.

Instanz-Methoden

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.adoptNode(): Übernimmt einen Knoten von einem externen Dokument.
Document.append(): Fügt eine Menge von Node-Objekten oder Zeichenfolgen nach dem letzten Kind 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 Benutzer repräsentieren, eines aus jeder der letzten drei Epochen. Standardmäßig verursacht die Methode außerdem, 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: Gibt ein Range-Objekt für das Dokumentfragment unter den angegebenen Koordinaten zurück.
Document.createAttribute(): Erstellt ein neues Attr-Objekt und gibt es zurück.
Document.createAttributeNS(): Erstellt einen neuen Attributknoten in einem gegebenen Namensraum und gibt ihn 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 einen 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(): Stoppt das Dokument, das im Vollbildmodus angezeigt wird.
Document.exitPictureInPicture(): Entfernt das Video aus dem schwebenden Bild-im-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 und deren Zielelemente Nachkommen des Dokuments sind.
Document.getBoxQuads() Experimentell: Gibt eine Liste von DOMQuad-Objekten zurück, die die CSS-Fragmente des Knotens repräsentieren.
Document.getElementById(): Gibt eine Objektreferenz auf das identifizierte Element zurück.
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 Zugang zu nicht partitionierten Cookies hat.
Document.hasUnpartitionedCookieAccess(): Neuer Name für Document.hasStorageAccess().
Document.importNode(): Gibt eine Kopie eines Knotens von einem externen Dokument zurück.
Document.moveBefore() Experimentell: Verschiebt einen gegebenen Node innerhalb des Document-DOM-Knotens als Direktkind vor einen gegebenen Referenzknoten, ohne den Knoten zu entfernen und dann einzufügen.
Document.mozSetImageElement() Nicht standardisiert: Ermöglicht es Ihnen, das Element zu ändern, das als Hintergrundbild für eine angegebene Element-ID verwendet wird.
Document.prepend(): Fügt eine Menge von Node-Objekten oder Zeichenfolgen vor dem ersten Kind des Dokuments ein.
Document.querySelector(): Gibt den ersten Elementknoten im Dokument in Dokumentreihenfolge zurück, der 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 Mausaufzeichnung frei, falls sie sich auf ein Element in diesem Dokument bezieht.
Document.releaseEvents() Veraltet: Siehe Window.releaseEvents().
Document.replaceChildren(): Ersetzt die vorhandenen Kinder eines Dokuments durch einen angegebenen neuen Satz von Kindern.
Document.requestStorageAccess(): Ermöglicht es einem Dokument, das in einem Drittanbieter-Kontext geladen wird (d.h. eingebettet in ein <iframe>), Zugriff auf nicht partitionierte Cookies zu beantragen, in Fällen, in denen Benutzeragenten standardmäßig den Zugriff auf nicht partitionierte Cookies von in einem Drittanbieter-Kontext geladenen Websites blockieren, um die Privatsphäre zu verbessern.
Document.requestStorageAccessFor() Experimentell: Ermöglicht es Top-Level-Sites, den Zugriff auf Drittanbieter-Cookies im Namen von eingebetteten Inhalten, die von einer anderen Site im gleichen related website set stammen, anzufordern.
Document.startViewTransition(): Startet einen neuen Ansichtstransition und gibt ein ViewTransition-Objekt zurück, um diese zu repräsentieren.

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

Document.createExpression(): Kompiliert einen XPathExpression, der dann für (wiederholte) Bewertungen 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 tut nichts.
Document.close(): Schließt einen Dokumentstream zum Schreiben.
Document.execCommand() Veraltet: Führt in einem bearbeitbaren Dokument einen Formatierungsbefehl aus.
Document.getElementsByName(): Gibt eine Liste der Elemente mit dem angegebenen Namen zurück.
Document.hasFocus(): Gibt true zurück, wenn der Fokus derzeit irgendwo innerhalb des angegebenen Dokuments liegt.
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 einen unbestimmten Zustand hat.
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() Veraltet: Schreibt Text in ein Dokument.
Document.writeln() Veraltet: Schreibt eine Textzeile in ein Dokument.

Statische Methoden

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.parseHTML(): Erstellt ein neues Document-Objekt aus einer Zeichenkette von HTML auf eine XSS-sichere Weise mit Bereinigung.
Document.parseHTMLUnsafe(): Erstellt ein neues Document-Objekt aus einer Zeichenkette von HTML, ohne Bereinigung auszuführen. Die Zeichenkette kann deklarative Schattenwurzeln enthalten.

Ereignisse

Diese Ereignisse können mit addEventListener() abgehört werden, oder indem Sie einen Ereignis-Listener auf die oneventname-Eigenschaft dieses Interfaces zuweisen. Zusätzlich zu den unten aufgeführten Ereignissen können viele Ereignisse von Knoten ausgehen, die im Dokumentbaum enthalten sind.

afterscriptexecute Nicht standardisiert Veraltet: Wird ausgelöst, wenn ein statisches <script>-Element das Ausführen seines Skripts beendet.
beforescriptexecute Nicht standardisiert Veraltet: Wird ausgelöst, wenn ein statisches <script>-Element gerade das Ausführen beginnt.
prerenderingchange Experimentell: Wird in einem vorgerenderten Dokument ausgelöst, wenn es aktiviert wird (d.h. der Benutzer die Seite ansieht).
securitypolicyviolation: Wird ausgelöst, wenn eine Content-Security-Policy verletzt wird.
visibilitychange: Wird ausgelöst, wenn der Inhalt eines Registers sichtbar geworden ist oder verborgen wurde.

Vollbild-Ereignisse

fullscreenchange: Wird ausgelöst, wenn das Document in den Vollbildmodus wechselt oder diesen verlässt.
fullscreenerror: Wird ausgelöst, wenn ein Fehler auftritt, während versucht wird, in den Vollbildmodus zu wechseln oder diesen zu verlassen.

Lade- & Entladeereignisse

DOMContentLoaded: Wird ausgelöst, wenn das Dokument vollständig geladen und geparst wurde, ohne darauf zu warten, dass Stylesheets, Bilder und Unterelemente das Laden abgeschlossen haben.
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 Scrollcontainer am Ende einer Scrolloperation ausgelöst, wenn ein neues Scroll-Snap-Ziel ausgewählt wurde.
scrollsnapchanging Experimentell: Wird am Scrollcontainer ausgelöst, wenn der Browser feststellt, dass ein neues Scroll-Snap-Ziel aussteht, d.h. es wird ausgewählt, wenn die aktuelle Scrollgeste endet.

Auswahlerereignisse

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

Geblähte Ereignisse

Nicht alle Ereignisse, die gebläht werden, können das Document-Objekt erreichen. Nur die folgenden tun dies und können auf dem Document-Objekt abgehört werden:

Spezifikationen

Specification
DOM # interface-document
HTML # 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