Notes Technical Reference
Summary
- Notes are provided in Note section of Initial Adaptable State
- Note Options allows developers to configure which Cells can receive Notes
- Note API provides run time access to Notes
Note State
The Note State of Initial Adaptable State contains a collection of AdaptableNotes:
| Property | Description |
|---|---|
| Notes | Collection of AdapTable Notes |
Adaptable Note
The full contents of the AdaptableNote object is as follows:
| Property | Description |
|---|---|
| ColumnId | Id of Column containing the Note |
| PrimaryKeyValue | Value in Grid's Primary Key Column |
| Text | Content of the Note |
| Timestamp | When Note was made |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Note Options
The Note Options section of Adaptable Options contains options to configure Note behaviour:
| Property | Description | Default |
|---|---|---|
| dateFormat | Date Format string for Notes timestamp | 'dd-MM-yyyy HH:mm:ss' |
| isCellNotable | Whether a cell can contain Notes | |
| showNoteAction | Whether to show Notes by hovering (default) or via context menu | 'hover' |
| showPopupCloseButton | Show the Close Button in the Notes Popup | true |
Note API
Full programmatic access to Notes is available in Note API section of Adaptable API .
This enables Notes to be retrieved, created, edited and deleted programmatically.
| 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 |