Class DataModelObject<TObjectId, TAttributes>Abstract

constructor

• new DataModelObject<
      TObjectId extends ObjectId = ObjectId,
      TAttributes extends
          FeatureVectorAttributes<TObjectId> = FeatureVectorAttributes<TObjectId>,
  >(
      attributes: ObjectAttributes | Partial<TAttributes>,
      permissions?: BasePermissions,
  ): DataModelObject<TObjectId, TAttributes>

  Type Parameters

  • TObjectId extends ObjectId = ObjectId
  • TAttributes extends FeatureVectorAttributes<TObjectId> = FeatureVectorAttributes<TObjectId>

  Parameters

  • attributes: ObjectAttributes | Partial<TAttributes>
  • permissions: BasePermissions = {}

  Returns DataModelObject<TObjectId, TAttributes>

StaticALL_PERMISSIONS

arePropertiesEditable

• arePropertiesEditable(): boolean

  Returns boolean

arePropertiesSuggestible

• arePropertiesSuggestible(): boolean

  Whether the current user can suggest a property change for the object

  Returns boolean

changeID

• changeID(newID: TObjectId): void

  Parameters

  • newID: TObjectId

  Returns void

clone

• clone(): DataModelObject<TObjectId, TAttributes>

  Returns DataModelObject<TObjectId, TAttributes>

getAttribute

• getAttribute<TAttributeKey extends string | number | symbol>(
      key: TAttributeKey,
  ): TAttributes[TAttributeKey]

  Type Parameters

  • TAttributeKey extends string | number | symbol

  Parameters

  • key: TAttributeKey

  Returns TAttributes[TAttributeKey]

getAttributes

• getAttributes(): TAttributes

  Returns TAttributes

getCreatedBy

• getCreatedBy(): undefined | null | number

  Returns undefined | null | number

getCreatedOn

• getCreatedOn(): undefined | null | number

  Returns undefined | null | number

getID

• getID(): TObjectId

  Returns TObjectId

getIsInBbox

• getIsInBbox(): boolean

  Returns boolean

getPermissions

• getPermissions(): number

  Returns number

getPrevID

• getPrevID(): null | TObjectId

  Returns null | TObjectId

getState

• getState(): null | OBJECT_STATE

  Returns null | OBJECT_STATE

getSuggestionPermissions

• getSuggestionPermissions(): number

  Returns number

getType

• getType(): DataModelObjectType

  Returns DataModelObjectType

getUniqueID

• getUniqueID(): ObjectUniqueId

  Returns ObjectUniqueId

getUniqueIdentifier

• getUniqueIdentifier(): UniqueObjectIdentifier<TObjectId, DataModelObjectType>

  Returns UniqueObjectIdentifier<TObjectId, DataModelObjectType>

getUpdatedBy

• getUpdatedBy(): undefined | null | number

  Returns undefined | null | number

getUpdatedOn

• getUpdatedOn(): undefined | null | number

  Returns undefined | null | number

getVersion

• getVersion(): undefined | number

  Returns undefined | number

hasPermissionFlag

• hasPermissionFlag(
      key:
          | "NO_PERMISSION"
          | "EDIT_GEOMETRY"
          | "EDIT_PROPERTIES"
          | "DELETE"
          | "EDIT_EMPTY_STREET"
          | "SPLIT_DIRECTIONS"
          | "SET_UNKNOWN_DIRECTIONS"
          | "EDIT_HOUSE_NUMBERS"
          | "FORCE_HOUSE_NUMBERS"
          | "EDIT_CONNECTIONS"
          | "EDIT_ROUTING_ROAD_TYPE"
          | "EDIT_CLOSURES"
          | "EDIT_HEADLIGHTS_REMINDER"
          | "EDIT_AVERAGE_SPEED_CAMERA"
          | "EDIT_BEACONS"
          | "EDIT_DIRECTIONS"
          | "EDIT_TURN_GUIDANCE"
          | "EDIT_OPEN_TURNS"
          | "EDIT_CLOSE_TURNS"
          | "EDIT"
          | "FORCE_CLOSE"
          | "PUBLISH"
          | "SET_READY"
          | "EDIT_UPDATE_REQUESTS"
          | "EDIT_EXTERNAL_PROVIDERS",
  ): boolean

  Parameters

  • key:
        | "NO_PERMISSION"
        | "EDIT_GEOMETRY"
        | "EDIT_PROPERTIES"
        | "DELETE"
        | "EDIT_EMPTY_STREET"
        | "SPLIT_DIRECTIONS"
        | "SET_UNKNOWN_DIRECTIONS"
        | "EDIT_HOUSE_NUMBERS"
        | "FORCE_HOUSE_NUMBERS"
        | "EDIT_CONNECTIONS"
        | "EDIT_ROUTING_ROAD_TYPE"
        | "EDIT_CLOSURES"
        | "EDIT_HEADLIGHTS_REMINDER"
        | "EDIT_AVERAGE_SPEED_CAMERA"
        | "EDIT_BEACONS"
        | "EDIT_DIRECTIONS"
        | "EDIT_TURN_GUIDANCE"
        | "EDIT_OPEN_TURNS"
        | "EDIT_CLOSE_TURNS"
        | "EDIT"
        | "FORCE_CLOSE"
        | "PUBLISH"
        | "SET_READY"
        | "EDIT_UPDATE_REQUESTS"
        | "EDIT_EXTERNAL_PROVIDERS"

  Returns boolean

isAllowed

• isAllowed(permission: number): boolean

  Parameters

  • permission: number

  Returns boolean

isAllowedForSuggestion

• isAllowedForSuggestion(suggestionPermission: number): boolean

  Parameters

  • suggestionPermission: number

  Returns boolean

isDeleteable

• isDeleteable(): boolean

  Returns boolean

isDeleted

• isDeleted(): boolean

  Returns boolean

isDeleteSuggestible

• isDeleteSuggestible(): boolean

  Returns boolean

isGeometryEditable

• isGeometryEditable(): boolean

  Returns boolean

isGeometrySuggestible

• isGeometrySuggestible(): boolean

  Whether the current user can suggest a geometry change for the object

  Returns boolean

isInserted

• isInserted(): boolean

  Returns boolean

isInUse

• isInUse(
      options?: { keepSelected?: boolean; keepUnsaved?: boolean },
  ): undefined | boolean

  Returns true if object is currently in use and should not be deleted.

  Parameters

  • options: { keepSelected?: boolean; keepUnsaved?: boolean } = ...

    See DataModelRepository.clear for available options

  Returns undefined | boolean

  true if object is in use

isNew

• isNew(): boolean

  Returns boolean

isOutOfScope

• isOutOfScope(): boolean

  Returns boolean

isSelected

• isSelected(): boolean

  Returns boolean

isSnapped

• isSnapped(): boolean

  Returns boolean

isUnchanged

• isUnchanged(): boolean

  Returns boolean

isUpdated

• isUpdated(): boolean

  Returns boolean

merge

• merge(attributes: Partial<TAttributes>): void

  Parameters

  • attributes: Partial<TAttributes>

  Returns void

resetOutOfScope

• resetOutOfScope(): void

  Returns void

setAttribute

• setAttribute<TAttributeKey extends string | number | symbol>(
      key: TAttributeKey,
      value: TAttributes[TAttributeKey],
  ): void

  Type Parameters

  • TAttributeKey extends string | number | symbol

  Parameters

  • key: TAttributeKey
  • value: TAttributes[TAttributeKey]

  Returns void

setAttributes

• setAttributes(attributes: Partial<TAttributes>): void

  Parameters

  • attributes: Partial<TAttributes>

  Returns void

setID

• setID(id: TObjectId): void

  Parameters

  • id: TObjectId

  Returns void

setIsInBboxToTrue

• setIsInBboxToTrue(): void

  Returns void

setOutOfScope

• setOutOfScope(): void

  Returns void

setSelected

• setSelected(isSelected: boolean): void

  Parameters

  • isSelected: boolean

  Returns void

setSnapped

• setSnapped(isSnapped: boolean): void

  Parameters

  • isSnapped: boolean

  Returns void

setState

• setState(state: null | OBJECT_STATE): void

  Parameters

  • state: null | OBJECT_STATE

  Returns void

setVersion

• setVersion(version: number): void

  Parameters

  • version: number

  Returns void

wasCreatedBy

• wasCreatedBy(user: User | LoggedInUser): boolean

  Parameters

  • user: User | LoggedInUser

  Returns boolean