• Public
  • Public/Protected
  • All

Model a custom link in a engineering diagram where it capture details from the texts and linked to assets when necessary


  • AnnotationsIsoPlanAnnotation



Optional assetRef

The asset this annotation is pointing to

Optional detail

detail: undefined | string

Detail describing the equipment, not identifying it. E..g 12V12 for a valve.

Optional indirectExternalId

indirectExternalId: AnnotationsAssetRef

indirectExternalId is the external id of the equipment used to identify the hotspot indirectly. E.g. this is the of

Optional indirectRelation

indirectRelation: undefined | string

Relation connecting this hotspot to a tag in case the hotspot has no tag. E.g. 'second valve upstreams of'. This references the 'indirectExternalId'

Optional lineExternalId

lineExternalId: AnnotationsAssetRef

The id of the Pipe that the hotspot belongs to

Optional pageNumber

pageNumber: undefined | number

The number of the page on which this annotation is located. The first page has number 1.





Optional relativePosition

relativePosition: undefined | string

Indicate the relative position of an annotation

Optional revision

revision: undefined | string

Keeps track of the modification to an annotation

Optional sizeAndClass

Store the dimensions of a valve or spade

Optional text

text: undefined | string

The text input

Optional textRegion

The location of the hotspot represented with a bounding box

Optional type

type: undefined | string

Type of equipment, valve, pump etc.