Interface AnnotationsIsoPlanAnnotation

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

interface AnnotationsIsoPlanAnnotation {
    detail?: string;
    fileRef?: AnnotationsFileRef;
    indirectExternalId?: AnnotationsAssetRef;
    indirectRelation?: string;
    lineExternalId?: AnnotationsAssetRef;
    linkedResourceExternalId?: string;
    linkedResourceInternalId?: number;
    linkedResourceType?: "asset" | "file";
    oldAnnotationId?: string;
    pageNumber?: number;
    relativePosition?: string;
    revision?: string;
    sizeAndClass?: AnnotationsSizeAndClassType;
    sourceType?: "pipeline" | "user";
    subDetail?: string;
    text?: string;
    textRegion?: AnnotationsBoundingBox;
    type?: string;
    vertices?: AnnotationsPolyLine;
}

Properties

detail? fileRef? indirectExternalId? indirectRelation? lineExternalId? linkedResourceExternalId? linkedResourceInternalId? linkedResourceType? oldAnnotationId? pageNumber? relativePosition? revision? sizeAndClass? sourceType? subDetail? text? textRegion? type? vertices?

Properties

Optionaldetail

detail?: string

Detail describing the equipment.

OptionalfileRef

fileRef?: AnnotationsFileRef

The asset this annotation is pointing at. Store the id of the file assets to generate downloadable URL.

OptionalindirectExternalId

indirectExternalId?: AnnotationsAssetRef

The indirectExternalId is the external id of the equipment used to identify the hotspot indirectly. Exa. this is the of .

OptionalindirectRelation

indirectRelation?: 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'.

OptionallineExternalId

lineExternalId?: AnnotationsAssetRef

The id of the Pipe that the hotspot belongs to.

OptionallinkedResourceExternalId

linkedResourceExternalId?: string

Stores Functional Locations (FLOC) external ID linked to the annotation.

OptionallinkedResourceInternalId

linkedResourceInternalId?: number

Stores Functional Locations' (FLOC) ID linked to the annotation.

OptionallinkedResourceType

linkedResourceType?: "asset" | "file"

Stores Functional Location (FLOC) type the annotation linked to.

OptionaloldAnnotationId

oldAnnotationId?: string

Keep track of data link with old annotations.

OptionalpageNumber

pageNumber?: number

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

Min

1

Max

100000

OptionalrelativePosition

relativePosition?: string

Indicate the relative position of an annotation.

Optionalrevision

revision?: string

Keeps track of the modification to an annotation.

OptionalsizeAndClass

sizeAndClass?: AnnotationsSizeAndClassType

Stores the dimensions of a valve or spade.

OptionalsourceType

sourceType?: "pipeline" | "user"

Use to identify whether the annotation is user created one or ditected via pipeline.

OptionalsubDetail

subDetail?: string

Use to save the fluid code of pipes Exa. LO for Lube oil and etc.

Optionaltext

text?: string

The pattern identified by the detection API results.

OptionaltextRegion

textRegion?: AnnotationsBoundingBox

The location of the hotspot represented with a bounding box.

Optionaltype

type?: string

Type of equipment, valve, pump etc.

Optionalvertices

vertices?: AnnotationsPolyLine

Stores the (x,y) coordinate pairs of a line or polyline.

Settings

Member Visibility

On This Page

Properties