Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

AnnotationProperties

Type Alias AnnotationProperties

AnnotationProperties: {
    anchorPosition?: [number, number, number] | Float32Array;
    connectedNodeId?: number | null;
    content?: string;
    contentOffset?: [number, number, number] | Float32Array;
    enabled?: boolean;
    name?: string;
    trustedSource?: boolean;
}

The AnnotationProperties type defines the properties of an annotation.

Type declaration

  • OptionalanchorPosition?: [number, number, number] | Float32Array

    The anchor position of the annotation.

    Default

    [0,0,0]
  • OptionalconnectedNodeId?: number | null

    The connected Node ID of the annotation.

    Default

    null
  • Optionalcontent?: string

    The content of the annotation.

    Default

    undefined
  • OptionalcontentOffset?: [number, number, number] | Float32Array

    The content offset of the annotation.

    Default

    [1,0,1]
  • Optionalenabled?: boolean

    The enabled state of the annotation.

    Default

    false
  • Optionalname?: string

    The name of the annotation.

    Default

    undefined
  • Optional ReadonlytrustedSource?: boolean

    Specifies if the annotation comes from a trusted source.

    Default

    true
 @readonly

See

AnnotationAPI