Tinderbox v9 Icon

neighbors(item|group, N[, linkType])


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Group   [operators of similar scope]

 Data manipulation   [other Data manipulation operators]

 9.0.0

 9.1.0


neighbors(item|group, N)

Returns a list of the path(s) of all those notes that can be reached by following exactly N links outward from the designated note or notes. Only the shortest possible path between two notes is considered. For example:

$MyList = neighbors(this, 3); 

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

neighbors(item|group, N, "linkType")

Returns the set of notes that are connected by exactly N links outward from the designated note or notes, but considering only links of the specified link type linkType. 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".

From v9.1.0, this operator now report links from the source node to itself, i.e. self-links (previously, these were ignored). Also, prototype-type links are now ignored.



A Tinderbox Reference File : Actions & Rules : Operators : Full Operator List : neighbors(item|group, N[, linkType])