@graphty/graphty-element / index / NoteListOptions

Interface: NoteListOptions

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

Options of notes.list.

Properties

author?

readonly optional author?: string

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

Only notes with exactly this author.

---

cites?

readonly optional cites?: string

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

Only notes citing this result, whichever run they cite.

---

done?

readonly optional done?: boolean

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

True: only notes marked done; false: only notes not marked done.

---

missing?

readonly optional missing?: boolean

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

True: only notes with at least one target reading missing.

---

target?

readonly optional target?: NoteTargetInput | readonly NoteTargetInput[]

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

Only notes about this target, or about any of these. Exact: a note about a set is not listed under its members, and a note citing a result is not listed under the result.

---

targetKind?

readonly optional targetKind?: string

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

Only notes with at least one target of this kind ("node", "edge", ...).