Tinderbox v9 Icon

neighbors2Within(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

 


neighbors2Within(item|group, N)

Returns a list of the path(s) of all those notes that can be reached by following between 1 and N links from the designated note or notes, with all links being treated as bi-directional. Only the shortest possible path between two notes is considered.

The starting note or notes are considered to be connected to themselves.

For example:

$MyList = neighbors2Within(this, 3); 

Returns the set of notes that are connected from this note by between 1–3 (outbound) links.

neighbors2Within(item|group, N, linkType)

Returns the set of notes that are connected by following between 1 and N links from the designated note or notes, with all links being treated as bi-directional, but considering only links of the specified link type linkType.

The starting note or notes are considered to be connected to themselves. To filter on unnamed links use the type "*untitled". For example:

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

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



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