Class CreateObject<T>

An action for creating a new object in the model.

Type Parameters

T extends DataModelObject

Hierarchy (View Summary)

Action
- CreateObject
  - CreateObjectLegacy

Constructors

constructor

new CreateObject<
    T extends DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>,
>(
    object: T,
    options?: ActionOptions,
): CreateObject<T>
Type Parameters
- T extends DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>
Parameters
- object: T
- Optionaloptions: ActionOptions
Returns CreateObject<T>
Overrides Action.constructor

Properties

`Readonly`actionName

actionName: ACTION_NAME = ACTION_NAME.CREATE_OBJECT

Action name must be unique for every action. Once you set a value, do not change it later on.

Methods

accept

accept(visitor: TreeSerializor): void
Parameters
- visitor: TreeSerializor
Returns void
Inherited from Action.accept

doAction

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

flat

flat(): Action[]
Returns Action[]
Inherited from Action.flat

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
Overrides Action.generateDescription

getActionName

getActionName(): ACTION_NAME
Returns ACTION_NAME
Inherited from Action.getActionName

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

Overrides Action.getAffectedUniqueIds

getAttributes

getAttributes(): Partial<DataModelObjectAttributes<T>>
Returns Partial<DataModelObjectAttributes<T>>

getBounds

getBounds(): null | BBox
Returns null | BBox
Inherited from Action.getBounds

getDescription

getDescription(): string
Returns string
Inherited from Action.getDescription

getFocusFeatures

getFocusFeatures(_dataModel: DataModel): [T]
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 [T]
of features

Overrides Action.getFocusFeatures

getID

getID(): string
Returns string
Inherited from Action.getID

getObject

getObject(): T
Returns T

getTimestamp

getTimestamp(): number
Returns number
Inherited from Action.getTimestamp

isLeaf

isLeaf(): boolean
Returns boolean
Inherited from Action.isLeaf

isSerializable

isSerializable(): boolean
Returns boolean
Inherited from Action.isSerializable

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
Overrides Action.redoAction

serialize

serialize(): SerializedAction
Returns SerializedAction
Overrides Action.serialize

setTimestamp

setTimestamp(timestamp: number): void
Parameters
- timestamp: number
Returns void
Inherited from Action.setTimestamp

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
Overrides Action.undoAction

undoSupported

undoSupported(): boolean
Returns boolean
Inherited from Action.undoSupported