Document

Document インターフェイスはブラウザーに読み込まれたウェブページを表し、 DOM ツリーであるウェブページのコンテンツへのエントリーポイントとして働きます。

DOM ツリーには <body><table> など、多数の要素があります。これはページの URL を取得したり文書で新たな要素を作成するなど、文書全体に関わる機能を提供します。

EventTarget Node Document

Document インターフェイスは、あらゆる種類の文書に対して共通のプロパティやメソッドを提供します。また、文書の種類 (例: HTMLXML、SVG など) に応じて、より大規模な API を使用できます。コンテンツタイプ "text/html" で提供される HTML 文書では、 HTMLDocument インターフェイスも実装します。一方 XML や SVG 文書では、 XMLDocument インターフェイスを実装します。

コンストラクター

Document()

新しい Document オブジェクトを作成します。

プロパティ

このインターフェイスは、 Node インターフェイスおよび EventTarget インターフェイスのプロパティも継承しています。

Document.activeElement 読取専用

現在フォーカスのある Element を返します。

Document.body

現在の文書の <body> または <frameset> ノードを返します。

Document.characterSet読取専用

文書に適用されている文字セットを返します。

Document.childElementCount 読取専用

現在の文書の子要素の数を返します。

Document.children (en-US) 読取専用

現在の文書の子要素を返します。

Document.compatMode  Experimental 読取専用

文書が Quirks モードと Strict モードのどちらで描画されているかを示します。

Document.contentType  Experimental 読取専用

現在の文書の MIME ヘッダーから Content-Type を返します。

Document.currentScript読取専用

<script> 要素のうち、現在処理中で、かつ JavaScript モジュールでないものを返します。

Document.doctype読取専用

現在の文書の文書型宣言 (DTD) を返します。

Document.documentElement読取専用

文書の直接の子である Element を返します。 HTML 文書では、これは通常は HTMLHtmlElement オブジェクトで、文書の <html> 要素を表します。

Document.documentURI読取専用

文書の場所を文字列で返します。

Document.embeds読取専用

HTMLCollection で、現在の文書に含まれる埋め込まれた <embed> 要素のリストを返します。

Document.firstElementChild (en-US) 読取専用

現在の文書における最初の子要素を返します。

Document.fonts

現在の文書の FontFaceSet (en-US) インターフェイスを返します。

Document.forms読取専用

HTMLCollection で現在の文書の <form> 要素を返します。

Document.fullscreenElement 読取専用

この文書で現在全画面モードになっている要素です。

Document.head読取専用

現在の文書の <head> 要素を返します。

Document.hidden読取専用

このページが非表示と見なされているかどうかを論理値で返します。

Document.images読取専用

HTMLCollection で、現在の文書の画像のリストを返します。

Document.implementation読取専用

現在の文書に関連付けられた DOM 実装を返します。

Document.lastElementChild (en-US) 読取専用

現在の文書における最後の子要素を返します。

HTMLCollection で、文書内のすべてのハイパーリンクのリストを返します。

Document.mozSyntheticDocument (en-US)  Non-Standard

単独の画像、動画、音声ファイルなど、文書が合成されたものである限り true を返します。

Document.pictureInPictureElement (en-US) 読取専用

この文書で現在、ピクチャインピクチャモードで表示されている要素 (Element) を返します。

Document.pictureInPictureEnabled (en-US) 読取専用

ピクチャインピクチャ機能が有効であれば true を返します。

Document.plugins読取専用

HTMLCollection で、利用可能なプラグインのリストを返します。

Document.pointerLockElement 読取専用

ポインターがロックされている場合、マウスイベントのターゲットとして設定された要素を返します。ロック町の場合、ポインターがロックされていない場合、ターゲットが他の文書にある場合は null を返します。

Document.featurePolicy  Experimental 読取専用

特定の文書に適用される機能ポリシーを簡単に導入するための API を提供する FeaturePolicy (en-US) インターフェイスを返します。

Document.scripts読取専用

HTMLCollection で、文書内のすべての <script> 要素を返します。

Document.scrollingElement読取専用

文書をスクロールする Element への参照を返します。

Document.styleSheets 読取専用

StyleSheetList で、文書で明示的にリンクされているスタイルシートや、文書に埋め込まれているスタイルシート(CSSStyleSheet オブジェクトのリスト)を返します。

Document.timeline (en-US)  Experimental 読取専用

タイムラインを DocumentTimeline (en-US) の特別なインスタンスで返します。これはページの読み込み時に自動的に生成されます。

Document.visibilityState読取専用

文書の可視性を表す string を返します。 visible, hidden, prerender, unloaded のいずれかの値になります。

HTML 文書向けの拡張

HTML 文書用の Document インターフェイスは HTMLDocument インターフェイスから継承されていたり、HTML5 文書向けに拡張されていたりします。

Document.cookie

文書のクッキーをセミコロンで区切られたリストで返すか、単一のクッキーを設定するかします。

Document.defaultView読取専用

window オブジェクトへの参照を返します。

Document.designMode

文書全体を編集可能かを取得/設定します。

Document.dir

文書の書字方向 (rtl/ltr) を取得/設定します。

Document.domain  Deprecated

現在の文書のドメインを取得/設定します。

Document.lastModified読取専用

文書の最終更新日を返します。

Document.location読取専用

現在の文書の URI を返します。

Document.readyState読取専用

文書の読み込み状況を表す文字列を返します。

Document.referrer読取専用

このページへリンクしたページの URI を返します。

Document.title

現在の文書のタイトルを設定または取得します。

Document.URL読取専用

現在の文書の URL を含む文字列を返します。

イベントハンドラー

Document インターフェイスは GlobalEventHandlers で定義されているその他のイベントハンドラーで拡張されています。

Document.onafterscriptexecute  Non-Standard

afterscriptexecute イベント用のイベントハンドラーを表します。

Document.onbeforescriptexecute  Non-Standard

beforescriptexecute イベント用のイベントハンドラーを表します。

Document.oncopy  Non-Standard

copy イベント用のイベントハンドラーを表します。

Document.oncut  Non-Standard

cut イベント用のイベントハンドラーを表します。

Document.onfullscreenchange

イベントハンドラーで、 fullscreenchange イベントが発行されたときに呼び出されるコードを表します。

Document.onfullscreenerror

イベントハンドラーで、 fullscreenerror イベントが発行されたときに呼び出されるコードを表します。

Document.onpaste  Non-Standard

paste イベント用のイベントハンドラーを表します。

Document.onreadystatechange

readystatechange イベント用のイベントハンドラーを表します。

GlobalEventHandlers.onselectionchange  Experimental

イベントハンドラーで、 selectionchange イベントが発行されたときに呼び出されるコードを表します。

Document.onvisibilitychange (en-US)

イベントハンドラーで、 visibilitychange イベントが発行されたときに呼び出されるコードを表します。

非推奨のプロパティ

Document.alinkColor  Deprecated

文書本文内のアクティブなリンクの色を取得または設定します。

Document.all  Deprecated   Non-Standard

文書内のすべての要素にアクセスできます。文書ノードを起点とする HTMLAllCollection を返します。これは古い標準外のプロパティですので、使用しないようにしてください。

Document.anchors  Deprecated 読取専用

文書内のすべてのアンカーのリストを返します。

Document.applets  Deprecated 読取専用

文書内にあるアプレットのリスト (出現順) を返します。

Document.bgColor  Deprecated

現在の文書の背景色を取得または設定します。

Document.charset  Deprecated 読取専用

Document.characterSet の別名です。代わりに Document.characterSet を使用してください。

Document.fgColor  Deprecated

現在の文書の前景色または文字色を取得/設定します。

Document.fullscreen  Deprecated

文書が全画面モードであるときに、true になります。

Document.height  Non-Standard   Deprecated

現在の文書の高さを取得/設定します。

Document.inputEncoding  Deprecated 読取専用

Document.characterSet の別名です。代わりにそちらを使用してください。

Document.lastStyleSheetSet  Deprecated 読取専用

直前に有効であったスタイルシートセットの名称を返します。 selectedStyleSheetSet に値を設定してスタイルシートを変更するまで、この値は null になります。

Document.linkColor  Deprecated

document 内のハイパーリンクの色を取得/設定します。

Document.preferredStyleSheetSet  Deprecated 読取専用

ページの作者によって設定された、優先的なスタイルシートを返します。

Document.rootElement  Deprecated

Document.documentElement と同様ですが、 <svg> ルート要素専用です。こちらのプロパティを代わりに使用してください。

Document.selectedStyleSheetSet  Deprecated

現在どのスタイルシートセットを使用しているかを返します。

Document.styleSheetSets  Deprecated 読取専用

文書で使用できるスタイルシートセットのリストを返します。

Document.vlinkColor  Deprecated

訪問済みのハイパーリンクの色を取得/設定します。

Document.width  Non-Standard   Deprecated

現在の文書の幅を返します。

Document.xmlEncoding (en-US)  Deprecated

XML 宣言によって決められたエンコーディングを返します。

Document.xmlStandalone  Deprecated

XML 宣言で文書がスタンドアロンである (: DTD の外部パートが文書のコンテンツに影響する) 場合に true を、そうでない場合に false を返します。

Document.xmlVersion  Deprecated

XML 宣言で指定されたバージョン番号、または宣言が省略されている場合に "1.0" を返します。

メソッド

このインターフェイスは、Node インターフェイスおよび EventTarget インターフェイスのメソッドを継承します。

Document.adoptNode()

外部文書からノードを取り込みます。

Document.append() (en-US)

文書の最後の子の後に Node オブジェクトまたは DOMString オブジェクトの集合を挿入します。

Document.captureEvents()  Deprecated

Window.captureEvents をご覧ください。

Document.caretPositionFromPoint()

キャレットを含む DOM ノードと、そのノード内でのキャレットの文字オフセットを含む CaretPosition オブジェクトを返します。

Document.caretRangeFromPoint()  Non-Standard

指定した座標にある文書の断片の Range オブジェクトを取得します。

Document.createAttribute() (en-US)

新しい Attr オブジェクトを生成して、返します。

Document.createAttributeNS() (en-US)

指定した名前空間に新しい属性ノードを生成して、返します。

Document.createCDATASection()

新しい CDATA ノードを生成して、返します。

Document.createComment()

新しいコメントノードを生成して、返します。

Document.createDocumentFragment()

新しい文書断片を生成します。

Document.createElement()

指定したタグ名で新しい要素を生成します。

Document.createElementNS()

指定したタグ名およびネームスペース URI で、新しい要素を生成します。

Document.createEntityReference()  Deprecated

新しい Entity Reference オブジェクトを生成して、返します。

Document.createEvent()

Event オブジェクトを生成します。

Document.createNodeIterator()

NodeIterator オブジェクトを生成します。

Document.createProcessingInstruction()

新しい ProcessingInstruction オブジェクトを生成します。

Document.createRange()

Range オブジェクトを生成します。

Document.createTextNode()

テキストノードを生成します。

Document.createTouch()  Deprecated

Touch オブジェクトを生成します。

Document.createTouchList()  Deprecated

TouchList オブジェクトを生成します。

Document.createTreeWalker() (en-US)

TreeWalker オブジェクトを生成します。

Document.elementFromPoint()

指定された座標の最上位の要素を返します。

Document.elementsFromPoint()

指定された座標にあるすべての要素の配列を返します。

Document.enableStyleSheetsForSet()  Deprecated

指定したスタイルシートセットのスタイルシートを有効化します。

Document.exitPictureInPicture() (en-US)

浮動ピクチャーインピクチャーウィンドウから動画を取り出し、元のコンテナーに戻します。

Document.exitPointerLock()  Experimental

ポインターロックを解放します。

Document.getAnimations()

現在実行中であるすべての Animation オブジェクトの配列を返します。この対象要素は、document の子孫要素です。

Document.getBoxQuads() Experimental

このノードの CSS フラグメントを表す DOMQuad (en-US) オブジェクトのリストを返します。

Document.getElementById()

識別された要素のオブジェクト参照を返します。

Document.getElementsByClassName()

指定されたクラス名を持つ要素のリストを返します。

Document.getElementsByTagName()

指定されたタグ名を持つ要素のリストを返します。

Document.getElementsByTagNameNS()

指定されたタグ名と名前空間を持つ要素のリストを返します。

Document.getSelection()

ユーザーが現在選択しているテキスト範囲、または現在のキャレットの位置を表す Selection オブジェクトを返します。

Document.hasStorageAccess()  Experimental

文書が自分自身 (first-party) のストレージにアクセスしたかどうかを示す論理値で解決する Promise を返します。

Document.importNode()

外部文書のノードの複製を返します。

Document.normalizeDocument()  Deprecated

エンティティの置換や、テキストノードの正規化などを行います。

Document.prepend() (en-US)

文書の最初の子の前に、 Node オブジェクトまたは DOMString オブジェクトを挿入します。

Document.querySelector()

指定したセレクターに一致する、文書内で最初の要素ノードを返します。

Document.querySelectorAll()

指定したセレクターに一致する、文書内のすべての要素ノードのリストを返します。

Document.releaseCapture()  Non-Standard

この文書内の要素でマウスキャプチャを行っている場合、マウスキャプチャを解放します。

Document.releaseEvents()  Non-Standard   Deprecated

Window.releaseEvents() をご覧ください。

Document.replaceChildren() (en-US)

文書の既存の子を、指定された新しい子の集合で置き換えます。

Document.requestStorageAccess()

自分自身 (first-party) のストレージへのアクセスが許可された場合は解決し、拒否された場合は拒否される Promise を返します。

Document.mozSetImageElement() (en-US) Non-Standard

指定した ID を持つ要素の背景画像として使用する要素を変更できます。

Document インターフェイスは、XPathEvaluator (en-US) インターフェイスによって拡張されています。

Document.createExpression()

(繰り返し) 評価に使用できる XPathExpression (en-US) をコンパイルします。

Document.createNSResolver()

XPathNSResolver (en-US) オブジェクトを生成します。

Document.evaluate()

XPath 表現を評価します。

HTML 文書向けの拡張

HTML 文書用の Document インターフェイスは HTMLDocument インターフェイスから継承する、あるいは HTML5 文書向けに拡張されています。

Document.clear()  Non-Standard   Deprecated

最近の Firefox や Internet Explorer を含む大部分の現行ブラウザーは、何も行いません。

Document.close()

書き込み用の文書ストリームを閉じます。

Document.execCommand()  Deprecated

編集可能な文書で、フォーマットコマンドを実行します。

Document.getElementsByName()

(引数で) 与えられた名前 (name) を持つ要素のリストを返します。

Document.hasFocus()

指定した文書内にフォーカスがある場合に、 true を返します。

Document.open()

書き込み用の文書ストリームを開きます。

Document.queryCommandEnabled() (en-US)  Deprecated

現在の領域でフォーマットコマンドを実行できる場合に、 true を返します。

Document.queryCommandIndeterm()  Deprecated

現在の領域でフォーマットコマンドの状態が不確定である場合に true を返します。

Document.queryCommandState()  Deprecated

現在の領域でフォーマットコマンドを実行した場合に true を返します。

Document.queryCommandSupported()  Deprecated

現在の領域でフォーマットコマンドをサポートしている場合に、true を返します。

Document.queryCommandValue()  Deprecated

指定したフォーマットコマンドについて、現在の領域における値を返します。

Document.write()

文書にテキストを書き込みます。

Document.writeln()

文書にテキスト行を書き込みます。

イベント

これらのイベントを待ち受けするには、 addEventListener() を使用するか、本インターフェイスの onイベント名 プロパティへイベントリスナーを代入するかしてください。

scroll

文書のビューまたは要素がスクロールしたときに発行されます。 onscroll プロパティからも利用できます。

visibilitychange

タブの内容の表示・非表示の状態が切り替わった時に発行されます。 onvisibilitychange (en-US) プロパティからも利用できます。

wheel (en-US)

ユーザーがポインティングデバイス (通常はマウス) のホイールボタンを回転した時に発行されます。 onwheel プロパティからも利用できます。

アニメーションイベント

animationcancel

アニメーションが予期せず中断された時に発行されます。 onanimationcancel (en-US) プロパティからも利用できます。

animationend

アニメーションが正常に完了したときに発行されます。 onanimationend (en-US) プロパティからも利用できます。

animationiteration

アニメーションの1周期が完了したときに発行されます。 onanimationiteration (en-US) プロパティからも利用できます。

animationstart

アニメーションが始まった時に発行されます。 onanimationstart (en-US) プロパティからも利用できます。

クリップボードイベント

copy

ユーザーがブラウザーのユーザーインターフェイスからコピー操作を開始した時に発行されます。 oncopy プロパティからも利用できます。

cut

ユーザーがブラウザーのユーザーインターフェイスから切り取り操作を開始したときに発行されます。 oncut プロパティからも利用できます。

paste

ユーザーがブラウザーのユーザーインターフェイスから貼り付け操作を開始したときに発行されます。 onpaste プロパティからも利用できます。

ドラッグ&ドロップイベント

drag

要素またはテキストの選択範囲をユーザーがドラッグしている間、数百ミリ秒ごとに発行されます。 ondrag プロパティからも利用できます。

dragend

ドラッグ操作が終了したとき (マウスボタンを離したときやエスケープキーを押したとき) に発行されます。 ondragend プロパティからも利用できます。

dragenter

ドラッグ中の要素またはテキストの選択範囲が妥当なドロップ対象に入ったときに発行されます。 ondragenter プロパティからも利用できます。

dragleave

ドラッグ中の要素またはテキストの選択範囲が妥当なドロップ対象から外れたときに発行されます。 ondragleave プロパティからも利用できます。

dragover

要素またはテキストの選択範囲が妥当なドロップ対象の上をドラッグされているときに (数ミリ秒ごとに) 発行されます。 ondragover プロパティからも利用できます。

dragstart

ユーザーが要素またはテキストの選択範囲のドラッグを開始したときに発行されます。 ondragstart プロパティからも利用できます。

drop

要素またはテキストの選択範囲が妥当なドロップ対象にドロップされたときに発行されます。 ondrop プロパティからも利用できます。

全画面イベント

fullscreenchange

Document全画面 (en-US)モードへ移行したとき、または解除されたときに発行されます。 onfullscreenchange プロパティからも利用できます。

fullscreenerror

全画面 (en-US)モードへ切り替えようとしたとき、または解除しようとしたときにエラーが発生した場合に発行されます。 onfullscreenerror プロパティからも利用できます。

キーボードイベント

keydown

キーが押されたときに発行されます。 onkeydown プロパティからも利用できます。

keypress (en-US)

文字値を生成するキーが押下されたときに発行されます。 Deprecated onkeypress プロパティからも利用できます。

keyup

キーを離したときに発行されます。 onkeyup プロパティからも利用できます。

ロード&アンロードイベント

DOMContentLoaded

文書が完全に読み込まれて解釈されたときに、スタイルシート、画像、サブフレームの読み込みが完了するのを待たずに発行されます。

readystatechange

文書の readyState 属性が変更されたときに発行されます。 onreadystatechange プロパティからも利用できます。

ポインターイベント

gotpointercapture

setPointerCapture() を使用して要素がポインターをキャプチャしたときに発行されます。 ongotpointercapture プロパティからも利用できます。

lostpointercapture

キャプチャされたポインターが解放されたときに発行されます。 onlostpointercapture プロパティからも利用できます。

pointercancel

ポインターイベントがキャンセルされたときに発行されます。 onpointercancel プロパティからも利用できます。

pointerdown

ポインターがアクティブになったときに発行されます。 onpointerdown プロパティからも利用できます。

pointerenter

ポインターが要素やその子孫のヒットテスト境界の中へ移動したときに発行されます。 onpointerenter プロパティからも利用できます。

pointerleave

ポインターが要素のヒットテスト境界の外へ移動したときに発行されます。 onpointerleave プロパティからも利用できます。

pointerlockchange

ポインターがロックまたはアンロックされたときに発行されます。 onpointerlockchange プロパティからも利用できます。

pointerlockerror

ポインターをロックしようとして失敗したときに発行されます。 onpointerlockerror プロパティからも利用できます。

pointermove

ポインターの座標が変化したときに発行されます。 onpointermove プロパティからも利用できます。

pointerout

ポインターが (訳あって) 要素の ヒットテスト 境界の外へ移動したときに発行されます。 onpointerout プロパティからも利用できます。

pointerover

ポインターが要素のヒットテスト境界の中へ移動したときに発行されます。 onpointerover プロパティからも利用できます。

pointerup

ポインターがアクティブではなくなったときに発行されます。 onpointerup プロパティからも利用できます。

選択イベント

selectionchange

文書でのテキスト選択範囲が変化したときに発行されます。 onselectionchange プロパティからも利用できます。

selectstart

ユーザーが新しい選択を開始したときに発行されます。 onselectstart (en-US) プロパティからも利用できます。

タッチイベント

touchcancel

1 つ以上のタッチ点が実装固有の方法で中断された場合に発行されます (例えば、作成されたタッチ点が多すぎた場合など)。 ontouchcancel プロパティからも利用できます。

touchend

1 つ以上のタッチ点がタッチ面から取り除かれたときに発行されます。 ontouchend プロパティからも利用できます。

touchmove

1 つ以上のタッチ点がタッチ面に沿って移動したときに発行されます。 ontouchmove (en-US) プロパティからも利用できます。

touchstart

1 つ以上のタッチ点がタッチ面に配置されたときに発行されます。 ontouchstart プロパティからも利用できます。

トランジションイベント

transitioncancel

CSS トランジションがキャンセルされたときに発行されます。 ontransitioncancel プロパティからも利用できます。

transitionend

CSS トランジションが完了したときに発行されます。 ontransitionend プロパティからも利用できます。

transitionrun

CSS トランジションが初めて作成されたときに発行されます。 ontransitionrun プロパティからも利用できます。

transitionstart

Fired when a CSS トランジションが実際に開始されたときに発行されます。 ontransitionstart プロパティからも利用できます。

標準外の拡張 Non-Standard

非標準: この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。

Firefox のメモ

Firefox は、いくつかの標準外のメソッドを定義しています。

Document.execCommandShowHelp() Deprecated

このメソッドは何も行わずに例外が発生することから、 Gecko 14.0 (Firefox 14.0 / Thunderbird 14.0 / SeaMonkey 2.11) で削除されました。

Document.getBoxObjectFor()  Deprecated

代わりに Element.getBoundingClientRect() メソッドを使用してください。

Document.loadOverlay() Deprecated

XUL overlay を動的に読み込みます。これは XUL 文書のみで動作します。

Document.queryCommandText() Deprecated

このメソッドは何も行わずに例外が発生することから、Gecko 14 (Firefox 14 / Thunderbird 14 / SeaMonkey 2.11) で削除しました。

Internet Explorer のメモ

Microsoft は、標準外のプロパティを定義しています。

Document.fileSize Non-Standard   Deprecated

文書の長さをバイト単位で返します。 Internet Explorer 11 より、このプロパティには対応していません。MSDN をご覧ください。

仕様書

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

ブラウザーの互換性

BCD tables only load in the browser