Class HistoryPlugin<Schemes>

Type Parameters

Schemes extends BaseSchemes

Hierarchy

HistoryPlugin<Schemes>
- HistoryPlugin

Index

Constructors

constructor

new HistoryPlugin<Schemes>(props?): HistoryPlugin<Schemes>
Type Parameters
- Schemes extends BaseSchemes
Parameters
- Optionalprops: {
  timing?: number;
  }
  History plugin properties
  - Optionaltiming?: number
    Time in ms between actions to be considered as one action
Returns HistoryPlugin<Schemes>
Inherited from BaseHistoryPlugin<Schemes>.constructor
- Defined in node_modules/rete-history-plugin/_types/index.d.ts:24

Properties

__scope

__scope: {
parents: [BaseArea<Schemes>, Root<Schemes>];
produces: never;
}

canRedo

canRedo: Writable<boolean> = ...

canUndo

canUndo: Writable<boolean> = ...

isRedoing

isRedoing: boolean = false

isUndoing

isUndoing: boolean = false

lastMoveTime

lastMoveTime: number = ...

name

name: string

`Optional`parent

parent?: any

signal

signal: Signal<any>

timing

timing: number

Methods

add

add(action): void
Adds an action to the history
Parameters
- action: Action
  Action instance
Returns void
Overrides BaseHistoryPlugin.add
- Defined in src/lib/graph-editor/plugins/history.ts:12

addPipe

addPipe(middleware): void
Parameters
- middleware: Pipe<BaseArea<Schemes> | Root<Schemes>>
Returns void
Inherited from BaseHistoryPlugin.addPipe
- Defined in node_modules/rete/_types/scope.d.ts:54

addPreset

addPreset<T>(preset): void
Adds a preset to the history plugin
Type Parameters
- T extends Action
Parameters
- preset: Preset<Schemes, T>
  Preset that manages some actions, e.g. classic preset for adding/removing nodes, connections, etc.
Returns void
Inherited from BaseHistoryPlugin.addPreset
- Defined in node_modules/rete-history-plugin/_types/index.d.ts:32

clear

clear(): void
Clear history

Returns void
Inherited from BaseHistoryPlugin.clear
- Defined in node_modules/rete-history-plugin/_types/index.d.ts:52

emit

emit<C>(context): Promise<undefined>
Type Parameters
- C extends never
Parameters
- context: C
Returns Promise<undefined>
Inherited from BaseHistoryPlugin.emit
- Defined in node_modules/rete/_types/scope.d.ts:59

execute

execute(action): void
Parameters
- action: Action
Returns void
- Defined in src/lib/graph-editor/plugins/history.ts:24

getHistorySnapshot

getHistorySnapshot(): HistoryRecord<Action>[]
Get produced history records

Returns HistoryRecord<Action>[]
History snapshot
Inherited from BaseHistoryPlugin.getHistorySnapshot
- Defined in node_modules/rete-history-plugin/_types/index.d.ts:42

getRecent

getRecent(ms): HistoryRecord<Action>[]
Get recent history records produced in the last ms milliseconds
Parameters
- ms: number
  Delta time in milliseconds
Returns HistoryRecord<Action>[]
History records produced in the last ms milliseconds
Inherited from BaseHistoryPlugin.getRecent
- Defined in node_modules/rete-history-plugin/_types/index.d.ts:48

hasParent

hasParent(): boolean
Returns boolean
Inherited from BaseHistoryPlugin.hasParent
- Defined in node_modules/rete/_types/scope.d.ts:60

parentScope

parentScope<T, P>(): Scope<T, P>
Type Parameters
- T extends BaseArea<Schemes>
- P extends [Root<Schemes>]
Returns Scope<T, P>
Inherited from BaseHistoryPlugin.parentScope
- Defined in node_modules/rete/_types/scope.d.ts:61
parentScope<T>(type): T
Type Parameters
- T
Parameters
- type: Type<T>
Returns T
Inherited from BaseHistoryPlugin.parentScope
- Defined in node_modules/rete/_types/scope.d.ts:62

redo

redo(): Promise<void>
Asynchronously redoes an actions until the separated flag is encountered or the time between the current and previous action exceeds timing property which is 200ms by default

Returns Promise<void>
Overrides BaseHistoryPlugin.redo
- Defined in src/lib/graph-editor/plugins/history.ts:40

separate

separate(): void
Returns void
Inherited from BaseHistoryPlugin.separate
- Defined in node_modules/rete-history-plugin/_types/index.d.ts:56

setParent

setParent(scope): void
Parameters
- scope: Scope<BaseArea<Schemes>, [Root<Schemes>]>
Returns void
Inherited from BaseHistoryPlugin.setParent
- Defined in node_modules/rete-history-plugin/_types/index.d.ts:27

undo

undo(): Promise<void>
Asynchronously undoes an actions until the separated flag is encountered or the time between the current and previous action exceeds timing property which is 200ms by default

Returns Promise<void>
Overrides BaseHistoryPlugin.undo
- Defined in src/lib/graph-editor/plugins/history.ts:29

use

use<S>(scope): {
    debug<T>(_f: ((p: {
        [K in string | number | symbol]: BaseArea<Schemes> | Root<Schemes>
    }) => T)): void;
}
Type Parameters
- S extends Scope<any, any[]>
Parameters
- scope: NestedScope<S, [never, BaseArea<Schemes>, Root<Schemes>]>
Returns {
    debug<T>(_f: ((p: {
        [K in string | number | symbol]: BaseArea<Schemes> | Root<Schemes>
    }) => T)): void;
}
- debug:function
  - debug<T>(_f): void
  - Type Parameters
    - T extends []
    Parameters
    - _f: ((p: {
      [K in string | number | symbol]: BaseArea<Schemes> | Root<Schemes>
      }) => T)
      (p): T
      Parameters
      p: {
      [K in string | number | symbol]: BaseArea<Schemes> | Root<Schemes>
      }
      Returns T
    Returns void
    - Defined in node_modules/rete/_types/scope.d.ts:56
Inherited from BaseHistoryPlugin.use
- Defined in node_modules/rete/_types/scope.d.ts:55

Class HistoryPlugin<Schemes>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Optionaltiming?: number

Returns HistoryPlugin<Schemes>

Properties

__scope

canRedo

canUndo

isRedoing

isUndoing

lastMoveTime

name

Optionalparent

signal

timing

Methods

add

Parameters

Returns void

addPipe

Parameters

Returns void

addPreset

Type Parameters

Parameters

Returns void

clear

Returns void

emit

Type Parameters

Parameters

Returns Promise<undefined>

execute

Parameters

Returns void

getHistorySnapshot

Returns HistoryRecord<Action>[]

getRecent

Parameters

Returns HistoryRecord<Action>[]

hasParent

Returns boolean

parentScope

Type Parameters

Returns Scope<T, P>

Type Parameters

Parameters

Returns T

redo

Returns Promise<void>

separate

Returns void

setParent

Parameters

Returns void

undo

Returns Promise<void>

use

Type Parameters

Parameters

Returns { debug<T>(_f: ((p: { [K in string | number | symbol]: BaseArea<Schemes> | Root<Schemes> }) => T)): void; }

debug:function

Type Parameters

Parameters

Parameters

Returns T

Returns void

Settings

On This Page

`Optional`timing?: number

`Optional`parent

Returns {
debug<T>(_f: ((p: {
[K in string | number | symbol]: BaseArea<Schemes> | Root<Schemes>
}) => T)): void;
}