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

構文

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

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

プロパティ

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

NodeIterator.root読取専用

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

NodeIterator.whatToShow読取専用

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

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

定数	数値	説明
NodeFilter.SHOW_ALL	4294967295 （すなわちunsigned long の最大値）	すべてのノードを表示します。
NodeFilter.SHOW_ATTRIBUTE非推奨;	2	属性のAttr ノードを表示します。これはルートとしてAttr を含むNodeIterator を作成する場合に限り、意味があります。この場合は、反復処理や走査の最初の位置に属性ノードが現れることを意味します。属性はほかのノードの子ではありませんので、文書ツリーを走査するときは出現しません。
NodeFilter.SHOW_CDATA_SECTION非推奨;	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非推奨;	32	古いもので、もう使用されません。
NodeFilter.SHOW_ENTITY_REFERENCE非推奨;	16	古いもので、もう使用されません。
NodeFilter.SHOW_NOTATION非推奨;	2048	古いもので、もう使用されません。
NodeFilter.SHOW_PROCESSING_INSTRUCTION	64	ProcessingInstruction ノードを表示します。
NodeFilter.SHOW_TEXT	4	Text ノードを表示します。

NodeIterator.filter読取専用

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

ExperimentalNodeIterator.referenceNode読取専用

イテレーターが結び付けられているNode を返します。

NodeIterator.pointerBeforeReferenceNode読取専用Experimental

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

メソッド

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

NodeIterator.detach()非推奨;

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

NodeIterator.previousNode()

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

NodeIterator.nextNode()

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

仕様書

ブラウザーの互換性

関連情報

• 作成するメソッド:Document.createNodeIterator()
• 関連インターフェイス
  • NodeFilter
  • TreeWalker