Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

AnnotationCreatedEventΒΆ

Class AnnotationCreatedEvent

Event that is fired when an annotation has been created.

See

Hierarchy (View Summary)

Properties

annotationID id properties transactionCode? transactionID? type?

Accessors

anchorPosition label labelPosition nodeID transform trustedSource visible

Properties

annotationID

annotationID: number

The ID of the annotation.

id

id: number

The unique ID of the event.

properties

properties: AnnotationProperties

An object with the properties to be used when creating the annotation.

OptionaltransactionCode

transactionCode?: string

The transaction code associated with the event.

OptionaltransactionID

transactionID?: number

The transaction ID associated with the event.

Optionaltype

type?: EventType

The type of the event.

Accessors

anchorPosition

  • get anchorPosition(): number[] | Float32Array<ArrayBufferLike>

  • Returns number[] | Float32Array<ArrayBufferLike>

    Deprecated

    anchorPosition is deprecated, please use properties.anchorPosition instead.

label

  • get label(): string

  • Returns string

    Deprecated

    label is deprecated, please use properties.content instead.

labelPosition

  • get labelPosition(): number[] | Float32Array<ArrayBufferLike>

  • Returns number[] | Float32Array<ArrayBufferLike>

    Deprecated

    labelPosition is deprecated, please use properties.contentOffset instead.

nodeID

  • get nodeID(): number

  • Returns number

    Deprecated

    nodeID is deprecated, please use properties.connectedNodeId instead.

transform

  • get transform(): number[] | Float32Array<ArrayBufferLike>

  • Returns number[] | Float32Array<ArrayBufferLike>

    Deprecated

    transform is deprecated.

trustedSource

  • get trustedSource(): boolean

  • Returns boolean

    Deprecated

    trustedSource is deprecated, please use properties.trustedSource instead.

visible

  • get visible(): boolean

  • Returns boolean

    Deprecated

    visible is deprecated, please use properties.enabled instead.