Appearance

@graphty/graphty-element / index / ExpandRequest

Interface: ExpandRequest<P> ​

Defined in: graph-io/dist/src/sources/types.d.ts:384

A request to fetch the neighborhood of some nodes. Experimental.

Type Parameters ​

P ​

P

Properties ​

depth? ​

readonly optional depth?: number

Defined in: graph-io/dist/src/sources/types.d.ts:390

How many hops.

Default Value ​

ts
1

direction? ​

readonly optional direction?: "out" | "in" | "both"

Defined in: graph-io/dist/src/sources/types.d.ts:392

Which edges to follow.

Default Value ​

ts
"both"

exclude? ​

readonly optional exclude?: readonly NodeId[]

Defined in: graph-io/dist/src/sources/types.d.ts:398

Nodes already loaded; an optimization only.

ids ​

readonly ids: readonly NodeId[]

Defined in: graph-io/dist/src/sources/types.d.ts:388

The seed node ids.

limit? ​

readonly optional limit?: number

Defined in: graph-io/dist/src/sources/types.d.ts:394

At most this many new nodes.

params ​

readonly params: P

Defined in: graph-io/dist/src/sources/types.d.ts:386

The params the nodes were loaded with.

relationshipTypes? ​

readonly optional relationshipTypes?: readonly string[]

Defined in: graph-io/dist/src/sources/types.d.ts:396

Only these relationship types.