IFClite TypeScript API
    Preparing search index...

    Interface AnnotationFields

    Mutable fields of a shared annotation.

    interface AnnotationFields {
        authorColor: string;
        authorId: string;
        authorName: string;
        createdAt: number;
        entityPath?: string | null;
        note: string;
        position: AnnotationPosition;
        updatedAt: number;
    }

    Hierarchy (View Summary)

    Index
    authorColor authorId authorName createdAt entityPath? note position updatedAt
    authorColor: string
    authorId: string

    Author identity (ephemeral collab identity), for attribution.

    authorName: string
    createdAt: number

    Wall-clock ms (caller-supplied so the helper stays pure/deterministic).

    entityPath?: string | null

    /<guid> of the anchored entity, or null for an empty-space pin.

    note: string

    Plain-text note body.

    position: AnnotationPosition

    World-space pin position in the renderer's local frame.

    updatedAt: number

    Settings
    Member Visibility

    On This Page
    Properties