Version 11 Release Note

Key Changes

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

React UI

• Version 11 of AdapTable React provides full suppport for the new AG Grid React UI

  Note

  This is now the default behaviour when using AdapTable React so there is nothing you need to do

Adaptable Instantiation

• The instantiation of AdapTable 'Core' (but not AdapTable React or AdapTable Angular) has changed:
  • the vendorGrid property has been renamed gridOptions (and receives an AG Grid GridOptions object)
  • there is a new modules property which should receive any AG Grid Enterprise Modules that you require

const adaptableOptions: AdaptableOptions = {
  licenseKey: '<ADAPTABLE_LICENSE_KEY_HERE>',
  primaryKey: 'model',
  adaptableId: 'Basic Setup',
  initialState: initialState,
  gridOptions: gridOptions, // this is the AG Grid Grid Options
  modules: [...AllEnterpriseModules], // any AG Grid Modules required
};

Scalar Aggregations

• Adaptable Rx has extended the range of Aggregation Expressions

• The previous AdaptableAggregationQuery has been replaced by 2 types each of which run aggregations over a whole column or a set of column data:

  • Aggregation Boolean Expressions which return true / false and used in Alerts and Calculated Columns
  • Aggregation Scalar Expressions which return any value; initially only used in Calculated Columns but will be extended to other Modules if use cases demand it

  Breaking Change

  The AdaptableAggregationQuery that used an AggregationExpression no longer exists in place of:

  • an AdaptableAggregatedBooleanQuery which uses AggregatedBooleanExpression
  • an AdaptableAggregatedScalarQuery which uses AggregatedScalarExpression

Flashing Cells

• Flashing Cells are now a separate Module (they were previously part of Alerts)

• Flashing Cell Options have been moved from Notification Options into a new Flashing Cell Options class

• Flashing has been extended to Aggregated Cells (in Grouped Rows)

• They have their own section in Initial Adaptable State (and no longer in Alert Initial State)

  Breaking Change

  This is a breaking change. However the Flashing Cell Definition is not changed and existing Flashing Cell definitions will be automatically upgraded by AdapTable on application start up

Alerts

• Alerts are no longer responsible for Flashing Cells - which is now a separate Module

• Highlight Row Action added and both it and Highlight Cell can use a CSS Class Name

• An optional AlertMessage can be added to the Alert Definition (in place of creating one dynamically)

• The Application Icon will display in the Alert (if one has been provided in User Interface Options)

• 2 new Row-related Predicates have been added for Alerts (in Version 11.1)

  Breaking Change

  Aggregation Expressions previously used in Alerts have been redefined as Aggregation Boolean Expressions (in order to differentiate from the new ScalarAggregationExpressions)

Calculated Columns

• Have been extended to support Scalar Aggregation Expressions for more advanced use cases

Charts

• The Charting Plugin - which was using Infragistics Charting has been removed
• Sparkline Columns are still available and supported - but require AG Grid charting to be enabled

Settings Panel

• There is now a single Settings Panel which contains all the previous standalone popups

• It is fully resizable and configurable

• No code changes are required to activate this

• The alwaysShowInDashboard and alwaysShowInToolPanel properties in Settings Panel Options ensure that the Module Button to open the Settings Panel is always visible in the Dashboard and ToolPanel respectively

  Deep Dive

  Where is the Home Button and what has happened to my Module Buttons?

  Learn More

  Previous versions of AdapTable had a Home Button on the left hand side which opened a Dropdown listing all the available Modules.

  Each entry in the dropdown would open a different popup.

  With the new Settings Panel that has become redundant; instead a single Settings Panel button opens the a screen that contains all configuration options.

  By default, for new instances of AdapTable that will be the only Module button displayed in the Dashboard.

  However if you have existing Initial Adaptable State which saves Module Buttons they will continue to display.

  This means that you might need to add the Settings Panel button yourself if you want quick access to all features in AdapTable.

Dashboard

• 2 changes have been made to the Default Properties used in Dashboard State:

  • SettingsPanel is now the only default item in the ModuleButtons property

  • Tabs now contains an empty array by default (in place of the set that AdapTable used to provide)

    Caution

    This means that AdapTable no longer provides a default Tab called Toolbars if not Tabs are supplied in Initial Adaptable State

General UI Improvements

• Multiple Columns can be selected (via Column Menu)
• The tabs displayed in Grid Info section of Settings Panel can be configured in User Interface Options
• A new State Management Toolbar and ToolPanel have been added
• The Export Selected Cells Context Menu item now includes a list of available Export Destinations
• Columns can be given a different Caption / Header (per Layout)
• customSortComparers in Custom Sort Options now use Scope (instead of columnId)

  Breaking Change

  This is a breaking change

Coding Reference

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

Initial Adaptable State

• New FlashingCell section introduced to Initial Adaptable State - contains a collection of FlashingCellDefinitions (previously part of Alert Initial State)
• Calculated Columns and FreeText Columns include a SpecialColumnSettings property enabling them to be configured with more properties (e.g. width, sortable etc)
• DataType Scope in Shortcuts is limited to Numeric DataType only

Adaptable Options

• The vendorGrid property has been renamed to gridOptions (and takes an AG Grid GridOptions object)

• There is a new modules property which should receive any AG Grid Enterprise Modules that you require

  Note

  This only affects instantiation of AdapTable 'vanilla' version - AdapTable React and AdapTable Angular are unaffected

• The vendorContainer property in Container Options was renamed to agGridContainer

• 3 new Adaptable Options Classes has been added

  • Alert Options - includes the Alert-specific properties previously in Notification Options
  • Flashing Cell Options - contains the Flashing Cell related properties previously in Notification Options
  • Settings Panel Options - contains options for configuring the new Settings Panel
  • in Expression Options - used for managing AdapTableQL (includes an ExpressionOptions section)

• Custom Sort Comparers now use the Scope object (instead of a single columnId)

Adaptable API

• 2 new Adaptable API Classes have been added:

  • Settings Panel API
  • Flashing Cells API

• The addGridData updateGridData and deleteGridData methods in Grid API are now asynchronous and return an array of affected AG Grid Row Nodes

• A new setCellValues method in Grid API enables multiple AG Grid cells to be updated in one go

Plugins

• Charting Plugin has been removed completely

Modules

• There are 3 new Modules introduced in Version 11
  • Settings Panel
  • Flashing Cell
  • Charting - currently contains no functionality but will offer Charting Extensions in future releases

Events

• The vendorGrid property returned by the AdaptableReadyInfo args in the Adaptable Ready Event has been renamed gridOptions

AdaptableRx

• Adaptable Rx has a new Expression type: Aggregation Scalar Expressions

• It aggregates a group of cells and returns a single value and is used initially in Calculated Columns

• The previous AggregateExpression has been replaced with an Aggregation Boolean Expression

  Breaking Change

  The AggregateExpression used in Alerts is replaced with an Aggregation Boolean Expression

Change Logs

Version 11.3 Changelog

Version 11.2 Changelog

Version 11.1 Changelog

Version 11.0 Changelog