Tinderbox v9 Icon

linkPath(pathNameStr[, startStr, endStr])

Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Last Altered: 

Operator Has Optional Arguments: 

 Function  [other Function type actions]

 Item  [operators of similar scope]

 Linking  [other Linking operators]


 As at baseline

 [More on optional operator arguments]


linkPath(pathNameStr[, startStr, endStr])

These functions return a list of notes that are on a designated path. The pathNameStr input must be supplied but can use a value "*" designates any path, regardless of path name—i.e. all notes that have at least one inbound or outbound link. This operator in many ways mirrors the visual function of the Hyperbolic view.

If startStr is provided, that path starts at the designated note and ends on reaching the endStr note or when all links on the path reachable from start are exhausted. If only the pathName is provided, all notes on the path are listed, whether or not they all form one contiguous network.

For example, to collect all notes on the path "example":

$MyList = linkPath("example"); 

Or, to return all notes connected by links of any type:

$MyList = linkPath("*"); 

To find notes linked by the link type "Project A", starting at "RFC" :

$MyList = linkPath("Project A", "RFC"); 

To find notes linked by the link type "Project A", starting at "RFC" and ending at "Archive":

$MyList = linkPath("Project A", "RFC", "Archive"); 

If several possible paths exist from startStr to endStr, Tinderbox will return the shortest path, or at least a path which is not longer than any other path. Bear in mind that in richly interlinked documents, there may be no 'obvious' single path between the specified notes.

If only endStr is supplied, still include the argument delimiter for the unused startStr:

$MyList = linkPath("Project A", , "Archive"); 

The underlying graph may contain cycles (i.e. have looping paths).