|
23 | 23 | * [.treeIterator(root)](#module_symbol-tree--SymbolTree+treeIterator) ⇒ <code>Object</code>
|
24 | 24 | * [.index(child)](#module_symbol-tree--SymbolTree+index) ⇒ <code>Number</code>
|
25 | 25 | * [.childrenCount(parent)](#module_symbol-tree--SymbolTree+childrenCount) ⇒ <code>Number</code>
|
| 26 | + * [.compareTreePosition(left, right)](#module_symbol-tree--SymbolTree+compareTreePosition) ⇒ <code>Number</code> |
26 | 27 | * [.remove(removeObject)](#module_symbol-tree--SymbolTree+remove) ⇒ <code>Object</code>
|
27 | 28 | * [.insertBefore(newObject, referenceObject)](#module_symbol-tree--SymbolTree+insertBefore) ⇒ <code>Object</code>
|
28 | 29 | * [.insertAfter(newObject, referenceObject)](#module_symbol-tree--SymbolTree+insertAfter) ⇒ <code>Object</code>
|
@@ -277,9 +278,33 @@ Calculate the number of children.
|
277 | 278 |
|
278 | 279 | **Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code>
|
279 | 280 |
|
280 |
| -| Param | |
281 |
| -| --- | |
282 |
| -| parent | |
| 281 | +| Param | Type | |
| 282 | +| --- | --- | |
| 283 | +| parent | <code>Object</code> | |
| 284 | + |
| 285 | +<a name="module_symbol-tree--SymbolTree+compareTreePosition"></a> |
| 286 | +#### symbolTree.compareTreePosition(left, right) ⇒ <code>Number</code> |
| 287 | +Compare the position of an object relative to another object. A bit set is returned: |
| 288 | + |
| 289 | +<ul> |
| 290 | + <li>DISCONNECTED : 1</li> |
| 291 | + <li>PRECEDING : 2</li> |
| 292 | + <li>FOLLOWING : 4</li> |
| 293 | + <li>CONTAINS : 8</li> |
| 294 | + <li>CONTAINED_BY : 16</li> |
| 295 | +</ul> |
| 296 | + |
| 297 | +The semantics are the same as compareDocumentPosition in DOM, with the exception that |
| 298 | +DISCONNECTED never occurs with any other bit. |
| 299 | + |
| 300 | +`O(n)` (worst case) |
| 301 | + |
| 302 | +**Kind**: instance method of <code>[SymbolTree](#exp_module_symbol-tree--SymbolTree)</code> |
| 303 | + |
| 304 | +| Param | Type | |
| 305 | +| --- | --- | |
| 306 | +| left | <code>Object</code> | |
| 307 | +| right | <code>Object</code> | |
283 | 308 |
|
284 | 309 | <a name="module_symbol-tree--SymbolTree+remove"></a>
|
285 | 310 | #### symbolTree.remove(removeObject) ⇒ <code>Object</code>
|
|
0 commit comments