DOM
::Document インターフェイス
編集:2022.11.09 by T.A.
→、
Document ノードは、単に 文書(document)とも称される。
ParentNode、NonElementParentNode インターフェイスを含んでいます(includes)。
- new Document()
- 新しい Document オブジェクトを作成して返します。
Node インターフェイスおよび EventTarget インターフェイスのプロパティも継承しています。
- Document.activeElement 読取専用
- Document で現在フォーカスされている要素、つまり、ユーザーが何かを入力した場合にキー ストローク イベントを取得する要素を返します。
- Document.body
- Document の <body> または <frameset> ノードを返します。そのような要素がなければ null になります。
- Document.characterSet 読取専用
- Document の文字エンコーディングを表す文字列を返します。
- Document.childElementCount 読取専用
- Document の子要素の数を返します。
- Document.children 読取専用
- Document の子要素の HTMLCollection を返します。
- Document.compatMode 読取専用 実験的
- Document が Quirks モード(互換モード)か標準準拠モードのどちらで表示されているかを示します。
- Document.contentType 読取専用 実験的
- Document の MIME ヘッダーから Content-Type を返します。
- Document.currentScript 読取専用
- Document で現在処理中で、JavaScript モジュールではないスクリプトの <script> 要素を返します。(モジュールの場合は代わりに import.meta を使用してください。)
- Document.doctype 読取専用
- Document の文書型宣言(DTD)を返します。
- Document.documentElement 読取専用
- Document の直接の子である文書要素 Element を返します。
- Document.documentURI 読取専用
- Document の位置を文字列で返します(URL を直列化する)。
- Document.embeds 読取専用
- Document の埋め込み <embed> 要素のリストを HTMLCollection で返します。
- Document.featurePolicy 読取専用 実験的
- Document に適用される機能ポリシーを見ることができる簡単な API を提供する FeaturePolicy オブジェクトを返します。
- Document.firstElementChild 読取専用
- Document の最初の子要素を Element で返します。
- Document.fonts
- Document の FontFaceSet インターフェイスを返します。
- Document.forms 読取専用
- Document 内の <form> 要素のリストを HTMLCollection で返します。
- Document.fullscreenElement 読取専用
- Document の全スクリーン モードになっている要素を Element で返します。
- Document.fullscreenEnabled
- Document で全画面(フルスクリーン)モードが使用できるか否かを示します。
- Document.head 読取専用
- Document の <head> 要素を HTMLHeadElement で返します。
- Document.hidden 読取専用
- Document が非表示と見なされているか否かを論理値(Boolean)で返します。
- Document.images
- Document 内の <img> 要素のリストを HTMLCollection で返します。
- Document.implementation 読取専用
- document の DOMImplementation オブジェクトを返す。
- Document.lastElementChild 読取専用
- document の最後の子要素を Element で返します。
- Document.lastStyleSheetSet 読取専用 廃止
- Document の最後に有効化されたスタイルシート セットを返します
- Document.links 読取専用
- Document で <a>、<area> 要素で、href 属性を有する要素のリストを HTMLCollection で返します。
- Document.mozSyntheticDocument 非標準 非推奨
- Document が合成ドキュメントであるか否かを示します。
- Document.pictureInPictureElement 読取専用
- Document で現在、ピクチャ イン ピクチャ モードで表示されている要素を Element で返します。
- Document.pictureInPictureEnabled 読取専用
- Document でピクチャ イン ピクチャ機能が有効であれば true を返します。
- Document.plugins 読取専用
- Document 内で利用可能なプラグインのリストを HTMLCollection で返します。
- Document.pointerLockElement 読取専用 実験的
- Document でポインター ロックされている要素を Element で返します。
- Document.preferredStyleSheetSet 読取専用 廃止
- ¶ページの作者によって設定された、優先的なスタイルシートを返します。
- Document.scripts 読取専用
- Document 内の <script> 要素のリストを HTMLCollection で返します。
- Document.scrollingElement 読取専用
- Document 内のスクロール可能な要素を Element で返します。
- Document.styleSheets 読取専用
- Document または ShadowRoot に明示的に、リンクまたは埋め込まれたスタイルシートのリストを StyleSheetList で返します。
- Document.selectedStyleSheetSet 廃止
- ¶Document で現在使われているスタイルシート セットの名前を返します。
- Document.styleSheetSets 読取専用 廃止
- Document で使用できるスタイルシート セットのリストを返します。
- Document.timeline 読取専用 実験的
- Document が開いてからの経過時間データを DocumentTimeline で返します。
- Document.undoManager 読取専用 実験的
- ¶不明
- Document.visibilityState 読取専用
- Document の可視性を表す文字列を返します。
Document インターフェイスは、ParentNode インターフェイスから派生しています。
HTML 文書向けの拡張
HTML 文書用の Document インターフェイスは HTMLDocument インターフェイスから継承する、あるいは HTML5 文書向けに拡張されています。
- Document.cookie
- Document に関連付けられたクッキーを読み取り/書き込みします。
Edgeでは、ローカルではクッキーは取り扱えないようです。
- Document.defaultView 読取専用
- Document に関連付けられている Window オブジェクトを返します。存在しない場合は null を返します。
- Document.designMode
- Document 全体を編集可能にするかどうかを文字列で取得/設定をします。
- Document.dir
- Document の書字方向を文字列で取得/設定します。
- Document.domain 非推奨
- Document のセキュリティ検査用に利用される現在のドメインを文字列で返します。
- Document.lastModified 読取専用
- Document の最終改変日時を、利用者の地域標準時に換算した結果を文字列で "MM/DD/YYYY hh:mm:ss" の形式で返します。
- Document.location 読取専用
- Document の所在を伴う Location オブジェクトを返します。
設定して、別のページへナビゲートできます。
- Document.readyState 読取専用
- Document の読み込み状態を文字列で返します。
- Document.referrer 読取専用
- Document へリンクしていたページの URL を文字列で返します。
- Document.title
- Document の title を返します。
title は[HTML 用には title 要素/SVG 用には SVG title 要素]にて与えられます。
- Document.URL 読取専用
- Document の URL を表す文字列を返します(URL を直列化する)。
非推奨のプロパティ
- Document.anchors 読取専用 非推奨
- Document 内のすべてのアンカーの HTMLCollection を返します。
- Document.alinkColor 廃止
- 文書本文内のアクティブなリンクの色を取得または設定します。
- Document.all 廃止 非推奨
- 文書内のすべての要素にアクセスできます。文書ノードを起点とする HTMLAllCollection を返します。これは古い標準外のプロパティですので、使用しないようにしてください。
- Document.applets 廃止 読取専用
- 文書内にあるアプレットのリスト (出現順) を返します。
- Document.bgColor 廃止
- 現在の文書の背景色を取得または設定します。
- Document.charset 廃止 読取専用
- Document.characterSet の別名です。代わりに Document.characterSet を使用してください。
- Document.domConfig 廃止
- DOMConfiguration オブジェクトを返すはずです。
- Document.fgColor 廃止
- 現在の文書の前景色または文字色を取得 / 設定します。
- Document.fullscreen 廃止
- 文書が 全画面モード であるときに、true になります。
- Document.height 非推奨 廃止
- 現在の文書の高さを取得 / 設定します。
- Document.inputEncoding 廃止 読取専用
- Document.characterSet の別名です。代わりに Document.characterSet を使用してください。
- Document.linkColor 廃止
- document 内のハイパーリンクの色を取得/設定します。
- Document.rootElement 廃止
- Document.documentElement と同様ですが、<svg> ルート要素専用です。こちらのプロパティを代わりに使用してください。
- Document.vlinkColor 廃止
- 訪問済みのハイパーリンクの色を取得/設定します。
- Document.width 非推奨 廃止
- 現在の文書の幅を返します。
- Document.xmlEncoding 廃止
- XML 宣言によって決められたエンコーディングを返します。
- Document.xmlStandalone 廃止 Gecko 10 で廃止
- XML 宣言で文書がスタンドアロンである (例: DTD の外部パートが文書のコンテンツに影響する) 場合に true を、そうでない場合に false を返します。
- Document.xmlVersion 廃止 Gecko 10 で廃止
- XML 宣言で指定されたバージョン番号、または宣言が省略されている場合に "1.0" を返します。
Node インターフェイスおよび EventTarget インターフェイスのメソッドを継承します。
- Document.adoptNode(node)
- 外部文書 Document からノード(Node)を取り込みます。
- Document.append(param1[, param2[, …[, paramN]]])
- Document の最後の子の後に、指定のNode オブジェクトまたは DOMString オブジェクトを挿入します。
- Document.captureEvents() 非推奨
- →Window.captureEvents をご覧ください。
- Document.caretPositionFromPoint(x, y) 実験的 [Edge]⛌
- Document でキャレットがある DOM ノードと、ノード内でキャレットあがある文字のオフセットを持つ CaretPosition オブジェクトを返します。
- Document.caretRangeFromPoint(x, y) 非標準 非推奨
- Document 内の指定座標にある文書の断片の Range オブジェクトを取得します。
- Document.createAttribute(属性名)
- HTML要素の指定の属性を作成し、その Attr オブジェクトを返します。
- Document.createAttributeNS()
- 指定した名前空間に新しい属性ノードを生成して返します。
- Document.createCDATASection(文字列)
- ¶新しい CDATA ノードを生成して返します。
- Document.createComment(文字列)
- 新しいコメント ノード(¶Comment)を生成して返します。
- Document.createDocumentFragment()
- 新しい文書断片(DocumentFragment)を生成して返します。
- Document.createElement(tagName[, options])
- 指定タグ名で新しい要素(Element)を生成して返します。
- Document.createElementNS(名前空間URI, 要素の型[, options])
- 指定タグ名と名前空間 URI で、新しい要素(Element)を生成して返します。
- Document.createEntityReference() 非推奨
- 新しい Entity Reference オブジェクトを生成して返します。
- Document.createEvent(イベント型)
- 指定された型の Event オブジェクトを生成して返します。
- Document.createNodeIterator(root[, Show選択[, filter]])
- 新しい NodeIterator オブジェクトを生成して返します。
- Document.createProcessingInstruction(target, data)
- 新しい ProcessingInstruction オブジェクトを生成して返します。
- Document.createRange()
- 新しい Range オブジェクトを生成して返します。
- Document.createTextNode(文字列)
- 新しい テキスト ノード(Text)を生成して返します。
- Document.createTouch(…) 非推奨
- 新しい Touch オブジェクトを生成して返します。
- Document.createTouchList() 非推奨
- 新しい TouchList オブジェクトを生成して返します。
- Document.createTreeWalker(root, …)
- 新しい TreeWalker オブジェクトを生成して返します。
- Document.elementFromPoint(x, y)
- Document で指定座標で最前面にある要素を Element で返します。
- Document.elementsFromPoint(x, y)
- Document で指定座標に存在するすべての要素を Element の配列で返します。
- Document.enableStyleSheetsForSet() 非推奨
- Document の指定スタイルシート セットのスタイルシートを有効化します。
- Document.exitPictureInPicture()
- Document のピクチャー イン ピクチャー モードを解除します。
- Document.exitPointerLock() 実験的
- Element.requestPointerLock() でリクエストされたポインター ロックを非同期に解放します。
- Document.getAnimations() 実験的 [Edge]⛌?
- Document の現在実行中であるすべての Animation オブジェクトの配列を返します。
- Document.getBoxQuads() 実験的
- Document のノードの CSS フラグメントを表す DOMQuad オブジェクトのリストを返します。
- Document.getElementById(ID名)
- Document の指定の id を持つ要素の Element オブジェクト参照を返します。
NonElementParentNodeの mixin による。
- Document.getElementsByClassName(クラス名)
- Document の指定のクラス名を含む要素のリストを HTMLCollection で返します。
- Document.getElementsByTagName(タグ名)
- Document の指定タグ名の要素のリストを HTMLCollection で返します。
- Document.getElementsByTagNameNS(名前空間URI, タグ名)
- Document の指定タグ名と名前空間を持つ要素のリストを HTMLCollection で返します。
- Document.getSelection()
- Document でユーザーが現在選択しているテキスト範囲、または現在のキャレットの位置を表す Selection オブジェクトを返します。
- Document.hasStorageAccess() 実験的
- Document が自分自身 first-party のストレージにアクセスしたかどうかを示す真偽値を解決する Promise を返します。
- Document.importNode(Node[, 深さFg])
- インポートする Node または DocumentFragment の複製を返します。
- Document.normalizeDocument() 非推奨
- ¶エンティティの置換や、テキスト ノードの正規化などを行います。
- Document.prepend(param1[, param2[, …[, paramN]]])
- Document の最初の子の前に、Node オブジェクトまたは DOMString オブジェクトを挿入します。
- Document.querySelector(セレクター名)
- Document の指定 CSS セレクターに一致する最初の要素を Element で返します。
- Document.querySelectorAll(セレクター名)
- Document の指定 CSS セレクターに一致する全ての要素ノードのリストを NodeList で返します。
Document インターフェイスは、XPathEvaluator インターフェイスによって拡張されています。
- Document.releaseCapture() 非標準 非推奨
- Document の要素でマウス キャプチャーを行っている場合に、マウス キャプチャーを解放します。
- Document.releaseEvents() 非標準 非推奨
- →Window.releaseEvents() をご覧ください。
- Document.replaceChildren(param1[, param2[, …[, paramN]]])
- Document の既存の子を、指定された新しい子のセットで置き換えます。
- Document.requestStorageAccess()
- 自分自身(first-party)のストレージへのアクセスが許可された場合は解決し、拒否された場合は拒否される Promise を返します。
- Document.routeEvent() 非推奨 廃止 Gecko 24 で廃止
- →Window.routeEvent() をご覧ください。
- Document.mozSetImageElement() 非標準 非推奨
- ¶指定した ID を持つ要素の背景画像として使用する要素を変更できます。
Document インターフェイスは、XPathEvaluator インターフェイスによって拡張されています。
- Document.createExpression(xpathText, namespaceURLMapper)
- ¶(繰り返し)評価に使用できる XPathExpressionをコンパイルします。XPathExpression を返す?
- Document.createNSResolver(node)
- 新しく XPathNSResolver オブジェクトを生成して返します。
- Document.evaluate(xpathExpression, …)
- XPath 表現を評価します。XPathResultを返す?。
HTML 文書向けの拡張
HTML 文書用の Document インターフェイスは HTMLDocument インターフェイスから継承する、あるいは HTML5 文書向けに拡張されています。
- Document.clear() 非標準 非推奨
- 最近の Firefox や Internet Explorer を含む大部分の現行ブラウザーは、何も行いません。
- Document.close()
- Document.open() で開かれた文書への書き込みを終了します。
- Document.execCommand(コマンド名, …) 非推奨
- 編集可能な文書で、フォーマット コマンドを実行します。
- Document.exitFullscreen()
- Document で、Element.requestFullscreen() によりフルスクリーンの効果を取り消します。
結果は promise で返されます。
- Document.getElementsByName(name名)
- Document 内の指定の名前(name属性)を持つ要素のリスト(NodeList コレクション)を返します。
- Document.hasFocus()
- Document に何れかの要素がフォーカスがあるか否かを Boolean で返します。
- document.open()
- 書き込み用の文書を開きます。
- Document.queryCommandEnabled() 非推奨
- 現在の領域でフォーマット コマンドを実行できるか否かを返します。
- Document.queryCommandIndeterm() 非推奨
- 現在の領域でフォーマット コマンドの状態が不確定である場合に true を返します。
- Document.queryCommandState() 非推奨
- 現在の領域でフォーマットコマンドを実行した場合に true を返します。
- Document.queryCommandSupported() 非推奨
- 現在の領域でフォーマットコマンドをサポートしている場合に、true を返します。
- Document.queryCommandValue() 非推奨
- 指定したフォーマットコマンドについて、現在の領域における値を返します。
- Document.write(HTMLテキスト)
- Document に指定のHTMLテキストを書き込みます。
- Document.writeln(HTMLテキスト)
- Document に指定のHTMLテキストを書き込み、改行もされます。
これらのイベントを待ち受けするには、addEventListener() を使用するか、本インターフェイスの onイベント名
プロパティへイベントリスナーを代入するかしてください。
以下にイベント名を示します:
- afterscriptexecute 非標準 非推奨
- 静的な <script> 要素のスクリプトの実行が終了したときに呼び出される関数を参照します。
プロパティ利用可能。
- beforescriptexecute 非標準 非推奨
- 静的な <script> が実行されようとするときに発行されます。
プロパティ利用可能。
- securitypolicyviolation
- コンテンツ セキュリティ ポリシーに違反した場合に発行されます。
- scroll
- 文書のビューがスクロールされた時に発生します。
onscroll プロパティ利用可能。
- visibilitychange
- タブの内容の表示/非表示の状態が切り替わった時に発行されます。
onvisibilitychange プロパティ利用可能。
- wheel
- ユーザーがポインティング デバイス(通常はマウス)のホイール ボタンを回転させると、イベントが発生します。
onwheel プロパティ利用可能。
ロード&アンロード イベント
- DOMContentLoaded
- HTML の初期文書が完全に読み込まれ時点でリソースが解釈された時点で発生します。副リソースのスタイルシート、画像、サブ フレームの読み込みや解釈は完了されていません。
- readystatechange
- 文書の readyState プロパティが変化したときに発生します。
onreadystatechange プロパティ利用可能。
選択イベント
- selectionchange
- 文書における現在のテキストの選択が変更された時に発生します。
onselectionchange プロパティ利用可能。
- selectstart
- 文書上でユーザーが新しい選択範囲を指定した時に発行します。
onselectstart プロパティ利用可能。
クリップボード イベント
- copy
- 文書上でユーザーがコピー操作をした時に発生します。
oncopy プロパティ利用可能。
- cut
- 文書上でユーザーが切り取り操作をした時に発生します。
oncut プロパティ利用可能。
- paste
- 文書上でユーザーが「貼り付け」操作をした時に発生します。
onpaste プロパティ利用可能。
キーボード イベント
- keydown
- 文書上でキーが押されたときに発行されます。シフト キーなどの入力も関知する。
onkeydown プロパティ利用可能。
- keypress
- 文書上で、キー入力で、文字値を生成する(確定している)キーが押下されたときに発行されます。¶シフト キーなどは関知されません。FEP など利用で変換入力は関知されず。
onkeypress 非推奨 プロパティ利用可能。
- keyup
- 文書上でキーが放された時に発行されます。シフト キーなども関知します。
onkeyup プロパティ利用可能。
ポインター イベント
- gotpointercapture
- 要素が Element.setPointerCapture() を使用してポインターをキャプチャしたときに発行されます。
ongotpointercapture プロパティ利用可能。
- lostpointercapture
- キャプチャされたポインターが解放されたときに発行されます。
onlostpointercapture プロパティ利用可能。
- pointercancel
- ブラウザーがもう文書上にポインターイベントが存在しないと判断したとき、または pointerdown イベントが発生した後で、ポインターがビューポートのパン、ズーム、スクロールを操作するために使用されたときに発生します。
onpointercancel プロパティ利用可能。
- pointerdown
- 文書上でポインターがアクティブになった時に発生します。
onpointerdown プロパティ利用可能。
- pointerenter
- 文書上にポインティング デバイスが入ったときに発生します。
onpointerenter プロパティ利用可能。
- pointerleave
- 文書上からポインティング デバイスが出た時に発生します。
onpointerleave プロパティ利用可能。
- pointerlockchange
- 文書上でポインターがロックされたり解除されたりした時に発行されます。
onpointerlockchange プロパティ利用可能。
- pointerlockerror
- ポインターをロックしようとして失敗したときに発行されます。
onpointerlockerror プロパティ利用可能。
- pointermove
- 文書上でポインターの座標が変化し、かつブラウザーのによってポインターがされていないときに発生します。
onpointermove プロパティ利用可能。
- pointerout
- 要素からポインターが出た時に発生します。
onpointerout プロパティ利用可能。
- pointerover
- ポインティング デバイスが要素のヒットテスト境界内に移動したときに発生します。
onpointerover プロパティ利用可能。
- pointerup
- 文書上でポインターがアクティブでなくなった時に発生します。
onpointerup プロパティ利用可能。
ドラッグ&ドロップ イベント
- drag
- 文書上で、要素や選択されたテキストをユーザーがドラッグしている間に、数百ミリ秒ごとに発生します。
ondrag プロパティ利用可能。
- dragend
- 文書上でドラッグ操作が終わろうとしている時(マウスボタンを放したり、エスケープ キーを押したりしたとき)に発生します。
ondragend プロパティ利用可能。
- dragenter
- 文書上でドラッグ中にドラッグ物が要素に入った時に発生します。
ondragenter プロパティ利用可能。
- dragleave
- 文書上でドラッグ中にドラッグ物が要素から出た時に発生します。
ondragleave プロパティ利用可能。
- dragover
- 文書上でドラッグ中にドラッグ物が要素の上ある時に(数百ミリ秒間隔で)発生します。
ondragover プロパティ利用可能。
- dragstart
- 文書上でユーザーが要素や選択されたテキストをドラッグし始めた時に発生します。
ondragstart プロパティ利用可能。
- drop
- 文書上でドラッグ物を妥当なドロップ ターゲットにドロップした時に発生します。
ondrop プロパティ利用可能。
全画面イベント
- fullscreenchange
- ブラウザーが全画面モードに移行したり終了したりした直後に発生します。
onfullscreenchange プロパティ利用可能。
- fullscreenerror
- ブラウザーが全画面モードに移行できない時に発生します。
onfullscreenerror プロパティ利用可能。
アニメーション イベント
- animationcancel
- CSS アニメーションが予期せず中断されたときに発生します。
onanimationcancel プロパティ利用可能。
- animationend
- CSS アニメーションが完了したときに発生します。
onanimationend プロパティ利用可能。
- animationiteration
- CSS アニメーションの反復が 1 回分終了し、次の回が始まったときに発生します。
onanimationiteration プロパティ利用可能。
- animationstart
- CSS アニメーションが実際の動きを開始したときに発生します。
onanimationstart プロパティ利用可能。
トランジション イベント
- transitioncancel
- CSS トランジションがキャンセルされたときに発行されます。
ontransitioncancel プロパティ利用可能。
- transitionend
- CSS トランジションが完了したときに発行されます。
ontransitionend プロパティ利用可能。
- transitionrun
- CSS トランジションが最初に生成されたとき、つまり transition-delay が始まる前に発行されます。
ontransitionrun プロパティ利用可能。
- transitionstart
- CSS トランジションが実際に始まったとき、つまり transition-delay が終了した後に発行されます。
ontransitionstart プロパティ利用可能。
タッチ イベント
- touchcancel
- 1 つ以上のタッチ点が実装固有の方法で中断された場合に発行されます(例えば、作成されたタッチ点が多すぎた場合など)。
ontouchcancel プロパティ利用可能。
- touchend
- 1 つ以上のタッチ点がタッチ面から取り除かれたときに発行されます。
ontouchend プロパティ利用可能。
- touchmove
- 1 つ以上のタッチ点がタッチ面に沿って移動したときに発行されます。
ontouchmove プロパティ利用可能。
- touchstart
- 1 つ以上のタッチ点がタッチ面に配置されたときに発行されます。
ontouchstart プロパティ利用可能。
テスト