AnnotationCreatedEvent

• webVis API Reference
• AnnotationCreatedEvent

Class AnnotationCreatedEvent

ANNOTATION_CREATED ANNOTATION_CREATED

Hierarchy (View Summary)

• WebVisEvent
  • AnnotationCreatedEvent

Index

Constructors

constructor

Properties

annotationID id properties transactionCode? transactionID? type?

Accessors

anchorPosition label labelPosition nodeID transform trustedSource visible

Constructors

constructor

• new AnnotationCreatedEvent(
      annotationID: number,
      properties: AnnotationProperties,
  ): AnnotationCreatedEvent

• The AnnotationCreatedEvent occurs if an Annotation was created.

  Parameters

  • annotationID: number

    The ID of the Annotation.
  • properties: AnnotationProperties

    An object with the changed properties.

  Returns AnnotationCreatedEvent

  Overrides WebVisEvent.constructor

Properties

annotationID

annotationID: number

The ID of the Annotation.

id

id: number

Inherited from WebVisEvent.id

properties

properties: AnnotationProperties

An object with the changed properties.

OptionaltransactionCode

transactionCode?: string

Inherited from WebVisEvent.transactionCode

OptionaltransactionID

transactionID?: number

Inherited from WebVisEvent.transactionID

Optionaltype

type?: EventType

Inherited from WebVisEvent.type

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.

---

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)