AnnotationCreatedEvent

• webVis API Reference
• AnnotationCreatedEvent

Class AnnotationCreatedEvent

ANNOTATION_CREATED ANNOTATION_CREATED

Hierarchy

• WebVisEvent
  • AnnotationCreatedEvent

Index

Constructors

constructor

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

Inherited from WebVisEvent.id

label

label: string

labelPosition

labelPosition: Float32Array | number[]

Optional nodeID

nodeID?: number

Optional transactionCode

transactionCode?: string

Inherited from WebVisEvent.transactionCode

Optional transactionID

transactionID?: number

Inherited from WebVisEvent.transactionID

Optional transform

transform?: Float32Array | number[]

Optional trustedSource

trustedSource?: boolean

Optional type

type?: EventType

Inherited from WebVisEvent.type

visible

visible: boolean

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)