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

Der DOM-Baum umfasst Elemente wie <body> und <table>, neben vielen anderen. Er bietet global Funktionalitäten für das Dokument, wie beispielsweise, um die URL der Seite abzurufen und neue Elemente im Dokument zu erstellen.

Das Document Interface beschreibt die gemeinsamen Eigenschaften und Methoden für jede Art von Dokument. Abhängig von der Art des Dokuments (z.B. HTML, XML, SVG, …) steht eine umfangreichere API zur Verfügung: HTML-Dokumente, die mit dem Content-Typ "text/html" bereitgestellt werden, implementieren auch das HTMLDocument Interface, während XML- und SVG-Dokumente das XMLDocument Interface implementieren.

Konstruktor

Document(): Erzeugt ein neues Document Objekt.

Instanzeigenschaften

Dieses Interface erbt auch von den Interfaces Node und EventTarget.

Document.activeElement Schreibgeschützt: Gibt das Element zurück, welches derzeit den Fokus hat.
Document.adoptedStyleSheets: Fügt ein Array von konstruierten Stylesheets hinzu, das vom Dokument genutzt werden soll. Diese Stylesheets können auch mit Shadow-DOM-Teilbäumen des gleichen Dokuments geteilt werden.
Document.body: Gibt den <body> oder <frameset> Knoten des aktuellen Dokuments zurück.
Document.characterSet Schreibgeschützt: Gibt den Zeichensatz zurück, der 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 Script gerade verarbeitet wird und das 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 Kindelement 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 Speicherort des Dokuments als string 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 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 des aktuellen Dokuments zurück.
Document.fullscreenElement Schreibgeschützt: Das Element, das sich aktuell 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 Boolean-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 mit dem aktuellen Dokument verbundene DOM-Implementierung zurück.
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 angezeigt 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 wurde, während 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 Prerenderings ist, wie vom Speculation Rules API initiiert.
Document.scripts Schreibgeschützt: Gibt eine HTMLCollection der <script> Elemente im Dokument zurück.
Document.scrollingElement Schreibgeschützt: Gibt einen Verweis 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 die Zeitachse als spezielle Instanz von DocumentTimeline zurück, die automatisch beim Laden der Seite erstellt wird.
Document.visibilityState Schreibgeschützt: Gibt einen string zurück, der 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 Liste der Cookies für dieses Dokument zurück, getrennt durch Semikolons, oder setzt ein einzelnes Cookie.
Document.defaultView Schreibgeschützt: Gibt einen Verweis auf das Fensterobjekt zurück.
Document.designMode: Holt/setzt die Fähigkeit, das gesamte Dokument zu bearbeiten.
Document.dir: Holt/setzt die Richtung (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 die Dokumentposition als String zurück.

Veraltete Eigenschaften

Document.alinkColor Veraltet: Gibt die Farbe der aktiven 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 verankert ist. Dies ist eine alte, 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ü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 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 zuletzt aktivierten Style Sheet Sets zurück. Hat den Wert null, bis das Stylesheet geändert wird, indem der Wert von selectedStyleSheetSet gesetzt wird.
Document.linkColor Veraltet: Holt/setzt die Farbe der Hyperlinks im Dokument.
Document.preferredStyleSheetSet Veraltet Schreibgeschützt Nicht standardisiert: Gibt das bevorzugte Style Sheet 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 das aktuell verwendete Style Sheet Set zurück.
Document.styleSheetSets Veraltet Schreibgeschützt Nicht standardisiert: Gibt eine Liste der im Dokument verfügbaren Style Sheet 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 festgelegt ist.
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 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 Interfaces Node und EventTarget.

Document.adoptNode(): Adoptiert einen Knoten aus einem externen Dokument.
Document.append(): Fügt eine Menge von Node Objekten oder Strings nach dem letzten Kind des Dokuments ein.
Document.browsingTopics() Experimentell Nicht standardisiert: Gibt ein Promise zurück, das sich mit einem Array von Objekten erfüllt, die die Top-Themen für den Benutzer darstellen, eines aus jeder der letzten drei Epochen. Standardmäßig führt die Methode auch dazu, dass der Browser den aktuellen Seitenbesuch wie vom Anrufer beobachtet aufzeichnet, sodass der Hostname der Seite später in der Themenberechnung verwendet werden kann. Weitere Informationen finden Sie in der Topics API.
Document.captureEvents() Veraltet: Siehe Window.captureEvents.
Document.caretPositionFromPoint(): Gibt ein CaretPosition Objekt zurück, das den DOM-Knoten enthält, der den Caret enthält, und den Zeichenversatz des Carets innerhalb dieses Knotens.
Document.caretRangeFromPoint() Nicht standardisiert: Holt ein Range Objekt für das Dokumentfragment unter den angegebenen Koordinaten.
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 Kommentar-Knoten 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 Namespace-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 Style Sheet Set.
Document.exitFullscreen(): Beendet die Anzeige des Vollbild-Elements des Dokuments im Vollbildmodus.
Document.exitPictureInPicture(): Entzieht das Video aus dem schwebenden Bild-im-Bild-Fenster zurück zu seinem ursprünglichen Container.
Document.exitPointerLock(): Gibt die Zeigersperre frei.
Document.getAnimations(): Gibt ein Array aller aktuell wirksamen Animation Objekte zurück, deren Zielelemente Nachkommen des document 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 von Elementen mit dem gegebenen Klassennamen zurück.
Document.getElementsByTagName(): Gibt eine Liste von Elementen mit dem gegebenen Tag-Namen zurück.
Document.getElementsByTagNameNS(): Gibt eine Liste von Elementen mit dem gegebenen Tag-Namen und Namespace zurück.
Document.getSelection(): Gibt ein Selection Objekt zurück, das den vom Benutzer ausgewählten Textbereich oder die aktuelle Position des Carets darstellt.
Document.hasStorageAccess(): Gibt ein Promise zurück, das sich mit einem Boolean-Wert erfüllt, 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: Ermöglicht, 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 Strings vor dem ersten Kind des Dokuments ein.
Document.querySelector(): Gibt das erste Elementknoten innerhalb des Dokuments, in Dokumentreihenfolge, zurück, das die angegebenen Selektoren erfüllt.
Document.querySelectorAll(): Gibt eine Liste aller Elementknoten innerhalb des Dokuments zurück, die die angegebenen Selektoren erfüllen.
Document.releaseCapture() Nicht standardisiert: Gibt die aktuelle Mausaufnahme frei, sofern sie sich auf ein Element in diesem Dokument bezieht.
Document.releaseEvents() Veraltet: Siehe Window.releaseEvents().
Document.replaceChildren(): Ersetzt die vorhandenen Kinder eines Dokuments mit einer angegebenen neuen Menge von Kindern.
Document.requestStorageAccess(): Ermöglicht einem in einem Drittanbieterkontext geladenen Dokument, zum Beispiel eingebettet in einem <iframe>, Zugriff auf unpartitionierte Cookies anzufordern, in Fällen, wo Benutzeragenten standardmäßig den Zugriff auf unpartitionierte Cookies durch Websites, die in einem Drittanbieterkontext geladen sind, blockieren, um die Privatsphäre zu verbessern.
Document.requestStorageAccessFor() Experimentell: Ermöglicht es Top-Level-Sites, auf eingebettete Inhalte einer anderen Site im gleichen verwandten Website-Set im Auftrag Zugriff für Drittanbieter-Cookies zu beantragen.
Document.startViewTransition(): Startet einen neuen Ansichtstransition und gibt ein ViewTransition Objekt zurück, das sie 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(): 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 bearbeitbaren Dokument einen Formatierungsbefehl aus.
Document.getElementsByName(): Gibt eine Liste von Elementen 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 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 Textzeile 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 eine Sanitization durchzuführen. Der String kann deklarative Shadow-Roots enthalten.

Ereignisse

Hören Sie diese Ereignisse mit addEventListener() oder indem Sie einen Ereignis-Listener auf die Eigenschaft oneventname dieses Interfaces zuweisen. Zusätzlich zu den unten aufgelisteten Ereignissen können viele Ereignisse von nodes innerhalb des Dokumentbaums gestreut werden.

afterscriptexecute Nicht standardisiert Veraltet: Wird ausgelöst, wenn ein statisches <script> Element sein Skript fertig ausgeführt hat.
beforescriptexecute Nicht standardisiert Veraltet: Wird ausgelöst, wenn ein statisches <script> Element kurz davor ist, sein Skript auszuführen.
prerenderingchange Experimentell: Wird auf einem vorgerenderten Dokument ausgelöst, wenn es aktiviert wird (d.h. der Nutzer die Seite ansieht).
securitypolicyviolation: Wird ausgelöst, wenn eine Sicherheitsrichtlinie für Inhalte verletzt wird.
visibilitychange: Wird ausgelöst, wenn der Inhalt eines Tabs sichtbar geworden ist 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.

Vollbild-Ereignisse

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

Lade- & Entlade-Ereignisse

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

Zeigersperre-Ereignisse

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

Scroll-Ereignisse

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

Auswahlevents

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

Geschachtelte Ereignisse

Nicht alle automatischen stufenweisen Ereignisse können das Document-Objekt erreichen. Nur die folgenden können und können am Document-Objekt belauscht 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