Interface PathOptions

Path specification.

interface PathOptions {
    edgeFilter?: ((n) => boolean);
    nodeFilter?: ((n) => boolean);
    source: string | Vertex;
    strict?: boolean;
    target: string | Vertex;
}

Properties

edgeFilter? nodeFilter? source strict? target

Properties

Optional edgeFilter

edgeFilter?: ((n) => boolean)

This function is given each Edge's backing data and asked to return true or false - true means include the Edge, false means exclude it.

Type declaration

    • (n): boolean

    • Parameters

      • n: Edge

      Returns boolean

Optional nodeFilter

nodeFilter?: ((n) => boolean)

This function is given each Node/Group's backing data and asked to return true or false - true means include the Node/Group, false means exclude it.

Type declaration

    • (n): boolean

    • Parameters

      • n: Node

      Returns boolean

source

source: string | Vertex

Path source. Either a vertex (node/group/port) or a vertex id.

Optional strict

strict?: boolean

Sets whether or not paths are searched strictly by the given source/target. If you supply a node as the source, but there are only edges connected to ports on that node, by default these edges will be ignored. Switching strict to false will mean these edges are considered.

target

target: string | Vertex

Path target. Either a vertex (node/group/port) or a vertex id.

Settings

Member Visibility

Theme

On This Page

edgeFilternodeFiltersourcestricttarget