Class UpdateObject<T>

constructor

• new UpdateObject<
      T extends DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>,
  >(
      object: T,
      newAttributes: Partial<DataModelObjectAttributes<T>>,
      options?: ActionOptions,
  ): UpdateObject<T>

  Type Parameters

  • T extends DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>

  Parameters

  • object: T
  • newAttributes: Partial<DataModelObjectAttributes<T>>
  • Optionaloptions: ActionOptions

  Returns UpdateObject<T>

ReadonlyactionName

doAction

• doAction(dataModel: DataModel, options?: UpdateObjectOptions): boolean

  Abstract: Should be implemented by subclasses with the logics of the action.

  Parameters

  • dataModel: DataModel
  • options: UpdateObjectOptions = {}

  Returns boolean

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

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

getFocusFeatures

• getFocusFeatures(
      _dataModel: DataModel,
  ): 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 DataModelObject<ObjectId, FeatureVectorAttributes<ObjectId>>[]

  of features

getNewAttributes

• getNewAttributes(): Partial<DataModelObjectAttributes<T>>

  Returns Partial<DataModelObjectAttributes<T>>

getObject

• getObject(): T

  Returns T

getOldAttributes

• getOldAttributes(): Partial<DataModelObjectAttributes<T>>

  Returns Partial<DataModelObjectAttributes<T>>

redoAction

• redoAction(dataModel: DataModel, options?: UpdateObjectOptions): void

  Abstract: Should be implemented by subclasses with the logics of re-do, only if undo is supported.

  Parameters

  • dataModel: DataModel
  • options: UpdateObjectOptions = {}

  Returns void

serialize

• serialize(): SerializedUpdateObjectAction<T>

  Returns SerializedUpdateObjectAction<T>

undoAction

• undoAction(dataModel: DataModel, options?: UpdateObjectOptions): void

  Abstract: Should be implemented by subclasses with the undo logics of the action, if it is supported.

  Parameters

  • dataModel: DataModel
  • options: UpdateObjectOptions = {}

  Returns void