Document

Каждая веб-страница, которая загружается в браузер, имеет свой собственный объект document. Интерфейс документа служит точкой входа для получения содержимого веб-страницы (всего DOM (en-US) - дерева, включая такие элементы как <body> и <table> (en-US)), а также обеспечивает функциональность, которая является глобальной для документа, например, для получения URL-адреса страницы или создания новых элементов в документе).

Объект document может быть получен из разных API:

  • Чаще всего используется прямой доступ к объекту document из сценариев scripts (en-US) которые подгружаются документом. (Этот же объект доступен как window.document.)
  • Через свойство contentDocument объекта iframe.
  • Как ответ responseXML объекта XMLHttpRequest.
  • Доступ к документу может быть получен из элемента или узла через свойство ownerDocument.

В зависимости от вида документа (т.е. HTML или XML (en-US)) у объекта document могут быть доступны разные API.

  • Все объекты документов реализуют интерфейс Document (и следовательно Node и EventTarget интерфейсы). Таким образом основные свойства и методы, описанные на этой странице, доступны для всех видов документов.
  • В современных браузерах некоторые документы (т.е. те, которые содержат контент text/html) также реализуют HTMLDocument интерфейс.
  • В современных браузерах SVG документы реализуют SVGDocument интерфейс.

В будущем все эти интерфейсы будут сведены в один интерфейс - Document.

Свойства

Примечание: Интерфейс Document наследует также интерфейсы Node и EventTarget.

Document.all Deprecated Non-standard

Обеспечивает доступ ко всем элементам с идентификаторами (id). Это нестандартный интерфейс, вместо него рекомендуется использовать метод Document.getElementById().

Document.async Deprecated

Используется с document.load чтобы обозначить асинхронный запрос.

Document.characterSet Экспериментальная возможность

Возвращает кодировку документа.

Document.compatMode Экспериментальная возможность

Указывает в каком режиме (Quirks или Strict) рендерился документ.

Document.contentType Экспериментальная возможность

Возвращает Content-Type из MIME заголовка текущего документа.

Document.doctype

Возвращает Document Type Definition (DTD) текущего документа .

Document.documentElement

Возвращает Element, который является первым дочерним элементом документа. Для HTML документов это HTML-элемент.

Document.documentURI

Возвращает URL документа.

Document.domConfig Deprecated

Должен вернуть DOMConfiguration объект.

Document.implementation (en-US)

Возвращает DOM implementation связанную с текущим документом.

Document.inputEncoding (en-US) Deprecated

Возвращает кодировку, которая использовалась во время парсинга документа.

Document.lastStyleSheetSet (en-US)

Возвращает имя последнего включённого набора таблиц стилей. Имеет значение null , пока таблица стилей не будет изменена путём установки значения selectedStyleSheetSet (en-US).

Document.mozSyntheticDocument (en-US) Non-standard

true если этот документ является синтетическим, например, отдельные изображения, видео, аудио файлы, или тому подобные.

Document.mozFullScreen (en-US) Non-standard

true когда документ находится в full-screen mode.

Document.mozFullScreenElement (en-US) Non-standard

Элемент, который в данный момент находится в полноэкранном режиме для этого документа.

Document.mozFullScreenEnabled (en-US) Non-standard

true if calling element.mozRequestFullscreen() (en-US) would succeed in the curent document.

Document.pointerLockElement (en-US) Экспериментальная возможность

Returns the element set as the target for mouse events while the pointer is locked. null if lock is pending, pointer is unlocked, or if the target is in another document.

Document.preferredStyleSheetSet (en-US)

Returns the preferred style sheet set as specified by the page author.

Document.selectedStyleSheetSet (en-US)

Returns which style sheet set is currently in use.

Document.styleSheets (en-US)

Returns a list of the style sheet objects on the current document.

Document.styleSheetSets (en-US)

Returns a list of the style sheet sets available on the document.

Document.xmlEncoding (en-US) Deprecated

Returns the encoding as determined by the XML declaration.

Document.xmlStandalone Deprecated

Returns true if the XML declaration specifies the document to be standalone (e.g., An external part of the DTD affects the document's content), else false.

Document.xmlVersion (en-US) Deprecated

Returns the version number as specified in the XML declaration or "1.0" if the declaration is absent.

The Document interface is extended with the ParentNode interface:

{{page("/en-US/docs/Web/API/ParentNode","Properties")}}

Extension for HTML documents

The Document interface for HTML documents inherit from the HTMLDocument interface or, since HTML5, is extended for such documents:

Document.activeElement

Returns the currently focused element.

Document.alinkColor Deprecated

Returns or sets the color of active links in the document body.

Document.anchors

Returns a list of all of the anchors in the document.

Document.applets Deprecated

Returns an ordered list of the applets within a document.

Document.bgColor Deprecated

Gets/sets the background color of the current document.

Document.body

Returns the <body> element of the current document.

Document.cookie

Returns a semicolon-separated list of the cookies for that document or sets a single cookie.

Document.defaultView

Returns a reference to the window object.

Document.designMode

Gets/sets the ability to edit the whole document.

Document.dir

Gets/sets directionality (rtl/ltr) of the document.

Document.domain

Returns the domain of the current document.

Document.embeds

Returns a list of the embedded <embed> elements within the current document.

Document.fgColor (en-US) Deprecated

Gets/sets the foreground color, or text color, of the current document.

Document.forms

Returns a list of the <form> elements within the current document.

Document.head

Returns the <head> element of the current document.

Document.height Non-standard Этот API вышел из употребления и его работа больше не гарантируется.

Gets/sets the height of the current document.

Document.images

Returns a list of the images in the current document.

Document.lastModified (en-US)

Returns the date on which the document was last modified.

Document.linkColor (en-US) Deprecated

Gets/sets the color of hyperlinks in the document.

Returns a list of all the hyperlinks in the document.

Document.location

Returns the URI of the current document.

Document.plugins (en-US)

Returns a list of the available plugins.

Document.readyState

Returns loading status of the document.

Document.referrer

Returns the URI of the page that linked to this page.

Document.scripts

Returns all the <script> elements on the document.

Document.title (en-US)

Returns the title of the current document.

Document.URL

Returns a string containing the URL of the current document.

Document.vlinkColor (en-US) Deprecated

Gets/sets the color of visited hyperlinks.

Document.width (en-US) Non-standard Этот API вышел из употребления и его работа больше не гарантируется.

Returns the width of the current document.

Event handlers

Document.onpointerlockchange Экспериментальная возможность

Returns the event handling code for the pointerlockchange (en-US) event.

Document.onpointerlockerror Экспериментальная возможность

Returns the event handling code for the pointerlockerror (en-US) event.

Document.onreadystatechange

Returns the event handling code for the readystatechange event.

Methods

Примечание: The Document interface also inherits from the Node and EventTarget interfaces.

Document.adoptNode(Node node) (en-US)

Adopt node from an external document.

Document.captureEvents(String eventName) Deprecated

See window.captureEvents (en-US).

Document.caretPositionFromPoint(Number x, Number y) (en-US)

Gets a CaretPosition (en-US) based on two coordinates.

Document.createAttribute(String name)

Creates a new Attr object and returns it.

Document.createAttributeNS(String namespace, String name) (en-US)

Creates a new attribute node in a given namespace and returns it.

Document.createCDATASection(String data) (en-US)

Creates a new CDATA node and returns it.

Document.createComment(String comment)

Creates a new comment node and returns it.

Document.createDocumentFragment()

Creates a new document fragment.

Document.createElement(String name)

Creates a new element with the given tag name.

Document.createElementNS(String namespace, String name) (en-US)

Creates a new element with the given tag name and namespace URI.

Document.createEntityReference(String name) (en-US) Этот API вышел из употребления и его работа больше не гарантируется.

Creates a new entity reference object and returns it.

Document.createEvent(String interface) (en-US)

Creates an event object.

Document.createNodeIterator(Node root[, Number whatToShow[, NodeFilter filter]]) (en-US)

Creates a NodeIterator (en-US) object.

Document.createProcessingInstruction(String target, String data) (en-US)

Creates a new ProcessingInstruction (en-US) object.

Document.createRange()

Creates a Range object.

Document.createTextNode(String text)

Creates a text node.

Document.createTreeWalker(Node root[, Number whatToShow[, NodeFilter filter]])

Creates a TreeWalker (en-US) object.

Document.elementFromPoint(Number x, Number y) (en-US)

Returns the element visible at the specified coordinates.

Document.enableStyleSheetsForSet(String name) (en-US)

Enables the style sheets for the specified style sheet set.

Document.exitPointerLock() (en-US) Экспериментальная возможность

Release the pointer lock.

Document.getElementsByClassName(String className)

Returns a list of elements with the given class name.

Document.getElementsByTagName(String tagName)

Returns a list of elements with the given tag name.

Document.getElementsByTagNameNS(String namespace, String tagName) (en-US)

Returns a list of elements with the given tag name and namespace.

Document.importNode(Node node, Boolean deep)

Returns a clone of a node from an external document.

document.mozSetImageElement (en-US) Non-standard

Allows you to change the element being used as the background image for a specified element ID.

Document.normalizeDocument() Этот API вышел из употребления и его работа больше не гарантируется.

Replaces entities, normalizes text nodes, etc.

Document.releaseCapture() (en-US) Non-standard

Releases the current mouse capture if it's on an element in this document.

Document.releaseEvents Non-standard Deprecated

See window.releaseEvents (en-US).

document.routeEvent Non-standard Вышла из употребления с версии Gecko 24

See window.routeEvent.

The Document interface is extended with the ParentNode interface:

Document.getElementById(String id)

Returns an object reference to the identified element.

Document.querySelector(String selector)

Returns the first Element node within the document, in document order, that matches the specified selectors.

Document.querySelectorAll(String selector)

Returns a list of all the Element nodes within the document that match the specified selectors.

The Document interface is extended with the XPathEvaluator (en-US) interface:

Document.createExpression(String expression, XPathNSResolver resolver) (en-US)

Compiles an XPathExpression which can then be used for (repeated) evaluations.

Document.createNSResolver(Node resolver) (en-US)

Creates an XPathNSResolver (en-US) object.

Document.evaluate(String expression, Node contextNode, XPathNSResolver resolver, Number type, Object result)

Evaluates an XPath expression.

Extension for HTML documents

The Document interface for HTML documents inherit from the HTMLDocument interface or, since HTML5, is extended for such documents:

Document.clear() (en-US) Non-standard Deprecated

In majority of modern browsers, including recent versions of Firefox and Internet Explorer, this method does nothing.

Document.close()

Closes a document stream for writing.

Document.execCommand(String command[, Boolean showUI[, String value]])

On an editable document, executes a formating command.

Document.getElementsByName(String name)

Returns a list of elements with the given name.

Document.getSelection()

Returns a Selection object related to text selected in the document.

Document.hasFocus()

Returns true if the focus is currently located anywhere inside the specified document.

Document.open() (en-US)

Opens a document stream for writing.

Document.queryCommandEnabled(String command) (en-US)

Returns true if the formating command can be executed on the current range.

Document.queryCommandIndeterm(String command)

Returns true if the formating command is in an indeterminate state on the current range.

Document.queryCommandState(String command) (en-US)

Returns true if the formating command has been executed on the current range.

Document.queryCommandSupported(String command) (en-US)

Returns true if the formating command is supported on the current range.

Document.queryCommandValue(String command)

Returns the current value of the current range for a formatting command.

Document.registerElement(String tagname[, Object options])

Registers a new custom element in the browser and returns a constructor for the new element.

Document.write(String text)

Writes text in a document.

Document.writeln(String text)

Writes a line of text in a document.

Specifications

Specification Status Comment
Document Object Model (DOM) Level 1 Specification
Определение 'Document' в этой спецификации.
Устаревшая Initial definition for the interface
Document Object Model (DOM) Level 2 Core Specification
Определение 'Document' в этой спецификации.
Устаревшая Supersede DOM 1
Document Object Model (DOM) Level 3 Core Specification
Определение 'Document' в этой спецификации.
Устаревшая Supersede DOM 2
DOM
Определение 'Document' в этой спецификации.
Живой стандарт Intend to supersede DOM 3
HTML Living Standard
Определение 'Document' в этой спецификации.
Живой стандарт Turn the HTMLDocument interface into a Document extension.
Document Object Model (DOM) Level 3 XPath Specification
Определение 'XPathEvaluator' в этой спецификации.
Рекомендация Define the XPathEvaluator (en-US) interface which extend Document.
HTML Editing APIs
Определение 'Document' в этой спецификации.
Редакторский черновик Extend the Document interface
CSS Object Model (CSSOM) View Module
Определение 'Document' в этой спецификации.
Рабочий черновик Extend the Document interface
CSS Object Model (CSSOM)
Определение 'Document' в этой спецификации.
Рабочий черновик Extend the Document interface
Pointer Lock
Определение 'Document' в этой спецификации.
Кандидат в рекомендации Extend the Document interface

Browser compatibility

Firefox notes

Mozilla defines a set of non-standard properties made only for XUL content:

document.currentScript

Returns the <script> element that is currently executing.

document.documentURIObject

(Mozilla add-ons only!) Returns the nsIURI object representing the URI of the document. This property only has special meaning in privileged JavaScript code (with UniversalXPConnect privileges).

document.popupNode

Returns the node upon which a popup was invoked.

document.tooltipNode

Returns the node which is the target of the current tooltip.

Mozilla also define some non-standard methods:

Document.execCommandShowHelp Deprecated

This method never did anything and always threw an exception, so it was removed in Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11).

Document.getBoxObjectFor (en-US) Deprecated

Use the Element.getBoundingClientRect() method instead.

Document.loadOverlay

Loads a XUL overlay dynamically. This only works in XUL documents.

document.queryCommandText Deprecated

This method never did anything but throw an exception, and was removed in Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11).

Internet Explorer notes

Microsoft defines some non-standard properties:

document.fileSize Non-standard Deprecated

Returns size in bytes of the document. Starting with Internet Explorer 11, that property is no longer supported. See MSDN.

Internet Explorer does not support all methods from the Node interface in the Document interface:

document.contains

As a work-around, document.body.contains() can be used.

Совместимость с браузерами

BCD tables only load in the browser