Making Notes

View as Markdown

Summary

  • Notes are annotations that are attached to AG Grid Cells
  • They are designed for per-user use and are stored in AdapTable State

Notes are personal annotations that run-time users attach to individual Cells in AG Grid.

Each Cell can have only one Note attached (but it can be edited).

Notes are stored in Adaptable State, rather than with the Grid’s underlying data source.

Important

  • Notes differ from Comments — Notes are personal; Comments are for colleague communication
  • Notes differ from Free Text Columns — Notes annotate single cells; Free Text is a full user-owned column

Notes can be created in 2 ways:

Caution

Deep Dive

How Notes Work in AdapTable

Notes in AdapTable
Fork
  • Four Notes in Initial State: two on name, two on license (see adaptableOptions.ts)
  • Each Note has a Note Type, which colours the triangle in the cell
Loading demo…

Defining Notes

Notes can be defined by developers at design-time using Notes Initial Adaptable State.

Developer Guide

Defining a Note

Each Note object requires the Text, the Column and the Primary Key. A created-at timestamp is optional:

initialState: {
  Note: {
    Notes: [
      {
        PrimaryKeyValue: 10270250,
        Text: 'We are using this Framework',
        ColumnId: 'name',
        CreatedAt: Date.now(),
      },
      {
        PrimaryKeyValue: 82095231,
        Text: 'Need to find out Stencil license',
        ColumnId: 'license',
      },
    ],
  },
},
1
Provide Primary Key Value

This is the Primary Key value for the row containing the Note

2
Supply the Text

The actual contents of the Note

3
Provide a ColumnId

The Id of the Column that contains the cell

4
CreatedAt (optional)

When the Note was first written (milliseconds). AdapTable stamps this automatically if omitted.

Hint

  • Other optional properties include Author (defaults to adaptableOptions.userName), UpdatedAt, & IsReadOnly
  • There is also a NoteType property (Info by default) which users can edit at run-time

Using Notes

Notes can be added by run-time users of AdapTable.

UI Step by Step Guide

Creating Notes in AdapTable

Exporting Notes

Notes are exported as cell comments in Excel and VisualExcel Reports.

UI Entitlements

The UI Entitlements behaviour for Notes is as expected for Full and Hidden Access Levels.

The ReadOnly Entitlement behaviour is that Notes provided in Initial State will be visible but they cannot be edited nor deleted, and new Notes cannot be added.

FAQ

Can I share my Notes with colleagues through Team Sharing? Technically you can, but for that use case we recommend Comments, which are designed for collaboration.