@graphty/graphty-element / session / CommandOutcomeMap
Interface: CommandOutcomeMap ​
Defined in: graphty-element/src/session/types.ts:1575
What execute returns, per op. No entry is wrapped in a promise, because a promise resolved with a Run would adopt it and yield the result instead of the handle.
Properties ​
algo.legacy ​
algo.legacy:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1579
Settles once the plugin has run and everything it wrote is recorded as one step.
algo.remove ​
algo.remove:
Promise<RunRemoval>
Defined in: graphty-element/src/session/types.ts:1581
What went with the run, once the removal is recorded.
algo.run ​
algo.run:
Run
Defined in: graphty-element/src/session/types.ts:1577
The run's handle; awaiting it yields the result.
batch ​
batch:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1583
Settles once every member is recorded as one step and the pass that draws it has run.
config.set ​
config.set:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1633
Settles once the settings are recorded and the picture has caught up.
data.apply ​
data.apply:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1585
Settles once the change is recorded and the pass that draws it has run.
data.declare ​
data.declare:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1591
Settles once the declaration is recorded.
data.expand ​
data.expand:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1589
Settles once the neighbourhood is recorded and the pass that draws it has run.
data.import ​
data.import:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1587
Settles once the last chunk is recorded and the pass that draws it has run.
data.setSource ​
data.setSource:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1593
Settles once the source is recorded.
layout.scope ​
layout.scope:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1641
Settles once the scope is recorded.
layout.set ​
layout.set:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1639
Settles once the choice is recorded and the layout has spent its pre-steps.
layout.transport ​
layout.transport:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1645
Settles once the layout has started or stopped moving.
note.add ​
note.add:
Promise<string>
Defined in: graphty-element/src/session/types.ts:1619
The new note's id, once it is recorded.
note.merge ​
note.merge:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1625
Settles once the merged notes are recorded; session.notes.mergeDocument returns the report.
note.remove ​
note.remove:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1623
Settles once the removal is recorded.
note.update ​
note.update:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1621
Settles once the edit is recorded.
positions.pin ​
positions.pin:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1637
Settles once the pins are recorded and the layout has taken them.
positions.set ​
positions.set:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1635
Settles once the coordinates are recorded and the layout has taken them.
set.create ​
set.create:
Promise<string>
Defined in: graphty-element/src/session/types.ts:1607
The new set's id, once it is recorded.
set.members ​
set.members:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1613
Settles once the member edit is recorded.
set.redefine ​
set.redefine:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1611
Settles once the redefinition is recorded.
set.remove ​
set.remove:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1615
Settles once the removal is recorded.
set.rename ​
set.rename:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1609
Settles once the rename is recorded.
set.restore ​
set.restore:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1617
Settles once the restore is recorded.
style.encode ​
style.encode:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1597
Settles once the edit is recorded and the pass that repaints it has run.
style.patch ​
style.patch:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1595
Settles once the edit is recorded and the pass that repaints it has run.
style.template ​
style.template:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1599
Settles once the edit is recorded and the pass that repaints it has run.
view.camera ​
view.camera:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1631
Settles once the camera has arrived.
view.dimension ​
view.dimension:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1643
Settles once the switch is recorded and the layout has been rebuilt for it.
view.immersive ​
view.immersive:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1647
Settles once the device session has started or ended.
view.remove ​
view.remove:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1629
Settles once the removal is recorded.
view.save ​
view.save:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1627
Settles once the views are recorded.
visibility.context ​
visibility.context:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1605
Settles once the flag is recorded and the pass that follows it has run.
visibility.set ​
visibility.set:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1601
Settles once the filter is recorded and the pass that evaluates the masks has run.
visibility.window ​
visibility.window:
Promise<void>
Defined in: graphty-element/src/session/types.ts:1603
Settles once the window is recorded and the pass that evaluates the masks has run.