Tinderbox v9 Icon

neighborsWithin(scope, distanceNum[, linkTypeStr])


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Last Altered: 

Operator Has Optional Arguments: 


neighborsWithin(scope, distanceNum)

Returns a list of the path(s) of all those notes that can be reached by following between 1 and 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.

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

For example:

$MyList = neighborsWithin(this, 3); 

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

neighborsWithin(scope, distanceNum, linkTypeSTr)

Returns the set of notes that are connected by following between 1 and distanceNum links outward from the designated note or notes, but considering only links of the specified link type linkTypeStr.

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

$MyList = neighborsWithin(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 : Automating Tinderbox : Coding : Action Code : Operators : Full Operator List : neighborsWithin(scope, distanceNum[, linkTypeStr])