Document
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2015年7月.
* Some parts of this feature may have varying levels of support.
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.featurePolicyExperimental 読取専用-
文書に適用されている機能ポリシーを
FeaturePolicyインターフェイスで返します。 Document.firstElementChild読取専用-
現在の文書における最初の子要素を返します。
Document.fonts-
現在の文書の
FontFaceSetインターフェイスを返します。 Document.forms読取専用-
HTMLCollectionで現在の文書の<form>要素を返します。 Document.fragmentDirective読取専用-
現在の文書の
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,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 を含む文字列を返します。
- 名前付きプロパティ
-
文書内の一部の要素は、プロパティとしても公開されます。
- 個々の
<embed>,<form>,<iframe>,<img>,<object>要素では、そのname(空でない場合)が公開されます。 例えば、文書内に<form name="my_form">がある場合、document["my_form"](および同等のdocument.my_form)はその要素への参照を返します。 - 個々の
<object>要素では、そのid(空でない場合)が公開されます。 - 個々の
<img>要素で空でないnameがある場合は、id(空でない場合)が公開されます。
プロパティが単一の要素に対応している場合、その要素が直接返されます。その単一の要素が iframe の場合、その
contentWindowが代わりに返されます。プロパティが複数の要素に対応している場合、それらすべてを含むHTMLCollectionが返されます。 - 個々の
非推奨のプロパティ
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非推奨; 読取専用 非標準-
直前に有効であったスタイルシートセットの名称を返します。
selectedStyleSheetSetに値を設定してスタイルシートを変更するまで、この値はnullになります。 Document.linkColor非推奨;-
文書内のハイパーリンクの色を取得/設定します。
Document.preferredStyleSheetSet非推奨; 読取専用 非標準-
ページの作者によって設定された、推奨されるスタイルシートを返します。
Document.rootElement非推奨;-
Document.documentElementと同様ですが、<svg>ルート要素専用です。こちらのプロパティを代わりに使用してください。 Document.selectedStyleSheetSet非推奨; 非標準-
現在どのスタイルシートセットを使用しているかを返します。
Document.styleSheetSets非推奨; 読取専用 非標準-
文書で使用できるスタイルシートセットのリストを返します。
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 非標準-
過去 3 つのエポックのそれぞれから 1 つずつ、ユーザーのトップトピックを表すオブジェクトの配列で履行されるプロミスを返します。既定では、このメソッドは、呼び出し側が監視している現在のページの訪問をブラウザーに記録させるので、後でページのホスト名をトピックの計算に使用することができます。詳細はトピック API を参照してください。
Document.captureEvents()非推奨;-
Window.captureEventsをご覧ください。 Document.caretPositionFromPoint()-
キャレットを含む DOM ノードと、そのノード内でのキャレットの文字オフセットを含む
CaretPositionオブジェクトを返します。 Document.caretRangeFromPoint()非標準-
指定した座標にある文書の断片の
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()非推奨; 非標準-
Touchオブジェクトを生成します。 Document.createTouchList()非推奨; 非標準-
TouchListオブジェクトを生成します。 Document.createTreeWalker()-
TreeWalkerオブジェクトを生成します。 Document.elementFromPoint()-
指定された座標の最上位の要素を返します。
Document.elementsFromPoint()-
指定された座標にあるすべての要素の配列を返します。
Document.enableStyleSheetsForSet()非推奨; 非標準-
指定したスタイルシートセットのスタイルシートを有効化します。
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.moveBefore()-
指定された
Nodeを、ノードを除去して挿入し直すことなく、指定された参照ノードの前に、直接の子としてDocumentDOM ノード内に移動します。 Document.mozSetImageElement()非標準-
指定した要素 ID の背景画像として使用している要素を変更することができます。
Document.prepend()-
文書の最初の子の前に、
Nodeオブジェクトまたは文字列の集合を挿入します。 Document.querySelector()-
指定したセレクターに一致する、文書内で最初の要素ノードを返します。
Document.querySelectorAll()-
指定したセレクターに一致する、文書内のすべての要素ノードのリストを返します。
Document.releaseCapture()非標準-
この文書内の要素でマウスキャプチャを行っている場合、マウスキャプチャを解放します。
Document.releaseEvents()非推奨;-
Window.releaseEvents()をご覧ください。 Document.replaceChildren()-
文書の既存の子を、指定された新しい子の集合で置き換えます。
Document.requestStorageAccess()-
サードパーティのコンテキスト(すなわち、
<iframe>に埋め込まれたもの)に読み込まれた文書が、分離されていないクッキーへのアクセスを要求できるようにします。これはユーザーエージェントが既定で、プライバシーを改善するためにサードパーティコンテキストで読み込まれたサイトによる分離されていないクッキーへのアクセスをブロックしている場合に使用します。 Document.requestStorageAccessFor()Experimental-
最上位のサイトが、同じ関連ウェブサイト設定内の別のウェブサイトから発信された埋め込みコンテンツの代わりに、サードパーティクッキーへのアクセスをリクエストできるようにします。
Document.startViewTransition()-
新しいビュー遷移を開始し、それを表すための
ViewTransitionオブジェクトを返します。
Document インターフェイスは、XPathEvaluator インターフェイスによって拡張されています。
Document.createExpression()-
(繰り返し) 評価に使用できる
XPathExpressionをコンパイルします。 Document.createNSResolver()非推奨;-
入力ノードをそのまま返します。
Document.evaluate()-
XPath 表現を評価します。
HTML 文書向けの拡張
HTML 文書用の Document インターフェイスは HTMLDocument インターフェイスから継承または拡張されています。
Document.clear()非推奨;-
このメソッドは何もしません。
Document.close()-
書き込み用の文書ストリームを閉じます。
Document.execCommand()非推奨;-
編集可能な文書で、フォーマットコマンドを実行します。
Document.getElementsByName()-
(引数で) 与えられた名前 (name) を持つ要素のリストを返します。
Document.hasFocus()-
指定した文書内にフォーカスがある場合に、
trueを返します。 Document.open()-
書き込み用の文書ストリームを開きます。
Document.queryCommandEnabled()非推奨; 非標準-
現在の領域でフォーマットコマンドを実行できる場合に、 true を返します。
Document.queryCommandIndeterm()非推奨;-
現在の領域でフォーマットコマンドの状態が不確定である場合に true を返します。
Document.queryCommandState()非推奨; 非標準-
現在の領域でフォーマットコマンドを実行した場合に true を返します。
Document.queryCommandSupported()非推奨; 非標準-
現在の領域でフォーマットコマンドをサポートしている場合に、true を返します。
Document.queryCommandValue()非推奨;-
指定したフォーマットコマンドについて、現在の領域における値を返します。
Document.write()非推奨;-
文書にテキストを書き込みます。
Document.writeln()非推奨;-
文書にテキスト行を書き込みます。
静的メソッド
このインターフェイスには Node および EventTarget インターフェイスから継承したメソッドもあります。
Document.parseHTML()-
XSS 対策とサニタイズを行った、HTML の文字列から新しい
Documentオブジェクトを作成します。 Document.parseHTMLUnsafe()-
サニタイズ処理を行わずに、HTML の文字列から新しい
Documentオブジェクトを作成します。 文字列には宣言敵にシャドウルートを含むことができます。
イベント
これらのイベントを待ち受けするには、 addEventListener() を使用するか、本インターフェイスの onイベント名 プロパティへイベントリスナーを代入するかしてください。下記の一覧に掲載されているイベントの他に、文書ツリー内のノードから多くのイベントがバブリングする可能性があります。
afterscriptexecute非標準 非推奨;-
静的な
<script>要素でスクリプトの実行が完了した時に発生します。 beforescriptexecute非標準 非推奨;-
静的な
<script>で実行を開始しようとしている時に発生します。 prerenderingchangeExperimental-
事前レンダリングされた文書がアクティブになった(ユーザーがページを表示した)ときに発行されます。
securitypolicyviolation-
コンテンツセキュリティポリシーに違反した場合に発行されます。
visibilitychange-
タブの内容の表示・非表示の状態が切り替わった時に発行されます。
全画面イベント
fullscreenchange-
Documentが全画面モードへ移行したとき、または解除されたときに発行されます。 fullscreenerror-
全画面モードへ切り替えようとしたとき、または解除しようとしたときにエラーが発生した場合に発行されます。
ロード&アンロードイベント
DOMContentLoaded-
文書が完全に読み込まれて解釈されたときに、スタイルシート、画像、サブフレームの読み込みが完了するのを待たずに発行されます。
readystatechange-
文書の
readyState属性が変更されたときに発行されます。
ポインターロックイベント
pointerlockchange-
ポインターがロックまたはアンロックされたときに発行されます。
pointerlockerror-
ポインターをロックしようとして失敗したときに発行されます。
スクロールイベント
scroll-
文書のビューまたは要素がスクロールされたときに発行されます。
scrollend-
文書のビューまたは要素のスクロールが完全に終了したときに発行されます。
scrollsnapchangeExperimental-
スクロール操作の終わりに、新しいスクロールスナップターゲットが選択されたときに、スクロールコンテナーで発行されます。
scrollsnapchangingExperimental-
新しいスクロールスナップターゲットが待機しているとブラウザーが判断したとき、つまり、現在のスクロールジェスチャーが終わると、スクロールコンテナーで発行されます。
選択イベント
selectionchange-
文書でのテキスト選択範囲が変化したときに発行されます。
バブリングするイベント
バブルするイベントすべてが Document オブジェクトに到達するわけではありません。以下のイベントだけが Document オブジェクトに到達し、待ち受けすることができます。
abortauxclickbeforeinputbeforematchbeforetoggleblurcancelcanplaycanplaythroughchangeclickclosecontextlostcontextmenucontextrestoredcopycuechangecutdblclickdragdragenddragenterdragleavedragoverdragstartdropdurationchangeemptiedendederrorfocusformdatainputinvalidkeydownkeypresskeyuploadloadeddataloadedmetadataloadstartmousedownmouseentermouseleavemousemovemouseoutmouseovermouseuppastepauseplayplayingprogressratechangeresetresizescrollscrollendsecuritypolicyviolationseekedseekingselectslotchangestalledsubmitsuspendtimeupdatetogglevolumechangewaitingwheel
仕様書
ブラウザーの互換性
Loading…