Class Action`Abstract`

An abstract over an action that changes the data model. An action can support undo operation.

Hierarchy (View Summary)

Action

Index

Constructors

Methods

accept doAction flat generateDescription getActionName getAffectedUniqueIds getBounds getDescription getFocusFeatures getID getTimestamp isLeaf isSerializable redoAction serialize setTimestamp undoAction undoSupported

Constructors

constructor

new Action(options?: ActionOptions): Action
Parameters
- Optionaloptions: ActionOptions
Returns Action

Methods

accept

accept(visitor: TreeSerializor): void
Parameters
- visitor: TreeSerializor
Returns void

`Abstract`doAction

doAction(dataModel: DataModel): boolean | void
Abstract: Should be implemented by subclasses with the logics of the action.
Parameters
- dataModel: DataModel
Returns boolean | void

flat

flat(): Action[]
Returns Action[]

generateDescription

generateDescription(_dataModel: DataModel): void
called immediately after the do action, and keep the description fixed so it wont change later on.
Parameters
- _dataModel: DataModel
Returns void

getActionName

getActionName(): ACTION_NAME
Returns ACTION_NAME

getAffectedUniqueIds

getAffectedUniqueIds(_dataModel: DataModel): ObjectUniqueId[]
Return list of all affected features, every feature that this action touched this list is used to calculate the group of the action
Parameters
- _dataModel: DataModel
Returns ObjectUniqueId[]
of feature unique ids

getBounds

getBounds(): null | BBox
Returns null | BBox

getDescription

getDescription(): string
Returns string

getFocusFeatures

getFocusFeatures(
    _dataModel: DataModel,
): (
    | FeatureVector<
        FeatureVectorId,
        WazeFeatureGeometry,
        AttributesWithOptionalGeometry<FeatureVectorId, WazeFeatureGeometry>,
    >
    | DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>
)[]
Return list of features to show their ids and allow them to be focused on Please note that it might be different from the getAffectedUniqueIds list
Parameters
- _dataModel: DataModel
Returns (
    | FeatureVector<
        FeatureVectorId,
        WazeFeatureGeometry,
        AttributesWithOptionalGeometry<FeatureVectorId, WazeFeatureGeometry>,
    >
    | DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>
)[]
of features

getID

getID(): string
Returns string

getTimestamp

getTimestamp(): number
Returns number

isLeaf

isLeaf(): boolean
Returns boolean

isSerializable

isSerializable(): boolean
Returns boolean

`Abstract`redoAction

redoAction(dataModel: DataModel): void
Abstract: Should be implemented by subclasses with the logics of re-do, only if undo is supported.
Parameters
- dataModel: DataModel
Returns void

`Abstract`serialize

serialize(): null | SerializedAction
Returns null | SerializedAction

setTimestamp

setTimestamp(timestamp: number): void
Parameters
- timestamp: number
Returns void

`Abstract`undoAction

undoAction(dataModel: DataModel): void
Abstract: Should be implemented by subclasses with the undo logics of the action, if it is supported.
Parameters
- dataModel: DataModel
Returns void

undoSupported

undoSupported(): boolean
Returns boolean