Version 18 Developer Release Note

Summary

The Release Note outlines the key features and updates in Version 18 of AdapTable (a major release)
It was released in April 2024 and supports AG Grid version 31.1
Provides 2 Annotations Modules - Notes and Comments
Many other improvements including: Transposing the Grid, Summary Rows & adding Column Types to Scope
New interop.io plugin to provide full AdapTable features in io.connect
Breaking Changes in how to set up AdapTable React and AdapTable Angular

AdapTable 18.0 is a major version release which contains a huge range of new, cutting-edge DataGrid functionality, particularly regarding annotating AG Grid.

Breaking Change

As a result of updates to AG Grid version 31.0, AdapTable 18 contains some Breaking Changes:
- Users of CommonJS should now install specialised CommonJS packages (TypeScript and React only)
- Implementations for AdapTable React and AdapTable Angular now use a new Provider pattern
- The Adaptable Ready Event now returns the AG Grid GridApi (instead of Grid Options)
There are no breaking changes to Initial Adaptable State (so no automated AdapTable State migration is needed)

Installing AdapTable

Users of CommonJS should now install a specialised CommonJS set of AdapTable packages

Caution

ESM users should continue to install the same set of packages
This affects users of AdapTable TypeScript and AdapTable React (AdapTable Angular users are unaffected)

Instantianting AdapTable

Instantiation for both AdapTable React and AdapTable Angular has changed
Both now use a Provider pattern which enables greater flexibility over setting up the Components

Find Out More

For full details see AdapTable React Integration and AdapTable Angular Integration

Notes & Comments

2 new Annotation-based Modules have been added (to complement FreeText Columns):

Notes - cell-based annotations provided by a user for personal use
Comments - cell-based annotations that form a conversation between users

Note

In both Modules, the annotations are stored in Adaptable State, rather than with the Grid’s underlying data source

interop.io support

A new interop.io plugin has been added to the available Plugins
This replaces the previous Finsemble and Glue42 plugins (the 2 companies merged to form interop.io)

UI Enhancements

Option to enter free text when using Date Column Filters (in place of the Date Picker)
Custom Toolbars can now also be pinned
The Bulk Update Components can receive a new (as well as existing) value

General Improvements

The Scope object now includes ColumnTypes (i.e all Columns sharing the same AG Grid Col Typeproperty)

Hint

This allows you to "group" similar columns and treat them as one (e.g. give them all the same Format)

Newly created Calculated Columns and FreeText Columns are added to the current Layout
Changes to Grid API in how to provide data to the Grid
Layouts can be configured to position Row Grouped Columns anywhere in the Grid
Data Import includes support for custom File Handlers, Columm Matching functionality and Validation
Format Columns automatically render in Grouped Rows

Menus

New default structure provided for AdapTable Column Menu and Context Menu items
A Name property is provided in the Menu Item to make it easier for developers to configure menus

AdapTable Query Language

Full support for Scalar (i.e. same row) Expressions when using Server-Side Row Model
The Query Builder supports the IN (Values) function
The Expression Editor can be given the raw value of a Named Query

Reference Changes

Notes and Comments have been added to Modules
Notes section has been added to Initial Adaptable State
Notes Options and Comments Options properties were added to Adaptable Options
Menu Options was replaced with Column Menu Options and Context Menu Options
Notes API and Comments API sections were added to Adaptable API
ScopeAPI was renamed to Column Scope API
CommentChanged Event - fires whenever Comments are changed
The AdaptableReadyInfo object in Adaptable Ready Event replaces gridOptions with agGridApi

Change Log

Key	Type	Description
AT-2621	Task	✅ Split Menu Options into Column & Context Menu Options
AT-2618	Enhancement	✅ Add Row scope to Format Columns & Badge Style
AT-2586	Enhancement	✅ Provide StateOptions property so devs can migrate State manually
AT-2584	Enhancement	✅ Make Values Filter popup resizable
AT-2557	Enhancement	✅ Refactor AdapTable Angular to use a Provider
AT-2551	Task	✅ Change EventInfo for AdaptableReady to provide AG Grid GridApi
AT-2547	Task	✅ Refactor AdapTable React to use a Provider
AT-2543	Task	✅ Add a Name property to Adaptable Menu
AT-2539	Enhancement	✅ Enable input option when filtering dates
AT-2533	Enhancement	✅ Derive Special Column default settings from AG Grid 'defaultColDef'
AT-2529	Enhancement	✅ Apend new Calculated & FreeText Columns to current Layout
AT-2522	Bug	✅ A suspended GridFilter cannot be un-suspended
AT-2519	Enhancement	✅ Remove 2,000 default for maxFilterValuesToDisplay property
AT-2518	Enhancement	✅ Replace `setInitialGridData` and `resetGridData` methods in Grid API with `loadGridData`
AT-2517	Enhancement	✅ Add support for ColumnTypes in Scope
AT-2511	Enhancement	✅ Allow Layouts to position Row Grouped Columns
AT-2502	Enhancement	✅ Allow Bulk Update Toolbar to receive a new value
AT-2495	Task	✅ Replace Glue42 and Finsemble Plugins with new interop plugin
AT-2493	Task	✅ Add a Notes feature: each user makes private notes
AT-2492	Enhancement	✅ Allow `maxFilterValuesToDisplay` property also to receive function
AT-2489	Bug	✅ Aggregated Expression fails when Group By with date
AT-2473	Enhancement	✅ Create a CalculatedColumnChanged event
AT-2469	Enhancement	✅ Don't evaluate non-scalar Calculations in server side row model
AT-2464	Enhancement	✅ Improve performance when showing Item Count in Values Filter
AT-2458	Enhancement	✅ Extend Custom Toolbars to Pinned Toolbars
AT-2450	Enhancement	✅ Add option in Expression Editor to add raw value of a Named Query
AT-2448	Enhancement	✅ Make Grid Filter Input expandable
AT-2441	Enhancement	✅ Add support for IN function in Query Builder
AT-2438	Enhancement	✅ Enable moving Plus Minus Rules up and down in Settings Panel
AT-2378	Enhancement	✅ Provide better default Column & Context Menus structure
AT-2370	Task	✅ Support AG Grid 31.1
AT-2347	Enhancement	✅ Add a Columns-matching section to Data Import wizard
AT-2271	Task	✅ Add a Comments feature: multiple users can comment on same cell
AT-2196	Enhancement	✅ Add "Edit Format Column" option to Menu
AT-1443	Task	✅ Provide separate support for ESM and CJS in released packages