Interface: INoteManagerApi

Remarks

Partial INoteManager interface that defines the note API methods

Methods

addDesignation()

addDesignation(target, config): Note<any>

Adds a designation attached to the specified target to this set

Parameters

• target: NoteRange

The range of text that the designation should be targeting

• config: DesignationConfig

The configuration for the designation

Returns

Note<any>

The designation that was added

---

byType()

byType(type): Note<any>[]

Returns an array containing the notes of the specified type

Parameters

• type: NoteType

The type of notes to retrieve

Returns

Note<any>[]

---

removeDesignation()

removeDesignation(designation): void

Removes a designation that was added manually with addDesignation()

Parameters

• designation: Note<any>

The designation to be removed

Returns

void