NodeIterator

NodeIterator インターフェイスは、DOM のサブツリー内に存在するノードのリストのメンバーに対する反復子を表します。ノードは文書内に現れる順番で返されます。

構文

NodeIterator は、以下のように Document.createNodeIterator() メソッドを用いて作成することができます。

const nodeIterator = document.createNodeIterator(root, whatToShow, filter);

プロパティ

このインターフェイスが継承するプロパティはありません。

NodeIterator.root (en-US) 読取専用

NodeIterator を作成したときに指定したルートノードを表す Node を返します。

NodeIterator.whatToShow (en-US) 読取専用

提供しなければならない Node の型を表す定数で構成されるビットマスクである unsigned long を返します。一致しないノードはスキップされますが、その子は関連があれば含まれます。

使用できる値は以下のとおりです。

定数 数値 説明
NodeFilter.SHOW_ALL 4294967295 (すなわち unsigned long の最大値) すべてのノードを表示します。
NodeFilter.SHOW_ATTRIBUTE Deprecated 2 属性の Attr ノードを表示します。これはルートとして Attr を含む NodeIterator を作成する場合に限り、意味があります。この場合は、反復処理や走査の最初の位置に属性ノードが現れることを意味します。属性はほかのノードの子ではありませんので、文書ツリーを走査するときは出現しません。
NodeFilter.SHOW_CDATA_SECTION Deprecated 8 CDATASection ノードを表示します。
NodeFilter.SHOW_COMMENT 128 Comment ノードを表示します。
NodeFilter.SHOW_DOCUMENT 256 Document ノードを表示します。
NodeFilter.SHOW_DOCUMENT_FRAGMENT 1024 DocumentFragment ノードを表示します。
NodeFilter.SHOW_DOCUMENT_TYPE 512 DocumentType ノードを表示します。
NodeFilter.SHOW_ELEMENT 1 Element ノードを表示します。
NodeFilter.SHOW_ENTITY Deprecated 32 古いもので、もう使用されません。
NodeFilter.SHOW_ENTITY_REFERENCE Deprecated 16 古いもので、もう使用されません。
NodeFilter.SHOW_NOTATION Deprecated 2048 古いもので、もう使用されません。
NodeFilter.SHOW_PROCESSING_INSTRUCTION 64 ProcessingInstruction ノードを表示します。
NodeFilter.SHOW_TEXT 4 Text ノードを表示します。
NodeIterator.filter (en-US) 読取専用

関連するノードを選択するために使用した NodeFilter (en-US) を返します。

NodeIterator.referenceNode (en-US) 読取専用 Experimental

反復子が固定されている Node を返します。

NodeIterator.pointerBeforeReferenceNode (en-US) 読取専用 Experimental

論理値のフラグで、 NodeIterator が前に固定されるかどうかを示します。前に固定される場合は true、後に固定される場合は false になります。

メソッド

このインターフェイスが継承するメソッドはありません。

NodeIterator.detach() (en-US) Deprecated

これは無操作です。です。これは何も行いません。以前は NodeIterator を使用しなくなったことをエンジンに伝えていましたが、現在は不要です。

NodeIterator.previousNode() (en-US)

文書内で前の Node を返します。ノードがない場合は null を返します。

NodeIterator.nextNode() (en-US)

文書内で次の Node を返します。ノードがない場合は null を返します。

仕様書

Specification
DOM Standard
# interface-nodeiterator

ブラウザーの互換性

BCD tables only load in the browser

関連情報