Tinderbox v9 Icon

neighbors(scope, distanceNum[, linkTypeStr])


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Last Altered: 

Operator Uses Scoped Arguments: 

Operator Has Optional Arguments: 


neighbors(scope, distanceNum)

Returns a list of the path(s) of all those notes that can be reached by following exactly distanceNum links outward from the designated note or notes. Only the shortest possible path between two notes is considered. The operator will report links from the source node to itself, i.e. self-links. Prototype-type links are ignored. For example:

$MyList = neighbors(this, 3); 

Returns the set of notes that are connected from this note by exactly three (outbound) links.

neighbors(scope, distanceNum, linkTypeStr)

Returns the set of notes that are connected by exactly distanceNum links outward from the designated note or notes, but within those links considering only links of the specified link type linkTypeStr to filter on unnamed links use the type "*untitled".For example:

$MyList = neighbors(children, 2, "example"); 

Returns the set of notes that are connected from any of this note's children by by exactly two (outbound) links of the link type "example".

Different variations of 'neighbor' operators

There are essentially two different subtypes within the 4 operators: