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

Methods

changeAnnotation

• changeAnnotation(annotationID: number, label?: string, visible?: boolean, anchorPosition?: Float32Array | number[], labelPosition?: Float32Array | number[], active?: boolean, transform?: Float32Array | number[]): void

• Changes an annotation.

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

    Anchor position in world space coordinates.

  • Optional labelPosition: Float32Array | number[]

    The position of the label.

  • Optional active: boolean

    DEPRECATED

  • Optional transform: Float32Array | number[]

    The transformation of the annotation.

  Returns void

createAnnotation

• createAnnotation(nodeID: number, label: string, visible?: boolean, anchorPosition?: Float32Array | number[], labelOffset?: Float32Array | number[]): number

• Creates a new annotation.

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

    Anchor position in world space coordinates.

  • Optional labelOffset: Float32Array | number[]

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

  Returns number

  The ID of the new annotation.

getAnnotationData

• getAnnotationData(annotationID: number): AnnotationData
• Parameters

  • annotationID: number

  Returns AnnotationData

  The content and properties of an annotation.

getAnnotations

• getAnnotations(): number[]
• Returns number[]

  The ids of all available annotations

removeAnnotation

• removeAnnotation(annontationID: number): void

• Removes an annotation.

  Parameters

  • annontationID: number

    The ID of the annotation.

  Returns void

---

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)