AnnotationCreatedEvent

• webVis API Reference
• AnnotationCreatedEvent

Class AnnotationCreatedEvent

ANNOTATION_CREATED ANNOTATION_CREATED

Hierarchy

• 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, properties): 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.

Optional transactionCode

transactionCode?: string

Inherited from WebVisEvent.transactionCode

Optional transactionID

transactionID?: number

Inherited from WebVisEvent.transactionID

Optional type

type?: EventType

Inherited from WebVisEvent.type

Accessors

anchorPosition

• get anchorPosition(): Float32Array | number[]

• Returns Float32Array | number[]

  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(): Float32Array | number[]

• Returns Float32Array | number[]

  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(): Float32Array | number[]

• Returns Float32Array | number[]

  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.