Shortest Path
Parameter |
Mandatory |
Description |
Type |
Value Range |
Default Value |
---|---|---|---|---|---|
source |
Yes |
Source vertex ID of a path |
String |
- |
- |
target |
Yes |
Target vertex ID of a path |
String |
- |
- |
weight |
No |
Weight of an edge |
String |
Empty or character string
|
- |
directed |
No |
Whether to consider the edge direction |
Boolean |
The value can be true or false. |
false |
timeWindow |
No |
Time window used for time filtering |
Object |
For details, see Table 2.
NOTE:
timeWindow does not support the shortest path with weight. That is, parameters timeWindow and weight cannot be both specified. |
- |
Parameter |
Mandatory |
Description |
Type |
Value Range |
Default Value |
---|---|---|---|---|---|
filterName |
Yes |
Name of the time property used for time filtering |
String |
Character string: The property on the corresponding vertex/edge is used as the time. |
- |
filterType |
No |
Filtering by vertex or edge |
String |
V: filtering by vertex E: filtering by edge BOTH: filtering by vertex and edge |
BOTH |
startTime |
No |
Start time |
String |
Date character string or timestamp |
- |
endTime |
No |
End time |
String |
Date character string or timestamp |
- |
Parameter |
Type |
Description |
---|---|---|
path |
List |
Shortest path. The format is as follows: [vertexId,...] where vertexId is of the string type. |
source |
String |
Source vertex ID |
target |
String |
Target vertex ID |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.