Dokument

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

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

Das Document Interface beschreibt die gemeinsamen Eigenschaften und Methoden für jede Art von Dokument. Abhängig vom Dokumenttyp (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(): Erstellt ein neues Document Objekt.

Instanzeigenschaften

Dieses Interface erbt auch von den Node und EventTarget Interfaces.

Document.activeElement Nur lesbar: 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 Schatten-DOM-Unterbäumen desselben Dokuments geteilt werden.
Document.body: Gibt den <body> oder den <frameset> Knoten des aktuellen Dokuments zurück.
Document.characterSet Nur lesbar: Gibt den Zeichensatz des Dokuments zurück.
Document.childElementCount Nur lesbar: Gibt die Anzahl der Kind-Elemente des aktuellen Dokuments zurück.
Document.children Nur lesbar: Gibt die Kind-Elemente des aktuellen Dokuments zurück.
Document.compatMode Nur lesbar: Zeigt an, ob das Dokument im Quirks- oder Strict-Modus gerendert wird.
Document.contentType Nur lesbar: Gibt den Content-Type aus dem MIME-Header des aktuellen Dokuments zurück.
Document.currentScript Nur lesbar: Gibt das <script> Element zurück, dessen Skript aktuell verarbeitet wird und kein JavaScript-Modul ist.
Document.doctype Nur lesbar: Gibt die Dokumenttyp-Definition (DTD) des aktuellen Dokuments zurück.
Document.documentElement Nur lesbar: Gibt das Element zurück, das ein direktes Kind des Dokuments ist. Bei HTML-Dokumenten ist dies normalerweise das HTMLHtmlElement Objekt, das das <html> Element des Dokuments repräsentiert.
Document.documentURI Nur lesbar: Gibt den Dokumentstandort als String 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 auf das Dokument angewendeten Funktionalitätsrichtlinien zurück.
Document.firstElementChild Nur lesbar: Gibt das erste Kind-Element 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 derzeit 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 angibt, ob die Seite als versteckt angesehen wird oder nicht.
Document.images Nur lesbar: Gibt eine HTMLCollection der Bilder im Dokument zurück.
Document.implementation Nur lesbar: Gibt die DOM-Implementierung zurück, die mit dem aktuellen Dokument verknüpft ist.
Document.lastElementChild Nur lesbar: Gibt das letzte Kind-Element 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 momentan 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 ist, während der Zeiger gesperrt ist. null, wenn die Sperre aussteht, der Zeiger entsperrt ist oder das Ziel in einem anderen Dokument liegt.
Document.prerendering Nur lesbar Experimentell: Gibt einen Booleschen Wert zurück, der anzeigt, ob das Dokument derzeit im Prozess des Vorausladens ist, wie über die Speculation Rules API initiiert.
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 ein Dokument eingebunden oder eingebettet sind.
Document.timeline Nur lesbar: Gibt die Timeline als spezielle Instanz von DocumentTimeline zurück, die beim Laden der Seite automatisch erzeugt wird.
Document.visibilityState Nur lesbar: 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 durch Semikolons getrennte Liste der Cookies für das Dokument zurück oder setzt ein einzelnes Cookie.
Document.defaultView Nur lesbar: 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 Richtung (rtl/ltr) des Dokuments.
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 auf diese Seite verlinkt hat.
Document.title: Setzt oder liest den Titel des aktuellen Dokuments.
Document.URL Nur lesbar: Gibt den Dokumentstandort als String 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 — gibt eine HTMLAllCollection zurück, die im Dokumentknoten verwurzelt 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. Legacy-Eigenschaft, die früher die Liste der Applets innerhalb eines Dokuments zurückgab.
Document.bgColor Veraltet: Holt/setzt die Hintergrundfarbe des aktuellen Dokuments.
Document.charset Veraltet Nur lesbar: 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 sich 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 Stylesheet-Sets zurück, das zuletzt aktiviert war. Hat den Wert null, bis das Stylesheet durch Setzen des Wertes von selectedStyleSheetSet geändert wurde.
Document.linkColor Veraltet: Holt/setzt die Farbe von Hyperlinks im Dokument.
Document.preferredStyleSheetSet Veraltet Nur lesbar Nicht standardisiert: Gibt das bevorzugte Stylesheet-Set zurück, wie es vom Seitenersteller angegeben wurde.
Document.rootElement Veraltet: Wie Document.documentElement, aber 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 Nur lesbar Nicht standardisiert: Gibt eine Liste der im Dokument verfügbaren Stylesheet-Sets zurück.
Document.vlinkColor Veraltet: Holt/setzt die Farbe besuchter Hyperlinks.
Document.xmlEncoding Veraltet: Gibt die Kodierung zurück, wie sie durch die XML-Deklaration bestimmt wurde.
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 in der XML-Deklaration angegeben oder "1.0", wenn die Deklaration fehlt.

Instanzmethoden

Dieses Interface erbt auch von den Node und EventTarget Interfaces.

Document.adoptNode(): Übernimmt 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 Nutzer repräsentieren, eines aus jeder der letzten drei Epochen. Standardmäßig führt die Methode auch dazu, dass der Browser den aktuellen Seitenbesuch aufzeichnet, wie vom Aufrufer beobachtet, sodass der Hostname der Seite später in der Berechnung von Themen 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, der das Caret enthält, und den Zeichenoffset des Carets innerhalb dieses Knotens enthält.
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 ein neues Attribut in einem gegebenen Namensraum und gibt es 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 Dokument-Fragment.
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(): Erstellt ein Ereignis-Objekt.
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 daran, im Vollbildmodus angezeigt zu werden.
Document.exitPictureInPicture(): Entfernt das Video von der schwebenden Bild-in-Bild-Fenster zurück in seinen 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 Ziel-Elemente Nachkommen des Dokuments sind.
Document.getBoxQuads() Experimentell: Gibt eine Liste von DOMQuad Objekten zurück, die die CSS-Fragment des Knotens repräsentieren.
Document.getElementById(): Gibt eine Objekt-Referenz 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 Bereich des vom Benutzer ausgewählten Textes oder die aktuelle Position des Cursors repräsentiert.
Document.hasStorageAccess(): Gibt ein Promise zurück, das sich mit einem Booleschen Wert erfüllt, der angibt, ob das Dokument Zugang zu unpartitionierten 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 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 den ersten Elementknoten innerhalb des Dokuments 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: Hebt die aktuelle Mausaufnahme auf, 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 einen angegebenen neuen Satz von Kindern.
Document.requestStorageAccess(): Ermöglicht es einem in einem Drittanbieter-Kontext geladenen Dokument (d.h. eingebettet in ein <iframe>), Zugriff auf unpartitionierte Cookies anzufordern, in Fällen, in denen Benutzeragenten standardmäßig den Zugriff auf unpartitionierte Cookies durch Websites im Drittanbieter-Kontext blockieren, um die Privatsphäre zu verbessern.
Document.requestStorageAccessFor() Experimentell: Ermöglicht es Top-Level-Websites, Drittanbieter-Cookie-Zugriff im Namen von eingebetteten Inhalten zu beantragen, die von einer anderen Website innerhalb desselben bezogenen Website-Sets stammen.
Document.startViewTransition(): Startet einen neuen 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 einen XPathExpression, der 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 macht nichts.
Document.close(): Schließt einen Dokumentstream zum Schreiben.
Document.execCommand() Veraltet: Führt bei 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 sich 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 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 Formatierungsbefehls im aktuellen Bereich zurück.
Document.write(): Schreibt Text in ein Dokument.
Document.writeln(): Schreibt eine Textzeile 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 eine Bereinigung durchzuführen. Der String kann deklarative Schattenwurzeln enthalten.

Ereignisse

Hören Sie diese Ereignisse mithilfe von addEventListener() oder durch Zuweisen eines Ereignis-Listeners zur oneventname Eigenschaft dieses Interfaces. Zusätzlich zu den unten aufgeführten Ereignissen können viele Ereignisse von Knoten innerhalb des Dokumentbaums überblubbern.

afterscriptexecute Nicht standardisiert: Wird ausgelöst, wenn ein statisches <script> Element das Ausführen seines Skripts beendet hat
beforescriptexecute Nicht standardisiert: Wird ausgelöst, wenn ein statisches <script> kurz davor ist, das Ausführen zu starten.
prerenderingchange Experimentell: Wird auf einem vorausgerenderten Dokument ausgelöst, wenn es aktiviert wird (d. h. der Benutzer die Seite betrachtet).
securitypolicyviolation: Wird ausgelöst, wenn eine Content Security Policy verletzt wurde.
visibilitychange: Wird ausgelöst, wenn der Inhalt eines Tabs sichtbar geworden ist oder ausgeblendet wurde.

Zwischenablage-Ereignisse

copy: Wird ausgelöst, wenn der Benutzer über die Benutzeroberfläche des Browsers eine Kopieraktion 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 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- und Entlade-Ereignisse

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

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 das Dokumentfenster oder ein Element gescrollt wurde.
scrollend: Wird ausgelöst, wenn das Dokumentfenster oder ein Element das Scrollen abgeschlossen hat.
scrollsnapchange Experimentell: Wird am Scrollcontainer am Ende eines Scrollvorgangs ausgelöst, wenn ein neuer Scroll-Snap-Ziel ausgewählt wurde.
scrollsnapchanging Experimentell: Wird am Scrollcontainer ausgelöst, wenn der Browser feststellt, dass ein neuer Scroll-Snap-Ziel aussteht, d.h. ausgewählt wird, wenn die aktuelle Scrollgeste endet.

Auswahlereignisse

selectionchange: Wird ausgelöst, wenn die aktuelle Textauswahl in 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