AnnotationData

Type Alias AnnotationData

AnnotationData: {
    active: boolean;
    anchorPosition: [number, number, number] | Float32Array;
    explicitOffset: boolean;
    label: string;
    labelPosition: [number, number, number] | Float32Array;
    nodeID: number;
    transform:
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
        | Float32Array;
    trustedSource: boolean;
    visible: boolean;
}

AnnotationData defines the properties and content of an annotation.

Type declaration

  • active: boolean

    Determines whether the annotation is active or not.

  • anchorPosition: [number, number, number] | Float32Array

    Determines the annotation's anchor position.

    Example

    [0, 1, 0]
  • explicitOffset: boolean

    Determines whether an explicit offset should be used or not.

  • label: string

    The label of the annotation.

    Example

    "This is a great annotation!"
  • labelPosition: [number, number, number] | Float32Array

    Determines the annotation's label position.

    Example

    [0, 2, 0]
  • nodeID: number

    The ID of a node the annotation is linked to.

  • transform:
        | [
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
            number,
        ]
        | Float32Array

    Provides the transform of the annotation.

  • trustedSource: boolean

    Determines whether the annotation source is trusted or not.

  • visible: boolean

    Determines whether the annotation is visible or not.

See

AnnotationAPI

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: