備忘録的プログラミングリファレンス

compareDocumentPosition() メソッド

Node.compareDocumentPosition()

 compareDocumentPosition() メソッドは、 引数の Node オブジェクトの親子階層における相対位置情報をビットマスクで返すメソッドです。Node オブジェクトからの相対位置になります。

相対位置の取得
var BitMask = Node.compareDocumentPosition( agument_Node );

詳しくは Example を参照してください

 Node オブジェクトからみて agument_Node オブジェクトが親子階層においてどの位置にあるかを既定のビットマスクで返します。

 相対位置を示すビットマスクの値は以下の返り値(Return Values)を参照してください。

ページ内 Index

Syntax

in JavaScript

 compareDocumentPosition() メソッドの返り値は相対位置を示すビットマスクの値を返します。
 返り値は返り値(Return Values)を参照してください。

BitMask = Node.cloneNode( agument_Node );

引数(Parameter Values)

 compareDocumentPosition() メソッドの引数は Node オブジェクトからの相対位置を確認するための Node オブジェクトです。

Value摘要
agument_NodeNode オブジェクトからの相対位置を確認するための Node

返り値(Return Values)

 compareDocumentPosition() メソッドによる相対位置を示す値は以下のビットマスクです。
 ビットマスクは、ビットで状態を示すプログラミングの手法です。フラグは 1 ビットで表現しますが、メモリの処理単位で状態を記憶するといった手法です。
 例えば、20 を返してきたら、16 + 4 で、4 と 16 の内容を示します。
 少々難しい話ですので詳しくは割愛します。

Type摘要
BitMask相対位置をビットマスク(数値)で返す。
Node.DOCUMENT_POSITION_DISCONNECTED = 1
Node とは異なるツリーにある
Node.DOCUMENT_POSITION_PRECEDING = 2
Node よりも上の階層または先に存在する
Node.DOCUMENT_POSITION_FOLLOWING = 4
Node よりも下の階層または後に存在する
Node.DOCUMENT_POSITION_CONTAINS = 8
Node よりも祖先のオブジェクト
Node.DOCUMENT_POSITION_CONTAINED_BY = 16
Node よりも子孫のオブジェクト
Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 32
移植性が保証できない

Example

 compareDocumentPosition() メソッドの例です。

 compareDocumentPosition() メソッドは、 引数の Node オブジェクトの親子階層における相対位置情報をビットマスクで返します。

 位置情報は上記の返り値(Return Values)を参照してください。