Version 12 Release Note

Summary

  • The document describes the key changes in Version 12 of AdapTable
  • It was released in June 2022 and supports AG Grid version 27.3
  • Key features of the Release include:
    • AdapTable content is now available in AG Grid's Status Bar
    • Layouts have been extended to so they can expressly include other objects (e.g. Format Columns)
    • Comprehensive FDC3 support via new FDC3 Columns which can broadcast FDC3 messages and raise intents
    • DataSets (which replace Data Sources) allow for big data to be provided to AdapTable (including via dynamic forms and parameterised queries) while still using the Client-Side Row Model
    • Special (i.e. Calculated, FreeText) Columns can be defined in AG Grid
    • Smart Edit can be provided with bespoke, custom operations

Breaking Change

There are a few, small, breaking changes in Version 12:

Find Out More

Watch this video explaining some of the new features in Version 12

Key Changes

These are the key changes in AdapTable Version 12 - listed by topic.

Status Bar

  • AdapTable content can now be displayed in the AG Grid Status Bar
  • This provides quick access to key functionality and is an alternative to Dashboard and Tool Panel
  • Users can configure unlimited AdapTable Status Panels
  • Each can be provided, and placed in 3 locations on the Status Bar: left, right and centre
  • An AdapTable Status Panel can include multiple Module Status Panels
  • AdapTable provides one Status Panel per Module - some contain rich functionality like dropdowns and selectors (e.g. Layout, Export, Theme), others consist of a link to the Module' page in the Settings Panel

Find Out More

The UI Components Guide to the Status Bar provides full details of all the options available

FDC3 Columns

  • AdapTable provides 5 FDC3 column types that can be set up as required
  • Additionally developers can provide custom FDC3 columns
  • Each FDC3 Column can be configured to:
    • Broadcast FDC3 Messages
    • Raise FDC3 Intents

Find Out More

Consult the Using FDC3 section of Handbook for the full list of FDC3 Columns and Intents

Layout Object Scope

  • Layouts have been extended so that they can be 'scoped' to include particular objects
  • This allows developers to restrict objects like Format Columns to particular Layouts
  • This can be automated by AdapTable and will honoured when the Layout is Shared
  • Additionally, Column Filters now operate at a per-Layout (rather than global) level

Find Out More

See Extending Layouts for more information on how to leverage Object Tags in this way

Data Sets

  • Data Sources (previously available in DataSource config) have been replaced with DataSets
  • These are now provided in Data Set Options
  • Data Sets are similar to DataSources they replaced, but can also contain form definitions
  • This allows end users to build data sets using dynamic forms with parameterised queries

Find Out More

The DataSet section of the Handbook has full details

Custom Smart Edit Operations

  • Smart Edit ships with 4 mathematical operations - Add, Subtract, Multiply and Divide
  • These can now be extended with custom operations (e.g. Power)
  • This allows users to perform bespoke editing operations

Find Out More

See the Smart Edit section of the AdapTable Editing Guide for further details

AG Grid Definitions for Special Columns

  • Previously Special (e.g Calculated, FreeText and Action) Columns could only be defined via AdapTable
  • AdapTable then would create an AG Grid column to match the definition
  • This meant that you could not add AG Grid elements to the Column or put it in a Column Group
  • Now special columns can be pre-defined in AG Grid allowing them to have same richness as other columns

Find Out More

This topic is discussed at greater length in the Setting Types for Special Columns in AG Grid tutorial

ToolPanel Setup

  • The setup of the AdapTable ToolPanel Component has been simplified
  • The requirement to reference Component in components section of GridOptions has been removed
  • Bespoke ToolPanel properties (e.g. minWidth and ordering of the different Panels) can still be provided
  • But this is done by providing a bespoke ToolPanel configuration directly in sideBar property of GridOptions

Find Out More

Full details are provided in the Guide to setting up the Tool Panel

Saving AG Grid Charts

Find Out More

General UI Improvements

  • Action Columns can contain multiple buttons

  • Custom sections can be displayed in the Settings Panel

  • Prefix and Suffix have been added to Display Formats available for string columns

  • An Adaptable Button can now inculde Icons - including custom-provided ones

  • Custom Display Formatters can now be provided for Format Columns

  • The Data Change History grid can take any kind of button

    Breaking Change

    The Undo button that was previously displayed in the form by default has been removed

AdapTable React

  • No longer required to reference the AdaptableToolPanelComponent in components section of GridOptions

AdapTable Angular

  • No longer required to reference the AdaptableToolPanelComponent in components section of GridOptions
  • AdapTable now requires a minimum of version 12 of Angular

Coding Reference

These are the main code and class changes in AdapTable 12 you need to be aware of:

Initial Adaptable State

  • The DataSource section has been removed
  • The Filter section has been removed (but Layouts now have a new ColumnFilters property)
  • A new Status Bar section has been added
  • A new Charting section has been added

Adaptable Options

Adaptable API

  • The DataSourceAPI class in Adaptable API has been replaced with DataSet API
  • A new Charting API class to aid in the persistence and loading of AG Grid charts
  • Some methods (e.g. getFilterState) have been removed from Filter API to reflect that Column Filters are now stored with a Layout

Modules

  • The Charting Module has been added
  • The DataSource Module has been removed

Events

2 new Adaptable Events have been added:

EventWhen Fired
Data Set SelectedA new DataSet has been selected by the User
FDC3 Message SentFDC3 message was sent - can be Broadcast Message or an Intent raised

Release History

AdapTable VersionRelease DateAG Grid Compatibility
12.229 August 202227.3.0
12.125 July 202227.3.0
12.020 June 202227.3.0

Version 12.2 Change Log

Version 12.2 was released on 29 August 2022.

Important

There is a small bug with Aggregations in AdapTable React in v.12.2.0 so we advise you to install 12.2.1 or later

The main new features in this version include:

Weighted Averages Guide

(Recorded with AdapTable v12.2)
  • The IN (Values) Predicate has been extended to Alerts

  • Column Filters can now be suspended (and can be cleared from Filter Toolbar)

  • New unbalancedgroupskey property enabling grouping of unbalanced Row Groups

Unbalanced Group Guide

(Recorded with AdapTable v12.2)
  • Usability improvements to the Expression Editor:

    • Additional context-sensitive help when building Expressions
    • Column Friendly Names (i.e. Headers) are used wherever the Expression is referenced in AdapTable
    • A Column Search box has been added to make it easy to find Columns to drag into Expression builder
  • Multiple enhancements to AdapTableQL functionality including

VAR AdapTableQL Expression

(Recorded with AdapTable v12.2)

Full List of Changes

KeyTypeDescription
AT-1844Enhancement✅ Enable "unbalanced groups" to be grouped using custom name
AT-1843Bug✅ Sorting fails in Pivot Layout with No Pivot Columns (Agg Cols only)
AT-1842Enhancement✅ Make server-side evaluation of AdaptableQL more flexible
AT-1840Enhancement✅ Add Weighted Average cell summary - using the Layout AggFunc
AT-1837Bug✅ Expression validation incorrectly fails when test data incomplete
AT-1833Enhancement✅ Remove Custom Reports from Export State
AT-1829Enhancement✅ Add the Type of Style to Format Column Summary wizard step
AT-1823Bug✅ Grid re-renders continuously when switching to a Pivot Layout
AT-1812Enhancement✅ Add Weighted Average scalar aggregation
AT-1809Bug✅ Adaptable crashes when closed during a pending async load operation
AT-1806Enhancement✅ Add Weighted Average Columns sections to a Layout
AT-1802Bug✅ 'On' Date Predicate doesnt evaluate to true for edited cells
AT-1799Enhancement✅ Add 'IsNotNumeric' Predicate
AT-1798Bug✅ Exclude Values Predicate doesn't work with more than one date
AT-1796Bug✅ Cell value of 0 doesn't work with Values & Exclude Values Predicates
AT-1795Bug✅ Clearing a number cell in AdapTable is treated as Zero in Predicates
AT-1790Bug✅ CalculatedColumn with an aggregated scalar value which depends on another CalculatedColumn is not always kept in sync
AT-1787Enhancement✅ Add Values (IN) Predicate to Conditional Style & Alert
AT-1785Enhancement✅ Re-order the steps in Calculated Column Wizard
AT-1784Enhancement✅ Ensure consistent use of AggFuncInHeader
AT-1783Enhancement✅ Update Grid when current Layout is updated via API
AT-1782Enhancement✅ Add Clear and Suspend buttons to Filter Toolbar, ToolPanel
AT-1781Enhancement✅ Make Column Filters suspendable
AT-1767Enhancement✅ Add support for multiple grouping in AggregatedScalar Expressions
AT-1763Enhancement✅ Add GROUP_BY to CUMUL expressions
AT-1750Enhancement✅ Add Cumulative Expression as a special type of Expression in UI
AT-1667Enhancement✅ Display Column Friendly Names in the Expression Editor
AT-1648Enhancement✅ Add a Column Search box in Expression Editor
AT-1546Enhancement✅ Add Alerts for Aggregated MIN & MAX
AT-1478Enhancement✅ Add support for cumulated aggregations to Average(AVG) and Percentage operators
AT-1327Enhancement✅ Create `VAR` AdapTableQL Expression Function which can read global variables (e.g. `userName`)
AT-1080Enhancement✅ Aggregation Expressions to react to changes in WHERE clause columns

Version 12.1 Change Log

KeyTypeDescription
AT-1774Task✅ Update to latest version of react-toastify
AT-1766Bug✅ Layout suppressAggFuncInHeader is not working
AT-1765Bug✅ Error thrown when filtering for date in Filter Form searchbox
AT-1761Bug✅ Expand All and Collapse All events are ignored for Dynamic Row Groups
AT-1757Bug✅ Layout editor fails to display custom FriendlyNames
AT-1756Bug✅ CalculatedColumns with AggregatedScalar Expressions are not evaluated if provided in non-standard ways
AT-1753Bug✅ ExpandedRowGroups in Layouts don't re-open
AT-1745Bug✅ Expression Editor crashes when no data present in the grid
AT-1744Study✅ Make Quick Search as Query not use actual queries
AT-1740Enhancement✅ Add a Save button to Layout Status Bar control if autoSaveLayouts is false
AT-1739Study✅ Running Quick Search as Query is slow
AT-1738Bug✅ Running Quick Search as Query includes hidden columns
AT-1735Enhancement✅ Add Context to handler function in CustomDisplayFormatter
AT-1728Bug✅ Change Caption in Column Menu sometimes throws an error
AT-1726Bug✅ Values Filter is not updated when grid data changes
AT-1724Bug✅ Some Adaptable menu items do not include the Module
AT-1723Bug✅ Column Filters do not autorun if AutoSave Layout is set to False
AT-1722Enhancement✅ Save AG Grid Chart definitions in AdapTable State
AT-1717Enhancement✅ Add support for HTMLElements in AdaptableIcon
AT-1716Bug✅ DashboardButtons with custom internal icons are handled incorrectly
AT-1712Study✅ Replace Layout Editor with multi-step Wizard
AT-1711Enhancement✅ Add Column Filters info to Layout Summary in Settings Panel
AT-1707Enhancement✅ Handle special columns header tooltip consistently
AT-1705Bug✅ Inline Dashboard shows tabs dropdown when just 1 Tab provided
AT-1701Enhancement✅ Include Tagged Objects when Reference Sharing Layouts in Team Sharing
AT-1691Bug✅ Column Filter staying when quick filter bar text is cleared
AT-1690Bug✅ Date Filter working on wrong day
AT-1685Enhancement✅ Add support for dynamic icons
AT-1683Enhancement✅ Refresh custom dashboard buttons on button actions
AT-1681Enhancement✅ Add dynamic icon function to AdaptableButton
AT-1668Task✅ Add percentile / quartile / quintile etc. Aggregations to AdapTableQL
AT-1562Enhancement✅ Upgrade to stable version of react-daypicker
AT-1506Task✅ Update to Angular v12 & TypeScript v4.3.5
AT-1477Enhancement✅ Allow referencing other Calculated Columns in AggregatedScalar Expression
AT-325Enhancement✅ Log warning if AdaptableBlotterOptions contains unknown property

Version 12.0 Change Log

KeyTypeDescription
AT-1679Bug✅ GridAPI getRowCount() incorrect when row added to grid but not datasource
AT-1671Enhancement✅ Add api method to remove a column from a Layout
AT-1669Enhancement✅ Improve Team Sharing API controls
AT-1666Bug✅ Add an API DeleteConditionalStyle method
AT-1664Study✅ Improve definition and public API for column types
AT-1662Enhancement✅ Give all Popovers consistent look and feel
AT-1661Enhancement✅ Add a function in AdaptableOptions to set Column Friendly Name
AT-1657Enhancement✅ Provide support for AG Grid v27.3.x
AT-1652Enhancement✅ Allow server evaluation for CalculatedColumns
AT-1645Task✅ Allow users to provide Custom FDC3 Columns
AT-1642Task✅ Replace DataSource in Config with improved DataSet (via Options)
AT-1639Enhancement✅ Allow users to provide custom format functions for Format Columns
AT-1605Task✅ Provide popup Form for Action Rows
AT-1604Enhancement✅ Move Column Filters into Layout State
AT-1603Enhancement✅ Remove requirement to reference ToolPanel Component when using Adaptable React or Angular
AT-1590Enhancement✅ Add Prefix and Suffix as options for String columns in Format column
AT-1589Enhancement✅ Enable Adaptable Objects to be scoped to particular Layout(s)
AT-1573Bug✅ Programmatic updates on custom toolbars are not handled correctly
AT-1569Enhancement✅ Provide FDC3 columns to broadcast and raise intents
AT-1545Enhancement✅ Enable special columns (Action, Freetext, Calculated) to be referenced in standard AG Grid column definitions
AT-1396Task✅ Allow devs to provide Custom Sections to display in Settings Panel
AT-1341Task✅ Make AdapTable content available in Status Bar
AT-1323Enhancement✅ Extend Action Columns to display multiple buttons
AT-1277Enhancement✅ Make button in Data Change History more configurable
AT-948Enhancement✅ Provide Action Rows - for Create, Edit (and buttons also for Clone, Delete)
AT-395Enhancement✅ Add column / context menu options to select and summarise a column