AnnotationAPI

Interface AnnotationAPI

These functions allow the creation and management of Annotations.

interface AnnotationAPI {
    changeAnnotation(
        annotationId: number,
        properties: AnnotationProperties,
    ): AnnotationProperties;
    changeAnnotation(
        annotationID: number,
        label?: string,
        visible?: boolean,
        anchorPosition?: number[] | Float32Array<ArrayBufferLike>,
        labelPosition?: number[] | Float32Array<ArrayBufferLike>,
        active?: boolean,
        transform?: number[] | Float32Array<ArrayBufferLike>,
    ): void;
    createAnnotation(properties?: AnnotationProperties): number;
    createAnnotation(
        nodeID: number,
        label: string,
        visible?: boolean,
        anchorPosition?: number[] | Float32Array<ArrayBufferLike>,
        labelOffset?: number[] | Float32Array<ArrayBufferLike>,
    ): number;
    getAnnotationData(annotationId: number): AnnotationData;
    getAnnotations(): number[];
    removeAnnotation(annotationId: number, safe?: boolean): RemoveState;
    requestAnnotationData(annotationId: number): Promise<AnnotationProperties>;
}

Hierarchy (View Summary)

Methods

changeAnnotation createAnnotation getAnnotationData getAnnotations removeAnnotation requestAnnotationData

Methods

changeAnnotation

  • changeAnnotation(
        annotationId: number,
        properties: AnnotationProperties,
    ): 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: number,
        label?: string,
        visible?: boolean,
        anchorPosition?: number[] | Float32Array<ArrayBufferLike>,
        labelPosition?: number[] | Float32Array<ArrayBufferLike>,
        active?: boolean,
        transform?: number[] | Float32Array<ArrayBufferLike>,
    ): void

  • Parameters

    • annotationID: number

      The ID of the Annotation.

    • Optionallabel: string

      The text of the Annotation.

    • Optionalvisible: boolean

      Indicates if the Annotation should be visible or hidden.

    • OptionalanchorPosition: number[] | Float32Array<ArrayBufferLike>

      Anchor position in world space coordinates.

    • OptionallabelPosition: number[] | Float32Array<ArrayBufferLike>

      The position of the label.

    • Optionalactive: boolean

      DEPRECATED

    • Optionaltransform: number[] | Float32Array<ArrayBufferLike>

      The transformation of the Annotation.

    Returns void

    Deprecated

    Changes an annotation.

createAnnotation

  • createAnnotation(properties?: AnnotationProperties): number

  • Creates a new Annotation.

    Parameters

    Returns number

    The id of the newly created Annotation.

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

  • Parameters

    • nodeID: number

      The ID of the node that the Annotation belongs to.

    • label: string

      The text of the Annotation.

    • Optionalvisible: boolean

      Indicates if the Annotation should be visible or hidden.

    • OptionalanchorPosition: number[] | Float32Array<ArrayBufferLike>

      Anchor position in world space coordinates.

    • OptionallabelOffset: number[] | Float32Array<ArrayBufferLike>

      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: number): 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: number, safe?: boolean): RemoveState

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

    Parameters

    • annotationId: number

      The ID of the Annotation.

    • Optionalsafe: 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: number): 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.

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?
Please tell us more about what's wrong: