Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface NoteData

    interface NoteData {
        _id: string | null;
        elevation?: number;
        entryId?: string | null;
        flags: DocumentFlags;
        fontFamily?: string;
        fontSize?: number;
        global?: boolean;
        iconSize?: number;
        pageId?: string | null;
        sort?: number;
        text?: string;
        textAnchor?: number;
        textColor?: string;
        texture?: TextureData;
        x?: number;
        y?: number;
    }
    Index

    Properties

    _id elevation? entryId? flags fontFamily? fontSize? global? iconSize? pageId? sort? text? textAnchor? textColor? texture? x? y?

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this BaseNote embedded document

    elevation?: number

    The elevation

    entryId?: string | null

    The _id of a JournalEntry document which this Note represents

    flags: DocumentFlags

    An object of optional key/value flags

    fontFamily?: string

    The font family used to display the text label on this note, defaults to CONFIG.defaultFontFamily

    fontSize?: number

    The font size used to display the text label on this note

    global?: boolean

    Whether this map pin is globally visible or requires LoS to see.

    iconSize?: number

    The pixel size of the map note icon

    pageId?: string | null

    The _id of a specific JournalEntryPage document which this Note represents

    sort?: number

    The sort order

    Optionaltext

    text?: string

    Optional text which overrides the title of the linked Journal Entry

    textAnchor?: number

    A value in CONST.TEXT_ANCHOR_POINTS which defines where the text label anchors to the note icon.

    textColor?: string

    The string that defines the color with which the note text is rendered

    texture?: TextureData

    An image icon used to represent this note

    x?: number

    The x-coordinate position of the center of the note icon

    y?: number

    The y-coordinate position of the center of the note icon

    Settings

    Member Visibility

    On This Page

    Properties