AnnotationProperties

Interface AnnotationProperties

The AnnotationProperties type defines the properties of an annotation.

See

AnnotationAPI

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

Properties

anchorPosition? connectedNodeId? content? contentOffset? enabled? name? trustedSource?

Properties

OptionalanchorPosition

anchorPosition?: Float32Array<ArrayBufferLike> | [number, number, number]

The anchor position of the annotation.

Default

[0,0,0]

OptionalconnectedNodeId

connectedNodeId?: number

The connected Node ID of the annotation.

Default

null

Optionalcontent

content?: string

The content of the annotation.

Default

undefined

OptionalcontentOffset

contentOffset?: Float32Array<ArrayBufferLike> | [number, number, number]

The content offset of the annotation.

Default

[1,0,1]

Optionalenabled

enabled?: boolean

The enabled state of the annotation.

Default

false

Optionalname

name?: string

The name of the annotation.

Default

undefined

Optional ReadonlytrustedSource

trustedSource?: boolean

Specifies if the annotation comes from a trusted source.

Default

true
 @readonly
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: