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 stellt jede im Browser geladene Webseite dar und dient als Einstiegspunkt in den Inhalt der Webseite, der der DOM-Baum ist.

Der DOM-Baum enthält Elemente wie <body> und <table>, sowie viele andere. Er bietet Funktionalitäten global für das Dokument an, wie zum Beispiel, wie man die URL der Seite erhält oder neue Elemente im Dokument erstellt.

Das Document Interface beschreibt die allgemeinen Eigenschaften und Methoden für jede Art von Dokument. Abhängig vom Dokumenttyp (z.B. HTML, XML, SVG, ...) ist eine umfangreichere API verfügbar: HTML-Dokumente, die mit dem "text/html" Content-Type bereitgestellt werden, implementieren auch 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 aktuell den Fokus hat.
Document.adoptedStyleSheets: Fügt ein Array von konstruierten Stylesheets hinzu, die vom Dokument genutzt werden sollen. 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 vom Dokument verwendete Zeichensatz zurück.
Document.childElementCount Schreibgeschützt: Gibt die Anzahl der Kindelemente des aktuellen Dokuments zurück.
Document.children Schreibgeschützt: Gibt die Kindelemente 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 gerade 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 direktes Kind des Dokuments ist. Für HTML-Dokumente ist dies normalerweise das HTMLHtmlElement Objekt, das das <html> Element des Dokuments darstellt.
Document.documentURI Schreibgeschützt: Gibt den Dokumentenort 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 Feature-Policies zurück.
Document.firstElementChild Schreibgeschützt: Gibt das erste Kindelement 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 die FragmentDirective für das aktuelle Dokument zurück.
Document.fullscreenElement Schreibgeschützt: Das Element, das derzeit im Vollbildmodus für dieses Dokument ist.
Document.head Schreibgeschützt: Gibt das <head> Element des aktuellen Dokuments zurück.
Document.hidden Schreibgeschützt: Gibt einen Boolean-Wert zurück, der anzeigt, ob die Seite als verborgen angesehen wird oder nicht.
Document.images Schreibgeschützt: Gibt eine HTMLCollection der Bilder im Dokument zurück.
Document.implementation Schreibgeschützt: Gibt die DOM-Implementierung zurück, die mit dem aktuellen Dokument assoziiert ist.
Document.lastElementChild Schreibgeschützt: Gibt das letzte Kindelement 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 dargestellt 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, solange der Zeiger gesperrt ist. null, wenn die Sperre aussteht, der Zeiger entsperrt ist oder wenn das Ziel in einem anderen Dokument ist.
Document.prerendering Schreibgeschützt Experimentell: Gibt einen Boolean zurück, der anzeigt, ob das Dokument derzeit im Prozess des Vorbereitens ist, wie durch die Speculation Rules API initiiert.
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 eingebettet oder verlinkt sind.
Document.timeline Schreibgeschützt: Gibt die Timeline als spezielle Instanz von DocumentTimeline zurück, die beim Laden der Seite automatisch erstellt wird.
Document.visibilityState Schreibgeschützt: Gibt eine Zeichenkette zurück, die den Sichtbarkeitsstatus 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 setzt diese, das gesamte Dokument zu bearbeiten.
Document.dir: Ruft die Richtung (rtl/ltr) des Dokuments ab oder setzt diese.
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: Setzt oder erhält den Titel des aktuellen Dokuments.
Document.URL Schreibgeschützt: Gibt den Dokumentenort als Zeichenkette zurück.

Veraltete Eigenschaften

Document.alinkColor Veraltet: Gibt die Farbe aktiver Links im Dokumentkörper zurück oder setzt diese.
Document.all Veraltet: Bietet Zugriff auf alle Elemente im Dokument — es gibt eine HTMLAllCollection zurück, die am 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 innerhalb eines Dokuments zurückgab.
Document.bgColor Veraltet: Ruft die Hintergrundfarbe des aktuellen Dokuments ab oder setzt diese.
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 setzt diese.
Document.fgColor Veraltet: Ruft die Vordergrundfarbe oder Textfarbe des aktuellen Dokuments ab oder setzt diese.
Document.fullscreen Veraltet: Gibt true zurück, wenn sich das Dokument im Vollbildmodus befindet.
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 zuletzt aktivierten Stylesheet-Sets zurück. Hat den Wert null, bis das Stylesheet durch das Setzen des Werts von selectedStyleSheetSet geändert wird.
Document.linkColor Veraltet: Ruft die Farbe der Hyperlinks im Dokument ab oder setzt diese.
Document.preferredStyleSheetSet Veraltet Schreibgeschützt Nicht standardisiert: Gibt das vom Seitenautor spezifizierte bevorzugte Stylesheet-Set zurück.
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 verwendet wird.
Document.styleSheetSets Veraltet Schreibgeschützt Nicht standardisiert: Gibt eine Liste der im Dokument verfügbaren Stylesheet-Sets zurück.
Document.vlinkColor Veraltet: Ruft die Farbe der besuchten Hyperlinks ab oder setzt diese.
Document.xmlEncoding Veraltet: Gibt die durch die XML-Deklaration festgelegte Kodierung zurück.
Document.xmlStandalone Veraltet: Gibt true zurück, wenn die XML-Deklaration das Dokument als eigenständig spezifiziert (z.B., Ein externer Teil der DTD beeinflusst den Inhalt des Dokuments), sonst false.
Document.xmlVersion Veraltet: Gibt die in der XML-Deklaration spezifizierte Versionsnummer zurück oder "1.0", falls die Deklaration fehlt.

Instanz-Methoden

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.adoptNode(): Übernimmt einen Knoten aus einem externen Dokument.
Document.append(): Fügt eine Menge von Node Objekten oder Zeichenketten 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 wichtigsten Themen für den Benutzer darstellen, eines aus jeder der letzten drei Epochen. Standardmäßig bewirkt die Methode auch, dass der Browser den aktuellen Seitenbesuch als vom Aufrufer beobachtet aufzeichnet, damit 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 den Cursor enthält, sowie den Zeichenversatz des Cursors innerhalb dieses Knotens.
Document.caretRangeFromPoint() Nicht standardisiert: Ruft ein Range Objekt für das zu den angegebenen Koordinaten gehörende Dokumentfragment ab.
Document.createAttribute(): Erstellt ein neues Attr Objekt und gibt es zurück.
Document.createAttributeNS(): Erstellt einen neuen Attributknoten in einem angegebenen 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 Vollbild-Element des Dokuments, im Vollbildmodus dargestellt zu werden.
Document.exitPictureInPicture(): Entfernt das Video aus dem schwebenden Bild-in-Bild-Fenster zurück zu seinem ursprünglichen Container.
Document.exitPointerLock(): Hebt die Zeigersperre auf.
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 darstellen.
Document.getElementById(): Gibt eine Objektreferenz auf das identifizierte Element zurück.
Document.getElementsByClassName(): Gibt eine Liste der Elemente mit dem angegebenen Klassennamen zurück.
Document.getElementsByTagName(): Gibt eine Liste der Elemente mit dem angegebenen Tag-Namen zurück.
Document.getElementsByTagNameNS(): Gibt eine Liste der Elemente mit dem angegebenen Tag-Namen und Namensraum zurück.
Document.getSelection(): Gibt ein Selection Objekt zurück, das den Bereich des vom Benutzer ausgewählten Textes oder die aktuelle Position des Cursors darstellt.
Document.hasStorageAccess(): Gibt eine Promise zurück, die mit einem Boolean-Wert erfüllt wird, der angibt, ob das Dokument Zugriff auf unpartitionierte 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: Erlaubt 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 Zeichenketten vor dem ersten Kind des Dokuments ein.
Document.querySelector(): Gibt den ersten Elementknoten im Dokument in Dokumentreihenfolge zurück, der die angegebenen Selektoren erfüllt.
Document.querySelectorAll(): Gibt eine Liste aller Elementknoten im Dokument zurück, die den angegebenen Selektoren entsprechen.
Document.releaseCapture() Nicht standardisiert: Gibt die aktuelle Maus-Capture frei, wenn sie auf ein Element in diesem Dokument ausgeführt ist.
Document.releaseEvents() Veraltet: Siehe Window.releaseEvents().
Document.replaceChildren(): Ersetzt die vorhandenen Kinder eines Dokuments durch eine angegebene neue Menge von Kindern.
Document.requestStorageAccess(): Ermöglicht einem Dokument, das in einem Drittanbieterkontext geladen ist (d. h. eingebettet in einem <iframe>), den Zugriff auf unpartitionierte Cookies zu beantragen, in Fällen, in denen Benutzeragenten standardmäßig den Zugriff auf unpartitionierte Cookies von Websites, die in einem Drittanbieterkontext geladen sind, sperren, um die Privatsphäre zu verbessern.
Document.requestStorageAccessFor() Experimentell: Erlaubt Top-Level-Sites, den Drittanbieter-Cookie-Zugriff im Namen von eingebetteten Inhalten zu beantragen, die von einer anderen Website in demselben zusammengehörigen Website-Set stammen.
Document.startViewTransition(): Startet einen neuen View-Übergang und gibt ein ViewTransition Objekt zurück, um diesen darzustellen.

Das Document Interface wird mit dem XPathEvaluator Interface erweitert:

Document.createExpression(): Kompiliert einen XPathExpression, der dann für (wiederholte) Auswertungen verwendet werden kann.
Document.createNSResolver() Veraltet: Gibt den Eingabeknoten unverändert zurück.
Document.evaluate(): Wertet einen XPath-Ausdruck aus.

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 editierbaren 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 auf den aktuellen Bereich ausgeführt werden kann.
Document.queryCommandIndeterm() Veraltet: Gibt true zurück, wenn der Formatierungsbefehl auf den aktuellen Bereich in einem unbestimmten Zustand ist.
Document.queryCommandState() Veraltet Nicht standardisiert: Gibt true zurück, wenn der Formatierungsbefehl auf den aktuellen Bereich ausgeführt wurde.
Document.queryCommandSupported() Veraltet Nicht standardisiert: Gibt true zurück, wenn der Formatierungsbefehl auf den 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(): Schreibt eine Textzeile in ein Dokument.

Statische Methoden

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.parseHTMLUnsafe(): Erstellt ein neues Document-Objekt aus einer HTML-Zeichenkette, ohne eine Bereinigung durchzuführen. Die Zeichenkette kann deklarative Shadow-Wurzeln enthalten.

Ereignisse

Diese Ereignisse können unter Verwendung von addEventListener() gehört werden oder indem ein Ereignis-Listener der oneventname Eigenschaft dieses Interfaces zugewiesen wird. Zusätzlich zu den unten aufgeführten Ereignissen können viele Ereignisse aus Knoten stammen, 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 das Ausführen beginnt.
prerenderingchange Experimentell: Wird auf einem vorbereiteten Dokument ausgelöst, wenn es aktiviert wird (d.h. der Benutzer die Seite anzeigt).
securitypolicyviolation: Wird ausgelöst, wenn eine Inhalts-Sicherheitsrichtlinie verletzt wird.
visibilitychange: Wird ausgelöst, wenn der Inhalt eines Tabs sichtbar wird oder verborgen wurde.

Zwischenablagen-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 Schneideaktion ü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 Vollbild Modus wechselt.
fullscreenerror: Wird ausgelöst, wenn ein Fehler beim Versuch auftritt, in den oder aus dem Vollbild Modus zu wechseln.

Lade- und Unload-Ereignisse

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 das readyState Attribut eines Dokuments sich geändert hat.

Zeigersperre-Ereignisse

pointerlockchange: Wird ausgelöst, wenn der Zeiger gesperrt/freigegeben wird.
pointerlockerror: Wird ausgelöst, wenn die Zeigersperre fehlschlug.

Scroll-Ereignisse

scroll: Wird ausgelöst, wenn die Dokumentenansicht oder ein Element gescrollt wurde.
scrollend: Wird ausgelöst, wenn die Dokumentenansicht oder ein Element das Scrollen abgeschlossen hat.
scrollsnapchange Experimentell: Wird auf dem Scroll-Container am Ende eines Scrollvorgangs ausgelöst, wenn ein neues Scroll-Snap-Ziel ausgewählt wurde.
scrollsnapchanging Experimentell: Wird auf dem Scroll-Container ausgelöst, wenn der Browser ein neues, anstehendes Scroll-Snap-Ziel bestimmt, d.h. es wird ausgewählt, wenn die aktuelle Scrollgeste endet.

Auswahl-Ereignisse

selectionchange: Wird ausgelöst, wenn die aktuelle Textauswahl eines Dokuments geändert wird.

Gebubberte Ereignisse

Nicht alle Ereignisse, die gebubbelt werden, können das Document Objekt erreichen. Nur die folgenden können gehö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

Browser-Kompatibilität

BCD tables only load in the browser