Skip to main content

Class: HistoryMemo

historyMemo is a set of history of memos of tool state. That is, it remembers what has been applied to various images.

Constructors

new HistoryMemo()

new HistoryMemo(label, size): HistoryMemo

Parameters

label: string = 'Tools'

size: number = 50

Returns

HistoryMemo

Defined in

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

Properties

label

readonly label: any

Defined in

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

Accessors

size

get size(): number

The number of items that can be stored in the history

set size(newSize): void

Sets the size, clearing all history elements

Parameters

newSize: number

Returns

number

Defined in

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

Methods

push()

push(item): Memo

Pushes a new memo onto the ring. This will remove all redoable items from the ring if a memo was pushed. Ignores undefined or null items.

Parameters

item: Memo | Memoable

Returns

Memo

Defined in

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


redo()

redo(items): void

Redoes up to the given number of items, adding them to the top of the ring.

Parameters

items: number = 1

Returns

void

Defined in

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


undo()

undo(items): void

Undoes up to the given number of items off the ring

Parameters

items: number = 1

Returns

void

Defined in

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