NoteData

data. NoteData

The data schema for a Note embedded document.

Constructor

new NoteData(data, documentopt)

See:
  • BaseNote
Properties:
Name Type Attributes Default Description
_id string

The _id which uniquely identifies this BaseNote embedded document

entryId string | null <optional>
null

The _id of a JournalEntry document which this Note represents

x number <optional>
0

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

y number <optional>
0

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

icon string <optional>

An image icon path used to represent this note

iconSize number <optional>
40

The pixel size of the map note icon

iconTint string <optional>

An optional color string used to tint the map note icon

text string <optional>

Optional text which overrides the title of the linked Journal Entry

fontFamily string <optional>
Signika

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

fontSize number <optional>
36

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

textAnchor number <optional>
1

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

textColor string <optional>
#FFFFFF

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

flags object <optional>
{}

An object of optional key/value flags

Parameters:
Name Type Attributes Description
data object

Initial data used to construct the data object

document BaseNote <optional>

The embedded document to which this data object belongs

Extends

  • DocumentData