Edits

Edit Handlers.

Classes

ChangeFramesEditClass

Extends ChangePropertyEditClass.

new ChangeFramesEditClass(object): ChangeFramesEditClass

Parameter	Type	Description
`object`	`ChangePropertyEditObject` & `EditArgs`

Returns ChangeFramesEditClass. Inherited from ChangePropertyEditClass.constructor.

Property	Modifier	Type
`affects`	`public readonly`	`${string}.${string}`[]
`done`	`public`	`boolean`
`edits`	`public`	`UndoableEdits`
`mash`	`public readonly`	`ClientMash`
`masher`	`public readonly`	`Masher`
`property`	`public`	`${string}.${string}`
`redoValue`	`public`	`undefined` \| `Scalar`
`signals`	`public readonly`	`SignalsRecord`
`target`	`public`	`Propertied`
`type`	`public`	`string`
`undoValue`	`public`	`undefined` \| `Scalar`
`value`	`public readonly`	`undefined` \| `Scalar`
`valueNumber`	`public readonly`	`undefined` \| `number`
`values`	`public readonly`	`Partial`<`SignalScalarRecord`>

Methods

redo(): void

Returns void. Inherited from ChangePropertyEditClass.redo.

undo(): void

Returns void. Inherited from ChangePropertyEditClass.undo.

updateEdit(object): void

Parameter	Type	Description
`object`	`ChangePropertyEditObject`

Returns void. Inherited from ChangePropertyEditClass.updateEdit.

updateSelection(): void

Returns void. Inherited from ChangePropertyEditClass.updateSelection.

ChangePropertiesEditClass

Extends ChangeEditClass.

new ChangePropertiesEditClass(object): ChangePropertiesEditClass

Parameter	Type	Description
`object`	`ChangePropertiesEditObject` & `EditArgs`

Returns ChangePropertiesEditClass. Overrides ChangeEditClass.constructor.

Property	Modifier	Type
`affects`	`public readonly`	`${string}.${string}`[]
`done`	`public`	`boolean`
`edits`	`public`	`UndoableEdits`
`mash`	`public readonly`	`ClientMash`
`masher`	`public readonly`	`Masher`
`redoValues`	`public`	`Partial`<`SignalScalarRecord`>
`signals`	`public readonly`	`SignalsRecord`
`target`	`public`	`Propertied`
`type`	`public`	`string`
`undoValues`	`public`	`Partial`<`SignalScalarRecord`>
`values`	`public readonly`	`Partial`<`SignalScalarRecord`>

Methods

redo(): void

Returns void. Inherited from ChangeEditClass.redo.

undo(): void

Returns void. Inherited from ChangeEditClass.undo.

updateEdit(object): void

Parameter	Type	Description
`object`	`ChangePropertiesEditObject`

Returns void. Overrides ChangeEditClass.updateEdit.

updateSelection(): void

Returns void. Inherited from ChangeEditClass.updateSelection.

EditsClass

Implements UndoableEdits.

new EditsClass(mash): EditsClass

Parameter	Type	Description
`mash`	`ClientMash`

Returns EditsClass.

Property	Modifier	Type
`canRedo`	`public readonly`	`boolean`
`canSave`	`public readonly`	`boolean`
`canUndo`	`public readonly`	`boolean`
`mash`	`public`	`ClientMash`

Methods

create(object): void

Parameter	Type	Description
`object`	`EditObject`

Returns void. Implementation of UndoableEdits.create.

redo(): undefined | UndoableEdit

Returns undefined | UndoableEdit. Implementation of UndoableEdits.redo.

save(): void

Returns void. Implementation of UndoableEdits.save.

undo(): undefined | UndoableEdit

Returns undefined | UndoableEdit. Implementation of UndoableEdits.undo.

MoveClipEditClass

Extends AddTrackEditClass.

new MoveClipEditClass(object): MoveClipEditClass

Parameter	Type	Description
`object`	`MoveClipEditObject` & `EditArgs`

Returns MoveClipEditClass. Overrides AddTrackEditClass.constructor.

Property	Modifier	Type
`affects`	`public readonly`	`${string}.${string}`[]
`clip`	`public`	`ClientClip`
`createTracks`	`public`	`number`
`done`	`public`	`boolean`
`edits`	`public`	`UndoableEdits`
`insertIndex`	`public`	`undefined` \| `number`
`mash`	`public readonly`	`ClientMash`
`masher`	`public readonly`	`Masher`
`redoFrame`	`public`	`undefined` \| `number`
`signals`	`public readonly`	`SignalsRecord`
`trackIndex`	`public`	`number`
`type`	`public`	`string`
`undoFrame`	`public`	`undefined` \| `number`
`undoInsertIndex`	`public`	`undefined` \| `number`
`undoTrackIndex`	`public`	`number`

Methods

addClip(trackIndex, insertIndex?, frame?): void

Parameter	Type	Description
`trackIndex`	`number`
`insertIndex`?	`number`
`frame`?	`number`

Returns void.

redo(): void

Returns void. Inherited from AddTrackEditClass.redo.

undo(): void

Returns void. Inherited from AddTrackEditClass.undo.

updateSelection(): void

Returns void. Inherited from AddTrackEditClass.updateSelection.

RemoveClipEditClass

Extends EditClass.

new RemoveClipEditClass(object): RemoveClipEditClass

Parameter	Type	Description
`object`	`RemoveClipEditObject` & `EditArgs`

Returns RemoveClipEditClass. Overrides EditClass.constructor.

Property	Modifier	Type
`affects`	`public readonly`	`${string}.${string}`[]
`clip`	`public`	`ClientClip`
`done`	`public`	`boolean`
`edits`	`public`	`UndoableEdits`
`index`	`public`	`number`
`mash`	`public readonly`	`ClientMash`
`masher`	`public readonly`	`Masher`
`signals`	`public readonly`	`SignalsRecord`
`track`	`public`	`ClientTrack`
`trackIndex`	`public readonly`	`number`
`type`	`public`	`string`

Methods

redo(): void

Returns void. Inherited from EditClass.redo.

undo(): void

Returns void. Inherited from EditClass.undo.

updateSelection(): void

Returns void. Inherited from EditClass.updateSelection.

Interfaces

AddClipsEditObject

Extends AddTrackEditObject.

Property	Type
`clips`	`ClientClip`[]
`createTracks`	`number`
`insertIndex?`	`number`
`redoFrame?`	`number`
`trackIndex`	`number`
`type`	`string`

AddTrackEditObject

Extends EditObject. Extended by AddClipsEditObject and MoveClipEditObject.

Property	Type
`createTracks`	`number`
`type`	`string`

ChangeEdit

Extends UndoableEdit. Extended by ChangePropertiesEdit and ChangePropertyEdit.

Property	Type
`affects`	`${string}.${string}`[]
`target`	`Propertied`
`values`	`Partial`<`SignalScalarRecord`>

Methods

redo(): void

Returns void. Inherited from UndoableEdit.redo.

undo(): void

Returns void. Inherited from UndoableEdit.undo.

updateEdit(object): void

Parameter	Type
`object`	`ChangeEditObject`

Returns void.

updateSelection(): void

Returns void. Inherited from UndoableEdit.updateSelection.

ChangeEditObject

Extends EditObject. Extended by ChangePropertyEditObject and ChangePropertiesEditObject.

Property	Type
`target`	`Propertied`
`type`	`string`

ChangePropertiesEdit

Extends ChangeEdit.

Property	Type
`affects`	`${string}.${string}`[]
`redoValues`	`Partial`<`SignalScalarRecord`>
`target`	`Propertied`
`undoValues`	`Partial`<`SignalScalarRecord`>
`values`	`Partial`<`SignalScalarRecord`>

Methods

redo(): void

Returns void. Inherited from ChangeEdit.redo.

undo(): void

Returns void. Inherited from ChangeEdit.undo.

updateEdit(object): void

Parameter	Type
`object`	`ChangePropertiesEditObject`

Returns void. Overrides ChangeEdit.updateEdit.

updateSelection(): void

Returns void. Inherited from ChangeEdit.updateSelection.

ChangePropertiesEditObject

Extends ChangeEditObject. Extended by SplitClipEditObject.

Property	Type
`redoValues`	`Partial`<`SignalScalarRecord`>
`target`	`Propertied`
`type`	`string`
`undoValues`	`Partial`<`SignalScalarRecord`>

ChangePropertyEdit

Extends ChangeEdit.

Property	Type
`affects`	`${string}.${string}`[]
`property`	`${string}.${string}`
`target`	`Propertied`
`value?`	`Scalar`
`valueNumber?`	`number`
`values`	`Partial`<`SignalScalarRecord`>

Methods

redo(): void

Returns void. Inherited from ChangeEdit.redo.

undo(): void

Returns void. Inherited from ChangeEdit.undo.

updateEdit(object): void

Parameter	Type
`object`	`ChangePropertyEditObject`

Returns void. Overrides ChangeEdit.updateEdit.

updateSelection(): void

Returns void. Inherited from ChangeEdit.updateSelection.

ChangePropertyEditObject

Extends ChangeEditObject.

Property	Type
`property`	`${string}.${string}`
`redoValue?`	`Scalar`
`target`	`Propertied`
`type`	`string`
`undoValue?`	`Scalar`

EditArgs

Extends EditObject.

Property	Type
`edits`	`UndoableEdits`
`type`	`string`

EditObject

Extended by AddTrackEditObject, RemoveClipEditObject, EditArgs, and ChangeEditObject.

Property	Type
`type`	`string`

MoveClipEditObject

Extends AddTrackEditObject.

Property	Type
`clip`	`ClientClip`
`createTracks`	`number`
`insertIndex?`	`number`
`redoFrame?`	`number`
`trackIndex`	`number`
`type`	`string`
`undoFrame?`	`number`
`undoInsertIndex?`	`number`
`undoTrackIndex`	`number`

RemoveClipEditObject

Extends EditObject.

Property	Type
`clip`	`ClientClip`
`index`	`number`
`track`	`ClientTrack`
`type`	`string`

SplitClipEditObject

Extends ChangePropertiesEditObject.

Property	Type
`containerRedoValues?`	`Partial`<`SignalScalarRecord`>
`containerUndoValues?`	`Partial`<`SignalScalarRecord`>
`frame`	`number`
`index`	`number`
`redoValues`	`Partial`<`SignalScalarRecord`>
`splitClip`	`ClientClip`
`target`	`Propertied`
`type`	`string`
`undoValues`	`Partial`<`SignalScalarRecord`>

UndoableEdit

Extended by ChangeEdit.

Property	Type
`affects`	`${string}.${string}`[]

Methods

redo(): void

Returns void.

undo(): void

Returns void.

updateSelection(): void

Returns void.

UndoableEdits

Property	Type
`canRedo`	`boolean`
`canSave`	`boolean`
`canUndo`	`boolean`
`mash`	`ClientMash`

Methods

create(object): void

Parameter	Type
`object`	`EditObject`

Returns void.

redo(): undefined | UndoableEdit

Returns undefined | UndoableEdit.

save(): void

Returns void.

undo(): undefined | UndoableEdit

Returns undefined | UndoableEdit.

Functions

isChangeEdit

isChangeEdit(value): value is ChangeEdit

Parameter	Type
`value`	`any`

Returns value is ChangeEdit.

isChangeEditObject

isChangeEditObject(value): value is ChangeEditObject

Parameter	Type	Description
`value`	`any`

Returns value is ChangeEditObject.

isChangePropertyEdit

isChangePropertyEdit(value): value is ChangePropertyEdit

Parameter	Type
`value`	`any`

Returns value is ChangePropertyEdit.

isChangePropertyEditObject

isChangePropertyEditObject(value): value is ChangePropertyEditObject

Parameter	Type
`value`	`any`

Returns value is ChangePropertyEditObject.

isUndoableEdit

isUndoableEdit(value): value is UndoableEdit

Parameter	Type
`value`	`any`

Returns value is UndoableEdit.

mashEditInstance

mashEditInstance(object?): UndoableEdit | UndoableEdits

Parameter	Type
`object`?	`EditObject` \| `ClientMash`

Returns UndoableEdit | UndoableEdits.