Interface AnnotationsTypesDiagramsAssetLink

Models a link to a CDF Asset referenced in an engineering diagram

interface AnnotationsTypesDiagramsAssetLink {
    assetRef: AnnotationsAssetRef;
    description?: string;
    pageNumber?: number;
    symbol?: string;
    symbolRegion?: AnnotationsBoundingBox;
    text?: string;
    textRegion: AnnotationsBoundingBox;
}

Properties

assetRef description? pageNumber? symbol? symbolRegion? text? textRegion

Properties

assetRef

assetRef: AnnotationsAssetRef

The asset this annotation is pointing to

Optionaldescription

description?: string

The description of a primitive

OptionalpageNumber

pageNumber?: number

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

Min

1

Max

100000

Optionalsymbol

symbol?: string

The symbol representing the asset

OptionalsymbolRegion

symbolRegion?: AnnotationsBoundingBox

The location of the symbol representing the asset

Optionaltext

text?: string

The extracted text

textRegion

textRegion: AnnotationsBoundingBox

The location of the text mentioning the asset

Settings

Member Visibility

On This Page

Properties