Operator Scope of Action:
Operator First Added:
Operator Last Altered:
Operator Uses Scoped Arguments:
Operator Has Optional Arguments:
Function [other Function type actions]
Group [operators of similar scope]
Data manipulation [other Data manipulation operators]
As at baseline
Returns a list of the path(s) of all those notes that can be reached by following between 1 and distanceNum links from the designated note or notes, regardless of the direction of those links (i.e. whether inbound or outbound). 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.
$MyList = neighbors2Within(this, 3);
Returns the set of notes that are connected from this note by between 1–3 (outbound) links.
neighbors2Within(scope, distanceNum, linkType)
Returns the set of notes that are connected by following between 1 and distanceNum links from the designated note or notes, regardless of the direction of those links (i.e. whether inbound or outbound), but within those links 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 = 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".
Different variations of 'neighbor' operators
There are essentially two different subtypes within the 4 operators:
- Direction. If the operator name includes a '2' the direction of connecting links are ignored. Otherwise, only outbound links are assessed.
- Distance. If the operator name includes 'Within' then all notes at distances between 1 and distanceNum are considered. Otherwise, only notes at exactly distanceNum are considered.