Skip to content
  1. API
  2. Types

AdjacencyOptions

Type: object

Properties

  • options(optional)
    • bothExtremities(optional) boolean[=false] Relevant only for getAdjacentEdges. If true, only edges for which both extremities are in the NodeList are retrieved.
    • direction(optional) "both"|"in"|"out"[="both"] Direction of the edges to follow.
    • filter(optional) Filter[="visible"] Indicates what kind of elements should be retrieved.
    • policy(optional) "union"|"include-sources"|"exclude-sources"[="union"] If "include-sources", the source node(s) will be added to the result. If "exclude-sources", the source node(s) will be removed from the result. If "union", the result is not modified. This parameter is ignored when retrieving adjacent edges.