Version 17 Release Note
Summary
- The Release Note outlines the key features and updates in Version 17 of AdapTable
- It was released in January 2024 and supports AG Grid version 30
Breaking Change
- Upgrading Queries into Grid Filters has necessitated a few Breaking Changes in Version 17
- They include removing
Querysection of Initial Adaptable State and changes to Adaptable API & Adaptable Options - See below for full details of all breaking changes and those which are automatically updated by AdapTable
New Modules
2 new Modules have been added in AdapTable 17.
Grid Filter
- The Grid Filter Module replaces the (confusingly-named)
QueriesModule - It provides the same Expressions-based querying capability and is also evaluated by AdapTableQL
- A Grid Filter is attached to a single Layout (and can be run in conjunction with Column Filters)
Data Import
- The Data Import Module allows run-time users to import data into AdapTable
- It supports both updating existing Rows and adding new Rows
Enhancements
AdapTable 17 includes a huge number of enhancements and improvements:
Menus
- The Column and Context Menus have been refactored; each is now configured using a single property
- Menu Items for Column Filters have been consolidated (with options to suspend or clear Filters)
User Interface
- New Query Builder UI to enable building Expressions quickly and intuitively
- New Dropdown / Select component which supports type-ahead
- New option to pin toolbars in the Dashboard directly above Grid (rather than in Tabs)
Hint
This is particularly useful for Grid Filter as you can put the toolbar directly above the Grid near the Column Filters
- Calculated Column wizard allows you to choose the type of Calculated Column in the first step
- Improvements to Grid & Column Info Panels
General
- Full support for External Chart Libraries
- Developers can write custom Quick Search implementations
- Quick Search now also runs in Pivot Layouts
- Badge Style supports Array columns (multiple Badges can be displayed in a cell)
- Report Names can be provided via a developer-provided function
AdapTableQL
- 3 New Boolean Expression Functions available for use in AdapTableQL:
Regex,IS_NUMERIC,IS_NOT_BLANK - The
TODAYExpression Function has been renamed asCURRENT_DAY - 2 New Observable Expression Functions added to AdapTableQL:
ADDED_ROW,REMOVED_ROW - A Custom Predicate will now replace a System Predicate which has the same name
Versioning Updates
AdapTable 17 has updated the minimum version for some core libraries and frameworks.
AdapTable React
- React 18 is now the minimum supported version of React
Note
It is therefore no longer necessary to provide a renderReactRoot implementation
Breaking Change
The renderReactRoot prop has been removed
AdapTable Angular
- AdapTable now supports Angular LTS versioning (similar to AG Grid)
- This means Angular 15 is the current minimum supported version
- We also updated the RxJS dependency version to ^7.4.0.
Hint
- We highly recommend upgrading your RxJS version to 7.x
- Although not mandatory, it comes with significant benefits, e.g. improved performance & reduced bundle size
Typescript
- The minimum version of TypeScript supported is updated to 4.9.5
Coding Changes
The following changes have been to AdapTable's public classes:
AdapTable Modules
These changes have been made to AdapTable Modules:
Querieshas been replaced by 2 new Modules: Grid Filter and Named QueryFiltershas been replaced with Column Filters
Breaking Change
FilterorQueryreferences in Dashboard, Tool Panel, Status Bar or Settings Panel Initial State won't be read- However AdapTable will automatically update all old Initial State the first time an application loads post update
Initial Adaptable State
- In Initial Adaptable State the
Querysection of was removed and its 2 properties have been replaced as follows:CurrentQueryis now theGridFilterproperty (of typeGridFilter) in a LayoutNamedQueriesis now theNamedQueriesproperty in a new section of AdapTable State called Named Query
Breaking Change
- The previous
QueriesState will no longer work in Version 17 - However AdapTable will automatically update all old Initial State the first time an application loads post update
Adaptable Options
The changes to Adaptable Options are:
- A new Grid Filter Options section has been provided
FilterOptionsis renamed as Column Filter Options and many properties placed into 3 new sectionsquickFilterOptionsfilterFormOptionsvaluesFilterOptions
- Changes to Menu Options to facilitate the refactoring of Menus
AdapTable API
- Two new sections have been added to Adaptable API:
- Grid Filter API handles the Grid Filter
- Named Query API handles Named Queries
- The previous
QueryAPIsection has been removed FilterAPIhas been renamed as Column Filter API
AdapTable Events
The following changes have been made to the Adaptable Events:
ColumnFilterAppliedreplacesFilterApplied(See Column Filter Technical Reference)GridFilterAppliedreplacesQueryRun(See Grid Filter Technical Reference)DataImportedhas been added (See Data Import Technical Reference)CellSelectionChangedandRowSelectionChangedreplaceSelectionChanged(See Selection Technical Reference)
Documentation Changes
- We have made some cosmetic, but hopefully useful, changes to this Documentation
- Sections have been added to the Sidebar to group similar pages together
Change Log
| Key | Type | Description |
|---|---|---|
| AT-2443 | Enhancement | ✅ Add Data Validation as new Alert Type |
| AT-2435 | Bug | ✅ Cannot pin the Tree View column |
| AT-2433 | Enhancement | ✅ Add scrolling to Columns list in Expression Editor |
| AT-2430 | Task | ✅ Upgrade RxJS version to ^7.4.0 |
| AT-2429 | Task | ✅ Upgrade Typescript minimum version to 4.9.5 |
| AT-2427 | Enhancement | ✅ Add option whether to show a Column in Action Row Form |
| AT-2420 | Enhancement | ✅ Layout UI should take Column & Grid Filter entitlements into account |
| AT-2418 | Enhancement | ✅ Replace useAdaptableQuickFilter & useAdaptableFilterForm properties in Column Filter Options with single property |
| AT-2410 | Enhancement | ✅ Add Values and ExcludeValues predicates for FlashingCell |
| AT-2407 | Enhancement | ✅ Add a REGEX Expression Function |
| AT-2406 | Enhancement | ✅ Add IS_NUMERIC Expression Function |
| AT-2404 | Enhancement | ✅ Add IS_NOT_BLANK Expression Function |
| AT-2403 | Enhancement | ✅ Remove the "PrimaryKeyDuplicate" Predicate |
| AT-2402 | Task | ✅ Upgrade to React 18 |
| AT-2400 | Enhancement | ✅ Update Layout Wizard to add a Grid Filter step |
| AT-2391 | Enhancement | ✅ Update & enhance Openfin Notifications |
| AT-2381 | Task | ✅ Support Angular LTS versioning (currently 15 minimum) |
| AT-2380 | Enhancement | ✅ Add DeleteAllFormatColumn api method |
| AT-2377 | Enhancement | ✅ Add Menu Items for (un)suspending ColumnFilters |
| AT-2371 | Study | ✅ Add new Grid Filter module (to replace Queries) |
| AT-2368 | Bug | ✅ Fix DashboardChanged event handling for Custom Toolbars |
| AT-2365 | Bug | ✅ Custom Toolbars are rendered incorrectly in framework versions |
| AT-2364 | Enhancement | ✅ Allow devs to provide a function which will create the report name |
| AT-2362 | Task | ✅ Provide UI Query Builder (to create boolean expressions) |
| AT-2359 | Task | ✅ Create new Select control with autocomplete and Column selection |
| AT-2353 | Enhancement | ✅ Create a new Data Imported Event |
| AT-2348 | Task | ✅ Create Pinned Toolbars to sit above Grid |
| AT-2336 | Task | ✅ Refactor Column & Context Menus to merge functions into 1 property |
| AT-2335 | Task | ✅ Create "Import Data" Module allowing run time users to upload data |
| AT-2314 | Study | ✅ Improve support for external Charting libraries |
| AT-2310 | Task | ✅ Refactor Grid Info and Column Info Modules |
| AT-2254 | Task | ✅ Enable Badges in String Array columns |
| AT-2247 | Bug | ✅ Filter Form closes after selecting first date in Range |
| AT-2222 | Enhancement | ✅ Add separate Cell and Row Selection Changed Events |
| AT-2214 | Task | ✅ Add Calculated Column Type step to wizard |
| AT-2209 | Enhancement | ✅ Extend Quick Search to Pivot Layouts |
| AT-2187 | Enhancement | ✅ Custom Predicates with same ID should override System ones |
| AT-1535 | Task | ✅ ADDED_ROW & REMOVED_ROW Observable Expression Functions |