Interface AnnotationsTypesDiagramsInstanceLink

Models a link to an FDM instance referenced in an engineering diagram

interface AnnotationsTypesDiagramsInstanceLink {
    description?: string;
    instanceRef: AnnotationsInstanceRef;
    pageNumber?: number;
    symbol?: string;
    symbolRegion?: AnnotationsBoundingBox;
    text: string;
    textRegion: AnnotationsBoundingBox;
}

Properties

description? instanceRef pageNumber? symbol? symbolRegion? text textRegion

Properties

Optionaldescription

description?: string

The description of a primitive

instanceRef

instanceRef: AnnotationsInstanceRef

The FDM instance this annotation is pointing to

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 found in the file

OptionalsymbolRegion

symbolRegion?: AnnotationsBoundingBox

Optional location of a symbol

text

text: string

The extracted text

textRegion

textRegion: AnnotationsBoundingBox

The location of the text mentioning the file

Settings

Member Visibility

On This Page

Properties