Interface NoteData

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

Properties

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

Properties

_id

_id: null | string

The _id which uniquely identifies this BaseNote embedded document

Optionalelevation

elevation?: number

The elevation

OptionalentryId

entryId?: null | string

The _id of a JournalEntry document which this Note represents

flags

flags: DocumentFlags

An object of optional key/value flags

OptionalfontFamily

fontFamily?: string

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

OptionalfontSize

fontSize?: number

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

Optionalglobal

global?: boolean

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

OptionaliconSize

iconSize?: number

The pixel size of the map note icon

OptionalpageId

pageId?: null | string

The _id of a specific JournalEntryPage document which this Note represents

Optionalsort

sort?: number

The sort order

Optionaltext

text?: string

Optional text which overrides the title of the linked Journal Entry

OptionaltextAnchor

textAnchor?: number

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

OptionaltextColor

textColor?: string

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

Optionaltexture

texture?: TextureData

An image icon used to represent this note

Optionalx

x?: number

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

Optionaly

y?: number

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

Settings

Member Visibility

On This Page

Properties