Class ActionManager

constructor

• new ActionManager(dataModel: DataModel): ActionManager

  Parameters

  • dataModel: DataModel

  Returns ActionManager

events

_clearActions

• _clearActions(): void

  Returns void

_clearGroupsByIds

• _clearGroupsByIds(groupIds: string[]): boolean

  Parameters

  • groupIds: string[]

  Returns boolean

_clearRedoStackOfGroup

• _clearRedoStackOfGroup(groupId: string): boolean

  Parameters

  • groupId: string

  Returns boolean

_filterActionsByGroupId

• _filterActionsByGroupId(actions: Action[], groupId: string): Action[]

  Parameters

  • actions: Action[]
  • groupId: string

  Returns Action[]

_getGroupsWithOnlyRevertedChanges

• _getGroupsWithOnlyRevertedChanges(): string[]

  Returns string[]

_groupActions

• _groupActions(actions: Action[]): Dictionary<Action[]>

  Parameters

  • actions: Action[]

  Returns Dictionary<Action[]>

_redoAction

• _redoAction(action: Action): undefined | false

  Parameters

  • action: Action

  Returns undefined | false

_removeActionsFromStackByGroupId

• _removeActionsFromStackByGroupId(stack: Action[], groupId: string): boolean

  Parameters

  • stack: Action[]
  • groupId: string

  Returns boolean

_triggerAfterClearActions

• _triggerAfterClearActions(action?: Action): void

  Parameters

  • Optionalaction: Action

  Returns void

_undoAction

• _undoAction(
      action: Action,
      __namedParameters?: { supportRedo: boolean },
  ): undefined | false

  Parameters

  • action: Action
  • __namedParameters: { supportRedo: boolean } = ...

  Returns undefined | false

add

• add(action: Action): boolean

  Parameters

  • action: Action

  Returns boolean

canRedo

• canRedo(): boolean

  Returns boolean

canRedoAction

• canRedoAction(action: Action): boolean

  Parameters

  • action: Action

  Returns boolean

canSave

• canSave(): boolean

  Returns boolean

canUndo

• canUndo(): boolean

  Returns boolean

canUndoAction

• canUndoAction(action: Action): boolean

  Parameters

  • action: Action

  Returns boolean

clear

• clear(): void

  Returns void

clearGroupsOfActions

• clearGroupsOfActions(actions: Action[]): void

  clear all the groups of list of actions then clear all the groups

  Parameters

  • actions: Action[]

    list of actions

  Returns void

clearGroupsWithOnlyRevertedChanges

• clearGroupsWithOnlyRevertedChanges(): void

  Returns void

getActionById

• getActionById(id: string): Action

  Parameters

  • id: string

  Returns Action

getActionGroups

• getActionGroups(): DisjointSet

  Returns DisjointSet

getActions

• getActions(includeRedoStack?: boolean): Action[]

  Parameters

  • includeRedoStack: boolean = false

  Returns Action[]

getActionsByGroupId

• getActionsByGroupId(groupId: string, includeRedo?: boolean): Action[]

  Parameters

  • groupId: string
  • includeRedo: boolean = false

  Returns Action[]

getActionsByGroupsIds

• getActionsByGroupsIds(includeRedo?: boolean): Dictionary<Action[]>

  Parameters

  • includeRedo: boolean = false

  Returns Dictionary<Action[]>

getActionsGroupIds

• getActionsGroupIds(actions: Action[]): string[]

  Parameters

  • actions: Action[]

  Returns string[]

getChangesBounds

• getChangesBounds(): null | BBox

  Returns null | BBox

getEditedTurns

• getEditedTurns(): Turn[]

  Returns Turn[]

getFlatActions

• getFlatActions(): Action[]

  Returns Action[]

getRedoStack

• getRedoStack(): Action[]

  Returns Action[]

isAllowedToSave

• isAllowedToSave(): boolean

  Returns boolean

redo

• redo(): boolean

  Returns boolean

redoEntireGroupById

• redoEntireGroupById(groupId: string): void

  redo entire group by id

  Parameters

  • groupId: string

    group id to redo

  Returns void

redoGroupAction

• redoGroupAction(action: Action): number

  redo group action and make sure that all actions before it in the same group are restored

  Parameters

  • action: Action

    to restore

  Returns number

  number of restored actions

removeAction

• removeAction(): void

  Returns void

setSavingEnabled

• setSavingEnabled(isSavingEnabled: boolean): void

  Parameters

  • isSavingEnabled: boolean

  Returns void

undo

• undo(): boolean

  Returns boolean

undoAll

• undoAll(): void

  Returns void

undoEntireGroupById

• undoEntireGroupById(groupId: string): void

  undo entire group by id

  Parameters

  • groupId: string

    group id to revert

  Returns void

undoGroupAction

• undoGroupAction(action: Action): number

  undo group action and make sure that all actions after it in the same group are reverted

  Parameters

  • action: Action

    to restore

  Returns number

  number of reverted actions

unsavedActionsNum

• unsavedActionsNum(): number

  Returns number