AnnotationCreatedEvent¶

Class AnnotationCreatedEvent

ANNOTATION_CREATED ANNOTATION_CREATED

Hierarchy

WebVisEvent
- AnnotationCreatedEvent

Index

Constructors

Properties

anchorPosition annotationID explicitOffset id label labelPosition nodeID transactionCode transactionID transform trustedSource type visible

Constructors

constructor

new AnnotationCreatedEvent(annotationID: number, label: string, visible: boolean, anchorPosition: Float32Array | number[], labelPosition: Float32Array | number[], explicitOffset: boolean, transform?: Float32Array | number[], trustedSource?: boolean, nodeID?: number): AnnotationCreatedEvent
The AnnotationCreatedEvent occurs if an annotation was created.
Parameters
- annotationID: number
  
  The ID of the annotation.
- label: string
  
  The text of the annotation.
- visible: boolean
  
  Indicates if the annotation should be visible or hidden.
- anchorPosition: Float32Array | number[]
  
  Anchor position in world space coordinates.
- labelPosition: Float32Array | number[]
  
  Label position in world space coordinates.
- explicitOffset: boolean
  
  Label offset was explicitly defined.
- Optional transform: Float32Array | number[]
  
  The local transform matrix of the annotation.
- Optional trustedSource: boolean
  
  Specifies if the annotation content comes from a trusted source.
- Optional nodeID: number
  
  Specifies the ID of the Node where the annotation is attached to.
Returns AnnotationCreatedEvent

Overrides WebVisEvent.constructor

Properties

anchorPosition

anchorPosition: Float32Array | number[]

annotationID

annotationID: number

explicitOffset

explicitOffset: boolean

id

id: number

label

label: string

labelPosition

labelPosition: Float32Array | number[]

`Optional` nodeID

nodeID?: number

`Optional` transactionCode

transactionCode?: string

`Optional` transactionID

transactionID?: number

`Optional` transform

transform?: Float32Array | number[]

`Optional` trustedSource

trustedSource?: boolean

`Optional` type

type?: EventType

visible

visible: boolean