AnnotationAPI

• webVis API Reference
• AnnotationAPI

Interface AnnotationAPI

These functions allow the creation and management of Annotations.

Hierarchy

• AnnotationAPI
  • ContextAPI

Index

Methods

changeAnnotation createAnnotation getAnnotationData getAnnotations removeAnnotation requestAnnotationData

Methods

changeAnnotation

• changeAnnotation(annotationId, properties): AnnotationProperties

• Changes one or more properties of an Annotation with the specified id.

  Parameters

  • annotationId: number

    The id of the Annotation you want to change.

  • properties: AnnotationProperties

    The properties of the Annotation you want change.

  Returns AnnotationProperties

  An Object with the changed Properties.
• changeAnnotation(annotationID, label?, visible?, anchorPosition?, labelPosition?, active?, transform?): void

• Parameters

  • annotationID: number

    The ID of the Annotation.

  • Optional label: string

    The text of the Annotation.

  • Optional visible: boolean

    Indicates if the Annotation should be visible or hidden.

  • Optional anchorPosition: number[] | Float32Array

    Anchor position in world space coordinates.

  • Optional labelPosition: number[] | Float32Array

    The position of the label.

  • Optional active: boolean

    DEPRECATED

  • Optional transform: number[] | Float32Array

    The transformation of the Annotation.

  Returns void

  Deprecated

  Changes an annotation.

createAnnotation

• createAnnotation(properties?): number

• Creates a new Annotation.

  Parameters

  • Optional properties: AnnotationProperties

    Initial properties of the created Annotation.

  Returns number

  The id of the newly created Annotation.
• createAnnotation(nodeID, label, visible?, anchorPosition?, labelOffset?): number

• Parameters

  • nodeID: number

    The ID of the node that the Annotation belongs to.

  • label: string

    The text of the Annotation.

  • Optional visible: boolean

    Indicates if the Annotation should be visible or hidden.

  • Optional anchorPosition: number[] | Float32Array

    Anchor position in world space coordinates.

  • Optional labelOffset: number[] | Float32Array

    The offset between anchorPosition and where the label should be displayed.

  Returns number

  The ID of the new annotation.

  Deprecated

  Creates a new annotation.

getAnnotationData

• getAnnotationData(annotationId): AnnotationData

• Parameters

  • annotationId: number

    The ID of the Annotation.

  Returns AnnotationData

  The content and properties of an annotation.

  Deprecated

getAnnotations

• getAnnotations(): number[]

• Returns number[]

  The ids of all available Annotations

removeAnnotation

• removeAnnotation(annotationId, safe?): RemoveState

• Removes the Annotation from the scene and all related Snapshots.

  Parameters

  • annotationId: number

    The ID of the Annotation.

  • Optional safe: boolean

    Performs a safe remove which interrupt the removal process if the Annotation is part of one or more Snapshots.

  Returns RemoveState

requestAnnotationData

• requestAnnotationData(annotationId): Promise<AnnotationProperties>

• Returns the AnnotationData for the specified Annotation id.

  Parameters

  • annotationId: number

    The id of the Annotation you want to request the data for.

  Returns Promise<AnnotationProperties>

  The requested Annotation data.