Node.compareDocumentPosition() - Web APIs 编辑
The Node.compareDocumentPosition()
method reports the position of the given node relative to another node in any document — not just the given node’s document.
The return value is a bitmask of the following values:
Name | Value |
---|---|
DOCUMENT_POSITION_DISCONNECTED | 1 |
DOCUMENT_POSITION_PRECEDING | 2 |
DOCUMENT_POSITION_FOLLOWING | 4 |
DOCUMENT_POSITION_CONTAINS | 8 |
DOCUMENT_POSITION_CONTAINED_BY | 16 |
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC | 32 |
Syntax
compareMask = node.compareDocumentPosition(otherNode)
Parameters
otherNode
- The other
Node
with which to compare the firstnode
’s document position.
Return value
An integer value whose bits represent the otherNode
's relationship to the calling node
.
More than one bit is set if multiple scenarios apply. For example, if otherNode
is located earlier in the document and contains the node
on which compareDocumentPosition()
was called, then both the DOCUMENT_POSITION_CONTAINS
and DOCUMENT_POSITION_PRECEDING
bits would be set, producing a value of 10 (0x0A
).
Example
const head = document.head;
const body = document.body;
if (head.compareDocumentPosition(body) & Node.DOCUMENT_POSITION_FOLLOWING) {
console.log('Well-formed document');
} else {
console.error('<head> is not before <body>');
}
Note: Because the result returned by compareDocumentPosition()
is a bitmask, the bitwise AND operator must be used for meaningful results.
Specifications
Specification | Status | Comment |
---|---|---|
DOM The definition of 'Node.compareDocumentPosition()' in that specification. | Living Standard | |
Document Object Model (DOM) Level 3 Core Specification The definition of 'Node.compareDocumentPosition()' in that specification. | Obsolete | Initial definition |
Browser compatibility
BCD tables only load in the browser
See also
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论