Interface: INote<T>

Represents a note added by a user to a document

Type Parameters

• TextendsNoteType = any

Properties

author?

optionalauthor: string

An optional author for the note

---

date?

optionaldate: Date

An optional date for the note

---

fillColor

readonlyfillColor: string

The fill color for the note

• For comments, this is the note highlight color
• For designations, this is the color used for the designation indicator

---

id

readonlyid: string

An identifier for the note.

---

range

readonlyrange: NoteRangeMemento

The viewer content range that this note applies to

---

rangeString

readonlyrangeString: string

A string version of the range

---

text

text: string

The text of this note:

• For comments, this is the comment text
• For objections, this is the objection name

---

textColor?

readonlyoptionaltextColor: string

The text color for the note highlight

---

title?

optionaltitle: string

The title for the note

---

type

readonlytype: T

The note type

---

userData

readonlyuserData: UserDataMap

A map that may be used by the calling code to associate data with the note. The calling code may place any data in the UserDataMap, and that data will follow the note around until it is destroyed.