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 Webseite, die im Browser geladen wird und dient als Einstiegspunkt in den Inhalt der Webseite, das ist der DOM-Baum.

Der DOM-Baum umfasst Elemente wie <body> und <table>, neben vielen anderen. Es bietet global Funktionen für das Dokument, wie den Erhalt 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 Dokumenttyp (z.B. HTML, XML, SVG, …) steht eine größere API zur Verfügung: HTML-Dokumente, die mit dem "text/html"-Inhaltstyp 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 verwendet werden sollen. Diese Stylesheets können auch mit Shadow-DOM-Subtrees desselben Dokuments geteilt werden.
Document.body: Gibt den <body>- oder <frameset>-Knoten des aktuellen Dokuments zurück.
Document.characterSet Schreibgeschützt: Gibt das Zeichen-Set zurück, das vom Dokument verwendet wird.
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 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 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 Dokumentenstandort 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 das FragmentDirective für das aktuelle Dokument zurück.
Document.fullscreenElement Schreibgeschützt: Das Element, das in diesem Dokument derzeit im Vollbildmodus angezeigt wird.
Document.head Schreibgeschützt: Gibt das <head>-Element des aktuellen Dokuments zurück.
Document.hidden Schreibgeschützt: Gibt einen Boolean-Wert zurück, der angibt, ob die Seite als verborgen betrachtet 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 verbunden 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-im-Bild-Modus in diesem Dokument präsentiert wird.
Document.pictureInPictureEnabled Schreibgeschützt: Gibt true zurück, wenn die Bild-im-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 Sperre in Bearbeitung, der Zeiger entsperrt ist oder wenn sich das Ziel in einem anderen Dokument befindet.
Document.prerendering Schreibgeschützt Experimentell: Gibt einen Boolean zurück, der angibt, ob das Dokument derzeit im Prerendering-Prozess ist, so wie er ü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 einem Dokument verlinkt oder eingebettet sind.
Document.timeline Schreibgeschützt: Gibt die Zeitachse als spezielle Instanz von DocumentTimeline zurück, die beim Laden der Seite automatisch erstellt wird.
Document.visibilityState Schreibgeschützt: Gibt eine string 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: Holt/Setzt die Möglichkeit, das gesamte Dokument zu bearbeiten.
Document.dir: Holt/Setzt die Richtungsangabe (rtl/ltr) des Dokuments.
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 verlinkt hat.
Document.title: Setzt oder holt den Titel des aktuellen Dokuments.
Document.URL Schreibgeschützt: Gibt den Dokumentenstandort als Zeichenkette zurück.

Veraltete Eigenschaften

Document.alinkColor Veraltet: Gibt zurück oder setzt die Farbe aktiver Links im Dokumentenkörper.
Document.all Veraltet: Bietet Zugriff auf alle Elemente im Dokument — es gibt eine HTMLAllCollection zurück, die im Dokumentenknoten verwurzelt ist. Diese Eigenschaft ist veraltet, nicht standardisiert 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ückgegeben hat.
Document.bgColor Veraltet: Holt/Setzt die Hintergrundfarbe des aktuellen Dokuments.
Document.charset Veraltet Schreibgeschützt: Alias von Document.characterSet. Verwenden Sie stattdessen diese Eigenschaft.
Document.domain Veraltet: Holt/Setzt die Domain des aktuellen Dokuments.
Document.fgColor Veraltet: Holt/Setzt die Vordergrundfarbe oder Textfarbe des aktuellen Dokuments.
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 Einstellen des Wertes von selectedStyleSheetSet geändert wird.
Document.linkColor Veraltet: Holt/Setzt die Farbe von Hyperlinks im Dokument.
Document.preferredStyleSheetSet Veraltet Schreibgeschützt Nicht standardisiert: Gibt das vom Seitenautor bevorzugte Stylesheet-Set zurück.
Document.rootElement Veraltet: Ähnlich wie Document.documentElement, aber nur für <svg>-Root-Elemente. 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: Holt/Setzt die Farbe von besuchten Hyperlinks.
Document.xmlEncoding Veraltet: Gibt die Kodierung zurück, wie sie in der XML-Deklaration bestimmt wurde.
Document.xmlStandalone Veraltet: Gibt true zurück, wenn die XML-Deklaration angibt, dass das Dokument eigenständig ist (z.B., Wenn ein externer Teil der DTD den Inhalt des Dokuments beeinflusst), andernfalls false.
Document.xmlVersion Veraltet: Gibt die in der XML-Deklaration angegebene Versionsnummer zurück oder "1.0", wenn die Deklaration fehlt.

Instanz-Methoden

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.adoptNode(): Adoptiert ein 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, das die Top-Themen für den Nutzer repräsentiert, eines aus jedem der letzten drei Epochen. Standardmäßig führt die Methode auch dazu, dass der Browser den aktuellen Seitenbesuch aufzeichnet, wie vom Aufrufer beobachtet, so dass der Hostname der Seite später in der Themensberechnung verwendet werden kann. Weitere Details finden Sie in der Topics API.
Document.captureEvents() Veraltet: Siehe Window.captureEvents.
Document.caretPositionFromPoint(): Gibt ein CaretPosition-Objekt zurück, das den DOM-Knoten mit der Cursorposition enthält und den Zeichenoffset des Cursors innerhalb dieses Knotens.
Document.caretRangeFromPoint() Nicht standardisiert: Holt ein Range-Objekt für den Dokumentenabschnitt unter den angegebenen Koordinaten.
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 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(): Beendet die Fullscreen-Anzeige des Dokumentelements.
Document.exitPictureInPicture(): Entfernt das Video aus dem schwimmenden Bild-im-Bild-Fenster zurück in seinen ursprünglichen Container.
Document.exitPointerLock(): Löst die Zeigersperre.
Document.getAnimations(): Gibt ein Array von allen Animation-Objekten zurück, die derzeit in Wirkung sind und deren Ziel-Elemente 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 Objekt-Referenz 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 vom Benutzer ausgewählten Textbereich repräsentiert, oder der aktuellen Position des Cursors.
Document.hasStorageAccess(): Gibt ein Promise zurück, das mit einem Boolean-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 aus einem externen Dokument zurück.
Document.mozSetImageElement() Nicht standardisiert: Ermöglicht es Ihnen, das Element zu ändern, das als Hintergrundbild für eine bestimmte 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 das erste Element-Knoten innerhalb des Dokuments in Document-Order zurück, das den angegebenen Selektoren entspricht.
Document.querySelectorAll(): Gibt eine Liste aller Element-Knoten innerhalb des Dokuments zurück, die den angegebenen Selektoren entsprechen.
Document.releaseCapture() Nicht standardisiert: Löst die aktuelle Mausaufnahme, wenn sie sich auf einem Element in diesem Dokument befindet.
Document.releaseEvents() Veraltet: Siehe Window.releaseEvents().
Document.replaceChildren(): Ersetzt die bestehenden Kinder eines Dokuments durch eine spezifizierte neue Menge von Kindern.
Document.requestStorageAccess(): Erlaubt einem in einem Drittanbieter-Kontext geladenen Dokument (z.B. eingebettet in einem <iframe>), Zugriff auf nicht partitionierte Cookies zu beantragen, in Fällen, in denen Benutzeragenten standardmäßig den Zugriff auf nicht partitionierte Cookies durch Websites, die in einem Drittanbieter-Kontext geladen werden, blockieren, um die Privatsphäre zu verbessern.
Document.requestStorageAccessFor() Experimentell: Erlaubt Top-Level-Websites, Drittanbieter-Cookie-Zugriff im Auftrag von eingebetteten Inhalten zu beantragen, die von einer anderen Website im gleichen zusammenhängenden Website-Set stammen.
Document.startViewTransition(): Startet eine neue Ansichtsübergang und gibt ein ViewTransition-Objekt zurück, das ihn repräsentiert.

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

Document.createExpression(): Kompiliert 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 tut nichts.
Document.close(): Schließt einen Dokumenten-Stream zum Schreiben.
Document.execCommand() Veraltet: Führt bei 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 sich derzeit irgendwo innerhalb des angegebenen Dokuments befindet.
Document.open(): Öffnet einen Dokumenten-Stream 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() Veraltet: Schreibt Text in ein Dokument.
Document.writeln(): Schreibt eine Zeile Text in ein Dokument.

Statische Methoden

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.parseHTMLUnsafe(): Erstellt ein neues Document-Objekt aus einem HTML-String ohne Durchführung einer Bereinigung. Der String kann deklarative Shadow Roots enthalten.

Ereignisse

Hören Sie diese Ereignisse mit addEventListener() oder durch Zuweisung eines Ereignislisteners zur oneventname-Eigenschaft dieses Interfaces ab. Zusätzlich zu den unten aufgelisteten 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 beendet
beforescriptexecute Nicht standardisiert: Wird ausgelöst, wenn ein statisches <script>-Element dabei ist, mit der Ausführung zu beginnen.
prerenderingchange Experimentell: Wird auf einem prerenderten 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 Tabs sichtbar geworden ist oder ausgeblendet wurde.

Zwischenablagenereignisse

copy: Wird ausgelöst, wenn der Benutzer einen Kopiervorgang über die Benutzeroberfläche des Browsers initiiert.
cut: Wird ausgelöst, wenn der Benutzer einen Ausschneidevorgang über die Benutzeroberfläche des Browsers initiiert.
paste: Wird ausgelöst, wenn der Benutzer einen Einfügevorgang über die Benutzeroberfläche des Browsers initiiert.

Ereignisse im Zusammenhang mit Vollbildmodus

fullscreenchange: Wird ausgelöst, wenn das Document in den oder aus dem Vollbild-Modus wechselt.
fullscreenerror: Wird ausgelöst, wenn ein Fehler auftritt, während versucht wird, in den oder aus dem Vollbild-Modus zu wechseln.

Lade- und Entladeereignisse

DOMContentLoaded: Wird ausgelöst, wenn das Dokument vollständig geladen und geparst wurde, ohne darauf zu warten, dass Stylesheets, Bilder und Unterrahmen das Laden abschließen.
readystatechange: Wird ausgelöst, wenn das readyState-Attribut eines Dokuments sich geändert hat.

Ereignisse der Zeigersperre

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

Bildlaufereignisse

scroll: Wird ausgelöst, wenn die Dokumentenansicht oder ein Element gescrollt wurde.
scrollend: Wird ausgelöst, wenn das Scrollen der Dokumentenansicht oder eines Elements abgeschlossen ist.
scrollsnapchange Experimentell: Wird am Scrollcontainer am Ende eines Scrollvorgangs 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 in Erwartung ist, d.h. es wird ausgewählt, wenn die aktuelle Scrollgeste endet.

Auswahlerereignisse

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

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