AnnotationData¶

Interface AnnotationData

AnnotationData defines the properties and content of an annotation.

See

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

Index

Properties

active anchorPosition explicitOffset label labelPosition nodeID transform trustedSource visible

Properties

active

active: boolean

Determines whether the annotation is active or not.

anchorPosition

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

Determines the annotation's anchor position.

Example

[0, 1, 0]

explicitOffset

explicitOffset: boolean

Determines whether an explicit offset should be used or not.

label

label: string

The label of the annotation.

Example

"This is a great annotation!"

labelPosition

labelPosition: Float32Array<ArrayBufferLike> | [number, number, number]

Determines the annotation's label position.

Example

[0, 2, 0]

nodeID

nodeID: number

The ID of a node the annotation is linked to.

transform

transform:
    | Float32Array<ArrayBufferLike>
    | [
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
        number,
    ]

Provides the transform of the annotation.

trustedSource

trustedSource: boolean

Determines whether the annotation source is trusted or not.

visible

visible: boolean

Determines whether the annotation is visible or not.

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