1
0
Fork 0
arangodb/Documentation/Books/Users/General-Graphs/Functions.mdpp

100 lines
2.0 KiB
Plaintext

!CHAPTER Graph Functions
Write Intro!
!SECTION Get vertices from edges.
!SUBSECTION Get vertex *from* of an edge
<!-- @startDocuBlock JSF_general_graph_getFromVertex -->
!SUBSECTION Get vertex *to* of an edge
<!-- @startDocuBlock JSF_general_graph_getToVertex -->
!SECTION Some Methods
```javascript
graph.listCommonNeighbors(vertex1, vertex2, options)
```
vertex1: string - vertex id
vertex2: string - vertex id
options:
* see getNeighbors
```javascript
graph.amountCommonNeighbors(vertex1, vertex2, options)
```
vertex1: string - vertex id
vertex2: string - vertex id
options:
* see getNeighbors
```javascript
graph.listCommonProperties((vertex1, vertex2)
```
vertex1: string - vertex id
vertex2: string - vertex id
```javascript
graph.amountCommonProperties((vertex1, vertex2)
```
vertex1: string - vertex id
vertex2: string - vertex id
```javascript
graph.pathTo(vertex1, vertex2, options)
```
vertex1: string - vertex id
vertex2: string - vertex id
options: see determinePredecessors
```javascript
graph.distanceTo(vertex1, vertex2, options)
```
vertex1: string - vertex id
vertex2: string - vertex id
options: see determinePredecessors
```javascript
graph.getNeighbors(vertex1, options)
```
vertex1: string - vertex id
options:
* direction:
"inbound" -> consider only inbound edges
"outbount" -> consider only outbound edges
"any"(default) -> consider both directions
* weight: attribute-name -> use this attribute to determine edgeweight
* weight_function: function -> use this function to calculate the weight
* default-weight -> us this value if weight could not be calculated otherwise, default is Infinity
* only: function -> will be invoked on any edge, neighbors will only be included if this returns true or is not defined.
```javascript
graph.measurement(vertex1, measurement)
```
vertex1: string - vertex id
measurement: String
* "eccentricity": Calculates the eccentricity of the vertex
* "betweenness": Calculates the betweenness of the vertex
* "closeness": Calculates the closeness of the vertex