@graphty/graphty-element / index / FindOptions

Interface: FindOptions

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

What GraphSession.find reads beside the text. Every field is optional.

Properties

kinds?

readonly optional kinds?: readonly FindKind[]

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

What to list. Default ["node", "edge"].

---

limit?

readonly optional limit?: number

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

The most hits it returns. Default 20; Infinity for all.

---

offset?

readonly optional offset?: number

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

How many hits to skip, for paging. Default 0.

---

scope?

readonly optional scope?: ScopeInput

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

Where to search. Default the whole graph: a hit the visibility filter hides is still listed, and carries excludedBy.