XPathResult

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

XPathResult インターフェイスは、指定されたノードのコンテキスト内で XPath 式を評価して発生した結果を表します。

XPath 式はさまざまな結果型を発生させる可能性があるため、このインターフェイスを使用すると、結果の型と値を決定して処理することが可能になります。

インスタンスプロパティ

XPathResult.booleanValue 読取専用

論理値で、 resultType が BOOLEAN_TYPE の場合に、結果の値を表します。

XPathResult.invalidIteratorState 読取専用

イテレーターが無効になったことを示します。 resultType が UNORDERED_NODE_ITERATOR_TYPE または ORDERED_NODE_ITERATOR_TYPE で、この結果を返してから文書が変更された場合は true となります。

XPathResult.numberValue 読取専用

数値で、 resultType が NUMBER_TYPE の場合に、結果の値を表します。

XPathResult.resultType 読取専用

型定数を定義した、結果の型を表す数値のコードです。

XPathResult.singleNodeValue 読取専用

単一ノードの結果の値を表す Node です。 null になることもあります。

XPathResult.snapshotLength 読取専用

結果スナップショットのノード数です。

XPathResult.stringValue 読取専用

文字列で、 resultType が STRING_TYPE の場合に、結果の値を表します。

インスタンスメソッド

XPathResult.iterateNext()

結果がノード集合の場合、このメソッドはそれを反復処理し、次のノードを返すか、ノードがない場合は null を返します。

XPathResult.snapshotItem()

スナップショット集合のアイテムを返すか、インデックスがノードの範囲にない場合は null を返します。イテレーターの結果とは異なり、スナップショットは無効にはなりませんが、変化した場合には現在の文書に対応しなくなる可能性があります。

定数

結果の定義済みの型定数 値 説明
ANY_TYPE 0 式を評価した結果として自然に得られる型を格納した結果集合です。結果がノード集合の場合、 UNORDERED_NODE_ITERATOR_TYPE が常に結果として得られる型であることに注意してください。
NUMBER_TYPE 1 単一の数値を格納した結果です。この例は、例えば count() 関数を使用した XPath 式の中で有益です。
STRING_TYPE 2 単一の文字列を格納した結果です。
BOOLEAN_TYPE 3 1 つの論理値を格納した結果です。これは例えば、not()関数を使用した XPath 式の中で有益なものです。
UNORDERED_NODE_ITERATOR_TYPE 4 式に一致するすべてのノードを格納した結果ノード集合です。ノードは必ずしも文書内の順序とは限りません。
ORDERED_NODE_ITERATOR_TYPE 5 式に一致するすべてのノードを格納した結果ノード集合です。結果セットのノードは、文書内のノードと同じ順序で現れます。
UNORDERED_NODE_SNAPSHOT_TYPE 6 式に一致するすべてのノードのスナップショットを含む結果ノード集合です。ノードは必ずしも文書内の順序とは限りません。
ORDERED_NODE_SNAPSHOT_TYPE 7 式に一致するすべてのノードのスナップショットを含む結果ノード集合です。結果セットのノードは、文書内のノードと同じ順序で現れます。
ANY_UNORDERED_NODE_TYPE 8 式に一致する単一のノードを格納した結果ノード集合です。このノードは、必ずしも文書内の式に一致する最初のノードであるとは限りません。
FIRST_ORDERED_NODE_TYPE 9 式に一致する文書内の最初のノードを格納した結果ノード集合です。

仕様書

Specification
DOM Standard
# interface-xpathresult

ブラウザーの互換性

BCD tables only load in the browser

関連情報