Skip to main content

Type Alias: Memo

Memo: object

Type declaration​

commitMemo()?​

optional commitMemo: () => boolean

An optional function that will be called to commit any changes that have occurred in a memo. This allows recording changes that are ongoing to a memo and then being able to undo them without having to record the entire state at the time the memo is initially created. See createLabelmapMemo for an example use.

Returns​

boolean

true if this memo contains any data, if so it should go on the memo ring after the commit is completed.

id?​

optional id: string

Unique identifier for the memo.

operationType?​

optional operationType: string

Operation type for the memo. This is used to identify the type of operation when dispatching history events. Examples include 'labelmap', 'annotation', etc.

restoreMemo()​

restoreMemo: (undo?) => void

This restores memo state. It is an undo if undo is true, or a redo if it is false.

Parameters​

• undo?: boolean

Returns​

void

Defined in​

packages/core/src/utilities/historyMemo/index.ts:11