NoteApi
Provides run-time access to Notes Module and related State
TypeScript
export interfaceMethods
| Method | Description |
|---|---|
| addNote(text, primaryKeyValue, columnId) | Adds a new Note |
| deleteNote(note) | Deletes a Note |
| editNote(note) | Edits a Note |
| getAllNotes() | Gets all Notes |
| getNoteByUuid(uuid) | Returns a Note by uuid |
| getNoteForCell(cellAddress) | Gets all Notes for a cell |
| getNoteState() | Gets the Note State |
| updateNoteText(text, note) | Edits text of a Note |
Method Details
addNote
Adds a new Note
TypeScript
addNote(text: string, primaryKeyValue: any, columnId: string): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| text | string | |
| primaryKeyValue | any | |
| columnId | string |
Returns
void
deleteNote
Deletes a Note
TypeScript
deleteNote(note: AdaptableNote): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| note | AdaptableNote |
Returns
void
editNote
Edits a Note
TypeScript
editNote(note: AdaptableNote): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| note | AdaptableNote |
Returns
void
getAllNotes
Gets all Notes
TypeScript
getAllNotes(): AdaptableNotes;Returns
getNoteByUuid
Returns a Note by uuid
TypeScript
getNoteByUuid(uuid: string): AdaptableNote | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| uuid | string | note uuid |
Returns
AdaptableNote | undefined
getNoteForCell
Gets all Notes for a cell
TypeScript
getNoteForCell(cellAddress: CellAddress): AdaptableNote;Parameters
| Parameter | Type | Description |
|---|---|---|
| cellAddress | CellAddress | note position |
Returns
getNoteState
Gets the Note State
TypeScript
getNoteState(): NoteState;Returns
updateNoteText
Edits text of a Note
TypeScript
updateNoteText(text: string, note: AdaptableNote): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| text | string | |
| note | AdaptableNote |
Returns
void