Graphty

Appearance

@graphty/graphty-element / index / NoteTarget

Type Alias: NoteTarget ​

NoteTarget = { graph: true; } | { node: NodeId; } | { edge: EdgeMember; } | { name?: string; set: SetId; } | { result: ResultId; } | { item: ResultItem; }

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

What a note is about.

OPEN UNION: kinds may be added in a minor release. Show a kind you do not know by its label from notes.status().

Union Members ​

Type Literal ​

{ graph: true; }

graph ​

readonly graph: true

The whole graph.

Type Literal ​

{ node: NodeId; }

node ​

readonly node: NodeId

One node, by its id. 11 and "11" name the same node.

Type Literal ​

{ edge: EdgeMember; }

edge ​

readonly edge: EdgeMember

One edge: its two ends plus the file's edge id, or its position among the edges joining them.

Type Literal ​

{ name?: string; set: SetId; }

name? ​

readonly optional name?: string

The set's name when the note was written, for display once the set is gone.

set ​

readonly set: SetId

A kept set.

Type Literal ​

{ result: ResultId; }

result ​

readonly result: ResultId

A run's result as a whole, followed across re-runs.

Type Literal ​

{ item: ResultItem; }

item ​

readonly item: ResultItem

One group or path a run found, pinned to that run.