Interface Annotation

See: relevant section in reference guide

interface Annotation {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "DomainModels$Annotation";
    $UnitID?: string;
    caption: string;
    exportLevel: ExportLevel;
    location: Location;
    width: number;
    delete(): void;
    getContainer(): DomainModel;
}

Hierarchy (View Summary)

ElementBase
- Annotation

Index

Properties

$CreationOptions? $ID $Type $UnitID? caption exportLevel location width

Methods

delete getContainer

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "DomainModels$Annotation"

The type of the element.

`Optional`$UnitID

$UnitID?: string

caption

caption: string

exportLevel

exportLevel: ExportLevel

location

location: Location

width

width: number

Methods

delete

delete(): void
Returns void

getContainer

getContainer(): DomainModel
Returns DomainModel