Document
Document
インターフェイスはブラウザーに読み込まれたウェブページを表し、 DOM ツリーであるウェブページのコンテンツへの入口としての役割を果たします。
DOM ツリーには <body>
や <table>
など、多数の要素があります。これはページの URL を取得したり文書で新たな要素を作成するなど、文書全体に関わる機能を提供します。
Document
インターフェイスは、あらゆる種類の文書に対して共通のプロパティやメソッドを提供します。また、文書の種類(例: HTML、XML、SVG など)に応じて、より大規模な API を使用できます。コンテンツタイプ "text/html"
で提供される HTML 文書では、 HTMLDocument
インターフェイスも実装します。一方 XML や SVG 文書では、 XMLDocument
インターフェイスを実装します。
コンストラクター
Document()
-
新しい
Document
オブジェクトを作成します。
インスタンスプロパティ
このインターフェイスは、 Node
インターフェイスおよび EventTarget
インターフェイスのプロパティも継承しています。
Document.activeElement
読取専用-
現在フォーカスのある
Element
を返します。 Document.adoptedStyleSheets
-
文書で使用するために構築したスタイルシートの配列を追加します。 これらのスタイルシートは、同じ文書のシャドウ DOM のサブツリーと共有されます。
Document.body
-
現在の文書の
<body>
または<frameset>
ノードを返します。 Document.characterSet
読取専用-
文書に適用されている文字セットを返します。
Document.childElementCount
読取専用-
現在の文書の子要素の数を返します。
Document.children
読取専用-
現在の文書の子要素を返します。
Document.compatMode
読取専用-
文書が Quirks モードと Strict モードのどちらで描画されているかを示します。
Document.contentType
読取専用-
現在の文書の MIME ヘッダーから Content-Type を返します。
Document.currentScript
読取専用-
<script>
要素のうち、現在処理中で、かつ JavaScript モジュールでないものを返します。 Document.doctype
読取専用-
現在の文書の文書型宣言 (DTD) を返します。
Document.documentElement
読取専用-
文書の直接の子である
Element
を返します。 HTML 文書では、これは通常はHTMLHtmlElement
オブジェクトで、文書の<html>
要素を表します。 Document.documentURI
読取専用-
文書の場所を文字列で返します。
Document.embeds
読取専用-
HTMLCollection
で、現在の文書に含まれる埋め込まれた<embed>
要素のリストを返します。 Document.featurePolicy
Experimental 読取専用-
文書に適用されている機能ポリシーを
FeaturePolicy
インターフェイスで返します。 Document.firstElementChild
読取専用-
現在の文書における最初の子要素を返します。
Document.fonts
-
現在の文書の
FontFaceSet
インターフェイスを返します。 Document.forms
読取専用-
HTMLCollection
で現在の文書の<form>
要素を返します。 Document.fragmentDirective
読取専用 Experimental-
現在の文書の
FragmentDirective
を返します。 Document.fullscreenElement
読取専用-
この文書で現在全画面モードになっている要素です。
Document.head
読取専用-
現在の文書の
<head>
要素を返します。 -
このページが非表示と見なされているかどうかを論理値で返します。
Document.images
読取専用-
HTMLCollection
で、現在の文書の画像のリストを返します。 Document.implementation
読取専用-
現在の文書に関連付けられた DOM 実装を返します。
Document.lastElementChild
読取専用-
現在の文書における最後の子要素を返します。
Document.links
読取専用-
HTMLCollection
で、文書内のすべてのハイパーリンクのリストを返します。 Document.pictureInPictureElement
読取専用-
この文書で現在、ピクチャインピクチャモードで表示されている要素 (
Element
) を返します。 Document.pictureInPictureEnabled
読取専用-
ピクチャインピクチャ機能が有効であれば true を返します。
Document.plugins
読取専用-
HTMLCollection
で、利用可能なプラグインのリストを返します。 Document.pointerLockElement
読取専用-
ポインターがロックされている場合、マウスイベントのターゲットとして設定された要素を返します。ロック待ちの場合、ポインターがロックされていない場合、ターゲットが他の文書にある場合は
null
を返します。 Document.prerendering
読取専用 Experimental-
論理値で、文書が現在、投機ルール API によって開始されたような、事前レンダリング中であるかどうかを示します。
Document.scripts
読取専用-
HTMLCollection
で、文書内のすべての<script>
要素を返します。 Document.scrollingElement
読取専用-
文書をスクロールする
Element
への参照を返します。 Document.styleSheets
読取専用-
StyleSheetList
で、文書で明示的にリンクされているスタイルシートや、文書に埋め込まれているスタイルシート(CSSStyleSheet
オブジェクトのリスト)を返します。 Document.timeline
読取専用-
タイムラインを
DocumentTimeline
の特別なインスタンスで返します。これはページの読み込み時に自動的に生成されます。 Document.visibilityState
読取専用-
文書の可視性を表す文字列を返します。
visible
,hidden
,prerender
,unloaded
のいずれかの値になります。
HTML 文書向けの拡張
HTML 文書用の Document
インターフェイスは HTMLDocument
インターフェイスから継承されていたり、拡張されていたりします。
-
文書のクッキーをセミコロンで区切られたリストで返すか、単一のクッキーを設定するかします。
Document.defaultView
読取専用-
window オブジェクトへの参照を返します。
Document.designMode
-
文書全体を編集可能かを取得/設定します。
Document.dir
-
文書の書字方向 (rtl/ltr) を取得/設定します。
Document.fullscreenEnabled
読取専用-
全画面モードが利用できるかどうかを示します。
Document.lastModified
読取専用-
文書の最終更新日を返します。
Document.location
読取専用-
現在の文書の URI を返します。
Document.readyState
読取専用-
文書の読み込み状況を表す文字列を返します。
Document.referrer
読取専用-
このページへリンクしたページの URI を返します。
Document.title
-
現在の文書のタイトルを設定または取得します。
Document.URL
読取専用-
現在の文書の URL を含む文字列を返します。
非推奨のプロパティ
Document.alinkColor
非推奨-
文書本文内のアクティブなリンクの色を取得または設定します。
Document.all
非推奨-
文書内のすべての要素にアクセスできます。文書ノードを起点とする
HTMLAllCollection
を返します。これは古い標準外のプロパティですので、使用しないようにしてください。 Document.anchors
非推奨 読取専用-
文書内のすべてのアンカーのリストを返します。
Document.applets
非推奨 読取専用-
空の
HTMLCollection
を返します。文書内にあるアプレットのリストを返すために使われた古いプロパティです。 Document.bgColor
非推奨-
現在の文書の背景色を取得または設定します。
Document.charset
非推奨 読取専用-
Document.characterSet
の別名です。代わりにこのプロパティを使用してください。 Document.domain
非推奨-
現在の文書のドメインを取得/設定します。
Document.fgColor
非推奨-
現在の文書の前景色または文字色を取得/設定します。
Document.fullscreen
非推奨-
文書が全画面モードにあるときに
true
を返します。 Document.inputEncoding
非推奨 読取専用-
Document.characterSet
の別名です。代わりにそちらを使用してください。 Document.lastStyleSheetSet
非推奨 読取専用 Non-standard-
直前に有効であったスタイルシートセットの名称を返します。
selectedStyleSheetSet
に値を設定してスタイルシートを変更するまで、この値はnull
になります。 Document.linkColor
非推奨-
文書内のハイパーリンクの色を取得/設定します。
Document.preferredStyleSheetSet
非推奨 読取専用 Non-standard-
ページの作者によって設定された、推奨されるスタイルシートを返します。
Document.rootElement
非推奨-
Document.documentElement
と同様ですが、<svg>
ルート要素専用です。こちらのプロパティを代わりに使用してください。 Document.selectedStyleSheetSet
非推奨 Non-standard-
現在どのスタイルシートセットを使用しているかを返します。
Document.styleSheetSets
非推奨 読取専用 Non-standard-
文書で使用できるスタイルシートセットのリストを返します。
Document.vlinkColor
非推奨-
訪問済みのハイパーリンクの色を取得/設定します。
Document.xmlEncoding
非推奨-
XML 宣言によって決められたエンコーディングを返します。
Document.xmlStandalone
非推奨-
XML 宣言で文書がスタンドアロンである(例: DTD の外部パートが文書のコンテンツに影響する)場合に
true
を、そうでない場合にfalse
を返します。 Document.xmlVersion
非推奨-
XML 宣言で指定されたバージョン番号、または宣言が省略されている場合に
"1.0"
を返します。
インスタンスメソッド
このインターフェイスは、Node
インターフェイスおよび EventTarget
インターフェイスのメソッドを継承します。
Document.adoptNode()
-
外部文書からノードを取り込みます。
Document.append()
-
文書の最後の子の後に
Node
オブジェクトまたは文字列の集合を挿入します。 Document.browsingTopics()
Experimental Non-standard-
過去 3 つのエポックのそれぞれから 1 つずつ、ユーザーのトップトピックを表すオブジェクトの配列で履行されるプロミスを返します。既定では、このメソッドは、呼び出し側が監視している現在のページの訪問をブラウザーに記録させるので、後でページのホスト名をトピックの計算に使用することができます。詳細はトピック API を参照してください。
Document.captureEvents()
非推奨-
Window.captureEvents
をご覧ください。 Document.caretPositionFromPoint()
-
キャレットを含む DOM ノードと、そのノード内でのキャレットの文字オフセットを含む
CaretPosition
オブジェクトを返します。 Document.caretRangeFromPoint()
Non-standard-
指定した座標にある文書の断片の
Range
オブジェクトを取得します。 Document.createAttribute()
-
新しい
Attr
オブジェクトを生成して、返します。 Document.createAttributeNS()
-
指定した名前空間に新しい属性ノードを生成して、返します。
Document.createCDATASection()
-
新しい CDATA ノードを生成して、返します。
Document.createComment()
-
新しいコメントノードを生成して、返します。
Document.createDocumentFragment()
-
新しい文書断片を生成します。
Document.createElement()
-
指定したタグ名で新しい要素を生成します。
Document.createElementNS()
-
指定したタグ名およびネームスペース URI で、新しい要素を生成します。
Document.createEvent()
-
イベントオブジェクトを生成します。
Document.createNodeIterator()
-
NodeIterator
オブジェクトを生成します。 Document.createProcessingInstruction()
-
新しい
ProcessingInstruction
オブジェクトを生成します。 Document.createRange()
-
Range
オブジェクトを生成します。 Document.createTextNode()
-
テキストノードを生成します。
Document.createTouch()
非推奨 Non-standard-
Touch
オブジェクトを生成します。 Document.createTouchList()
非推奨 Non-standard-
TouchList
オブジェクトを生成します。 Document.createTreeWalker()
-
TreeWalker
オブジェクトを生成します。 Document.elementFromPoint()
-
指定された座標の最上位の要素を返します。
Document.elementsFromPoint()
-
指定された座標にあるすべての要素の配列を返します。
Document.enableStyleSheetsForSet()
非推奨 Non-standard-
指定したスタイルシートセットのスタイルシートを有効化します。
Document.exitFullscreen()
-
文書の全画面モードにある要素の全画面表示を止めます。
Document.exitPictureInPicture()
-
浮動ピクチャーインピクチャーウィンドウから動画を取り外し、元のコンテナーに戻します。
Document.exitPointerLock()
-
ポインターロックを解放します。
Document.getAnimations()
-
現在実行中であるすべての
Animation
オブジェクトの配列を返します。この対象要素は、document
の子孫要素です。 Document.getBoxQuads()
Experimental-
このノードの CSS フラグメントを表す
DOMQuad
オブジェクトのリストを返します。 Document.getElementById()
-
識別された要素のオブジェクト参照を返します。
Document.getElementsByClassName()
-
指定されたクラス名を持つ要素のリストを返します。
Document.getElementsByTagName()
-
指定されたタグ名を持つ要素のリストを返します。
Document.getElementsByTagNameNS()
-
指定されたタグ名と名前空間を持つ要素のリストを返します。
Document.getSelection()
-
ユーザーが現在選択しているテキスト範囲、または現在のキャレットの位置を表す
Selection
オブジェクトを返します。 Document.hasStorageAccess()
-
文書に分離されていないクッキーへのアクセスがあるかどうかを示す論理値で解決する
Promise
を返します。 -
Document.hasStorageAccess()
の新しい名前です。 Document.importNode()
-
外部文書のノードの複製を返します。
Document.mozSetImageElement()
Non-standard-
指定した要素 ID の背景画像として使用している要素を変更することができます。
Document.prepend()
-
文書の最初の子の前に、
Node
オブジェクトまたは文字列の集合を挿入します。 Document.querySelector()
-
指定したセレクターに一致する、文書内で最初の要素ノードを返します。
Document.querySelectorAll()
-
指定したセレクターに一致する、文書内のすべての要素ノードのリストを返します。
Document.releaseCapture()
Non-standard-
この文書内の要素でマウスキャプチャを行っている場合、マウスキャプチャを解放します。
Document.releaseEvents()
非推奨-
Window.releaseEvents()
をご覧ください。 Document.replaceChildren()
-
文書の既存の子を、指定された新しい子の集合で置き換えます。
Document.requestStorageAccess()
-
サードパーティのコンテキスト(すなわち、
<iframe>
に埋め込まれたもの)に読み込まれた文書が、分離されていないクッキーへのアクセスを要求できるようにします。これはユーザーエージェントが既定で、プライバシーを改善するためにサードパーティコンテキストで読み込まれたサイトによる分離されていないクッキーへのアクセスをブロックしている場合に使用します。 Document.requestStorageAccessFor()
Experimental-
最上位のサイトが、同じ関連ウェブサイト設定内の別のウェブサイトから発信された埋め込みコンテンツの代わりに、サードパーティクッキーへのアクセスをリクエストできるようにします。
Document.startViewTransition()
-
新しいビュー遷移を開始し、それを表すための
ViewTransition
オブジェクトを返します。
Document
インターフェイスは、XPathEvaluator
インターフェイスによって拡張されています。
Document.createExpression()
-
(繰り返し) 評価に使用できる
XPathExpression
をコンパイルします。 Document.createNSResolver()
-
XPathNSResolver
オブジェクトを生成します。 Document.evaluate()
-
XPath 表現を評価します。
HTML 文書向けの拡張
HTML 文書用の Document
インターフェイスは HTMLDocument
インターフェイスから継承または拡張されています。
Document.clear()
非推奨-
このメソッドは何もしません。
Document.close()
-
書き込み用の文書ストリームを閉じます。
Document.execCommand()
非推奨-
編集可能な文書で、フォーマットコマンドを実行します。
Document.getElementsByName()
-
(引数で) 与えられた名前 (name) を持つ要素のリストを返します。
Document.hasFocus()
-
指定した文書内にフォーカスがある場合に、
true
を返します。 Document.open()
-
書き込み用の文書ストリームを開きます。
Document.queryCommandEnabled()
非推奨 Non-standard-
現在の領域でフォーマットコマンドを実行できる場合に、 true を返します。
Document.queryCommandIndeterm()
非推奨-
現在の領域でフォーマットコマンドの状態が不確定である場合に true を返します。
Document.queryCommandState()
非推奨 Non-standard-
現在の領域でフォーマットコマンドを実行した場合に true を返します。
Document.queryCommandSupported()
非推奨 Non-standard-
現在の領域でフォーマットコマンドをサポートしている場合に、true を返します。
Document.queryCommandValue()
非推奨-
指定したフォーマットコマンドについて、現在の領域における値を返します。
Document.write()
-
文書にテキストを書き込みます。
Document.writeln()
-
文書にテキスト行を書き込みます。
静的メソッド
このインターフェイスには Node
および EventTarget
インターフェイスから継承したメソッドもあります。
Document.parseHTMLUnsafe()
-
サニタイズ処理を行わずに、HTML の文字列から新しい
Document
オブジェクトを作成します。 文字列には宣言敵にシャドウルートを含むことができます。
イベント
これらのイベントを待ち受けするには、 addEventListener()
を使用するか、本インターフェイスの onイベント名
プロパティへイベントリスナーを代入するかしてください。下記の一覧に掲載されているイベントの他に、文書ツリー内のノードから多くのイベントがバブリングする可能性があります。
afterscriptexecute
Non-standard-
静的な
<script>
要素でスクリプトの実行が完了した時に発生します。 beforescriptexecute
Non-standard-
静的な
<script>
で実行を開始しようとしている時に発生します。 prerenderingchange
Experimental-
事前レンダリングされた文書がアクティブになった(ユーザーがページを表示した)ときに発行されます。
securitypolicyviolation
-
コンテンツセキュリティポリシーに違反した場合に発行されます。
visibilitychange
-
タブの内容の表示・非表示の状態が切り替わった時に発行されます。
クリップボードイベント
全画面イベント
fullscreenchange
-
Document
が全画面モードへ移行したとき、または解除されたときに発行されます。 fullscreenerror
-
全画面モードへ切り替えようとしたとき、または解除しようとしたときにエラーが発生した場合に発行されます。
ロード&アンロードイベント
DOMContentLoaded
-
文書が完全に読み込まれて解釈されたときに、スタイルシート、画像、サブフレームの読み込みが完了するのを待たずに発行されます。
readystatechange
-
文書の
readyState
属性が変更されたときに発行されます。
ポインターロックイベント
pointerlockchange
-
ポインターがロックまたはアンロックされたときに発行されます。
pointerlockerror
-
ポインターをロックしようとして失敗したときに発行されます。
スクロールイベント
選択イベント
selectionchange
-
文書でのテキスト選択範囲が変化したときに発行されます。
仕様書
ブラウザーの互換性
BCD tables only load in the browser