@graphty/graphty-element / index / ExpandOptions

Interface: ExpandOptions

Defined in: graphty-element/src/session/sources/types.ts:74

The options of data.expand(ids, options). Experimental.

Extends

• Omit<ExpandBehavior, "trigger">

Properties

credential?

readonly optional credential?: Credential

Defined in: graphty-element/src/session/sources/types.ts:76

The credential; looked up in the store when absent.

---

depth?

readonly optional depth?: number

Defined in: graphty-element/src/session/sources/types.ts:62

How many hops.

Default Value

1

Inherited from

ExpandBehavior.depth

---

direction?

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

Defined in: graphty-element/src/session/sources/types.ts:64

Which edges to follow.

Default Value

"both"

Inherited from

ExpandBehavior.direction

---

fetch?

readonly optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: graphty-element/src/session/sources/types.ts:80

The fetch to use instead of the global one.

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

---

layout?

readonly optional layout?: "none" | "continue"

Defined in: graphty-element/src/session/sources/types.ts:70

"continue" feeds new nodes to the running layout; "none" leaves them where they start.

Default Value

"continue"

Inherited from

ExpandBehavior.layout

---

limit?

readonly optional limit?: number

Defined in: graphty-element/src/session/sources/types.ts:66

At most this many new nodes per expansion; no limit by default.

Inherited from

ExpandBehavior.limit

---

relationshipTypes?

readonly optional relationshipTypes?: readonly string[]

Defined in: graphty-element/src/session/sources/types.ts:68

Only these relationship types.

Inherited from

ExpandBehavior.relationshipTypes

---

signal?

readonly optional signal?: AbortSignal

Defined in: graphty-element/src/session/sources/types.ts:78

Cancels the expansion.