Version 13 Release Note

Key Changes

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

AG Grid Peer Dependencies

• AG Grid v.28 (supported by AdapTable v.13) no longer supports the All Modules Bundles:

  • @ag-grid-community/all-modules
  • @ag-grid-enterprise/all-modules

• Consequently, the new AG Grid peer dependency is @ag-grid-community/core (replacing the no longer existing @ag-grid-community/all-modules)

• As of version 13, AdapTable fully supports the AG Grid Modules model and allows our users to integrate only the functionality they need, resulting in a smaller package size

• The associated costs are an additional minimum configuration, which is explained in more detail for each AdapTable variant: Vanilla, Angular and React

• Basically, each user should provide their own custom-tailored list of AG Grid modules to the AG Grid and AdapTable runtime

AdapTable Vanilla

• The only required peer dependency is @ag-grid-community/core
• The AG Grid modules have to be provided to the aysnchronous init AdapTable initialisation function
• AdapTable will take care of registering the provided modules

// Import the modules required
import { Module } from 'ag-grid-enterprise';
import { ClientSideRowModelModule } from '@ag-grid-community/client-side-row-model';
import { SideBarModule } from '@ag-grid-enterprise/side-bar';
import { ColumnsToolPanelModule } from '@ag-grid-enterprise/column-tool-panel';
import { FiltersToolPanelModule } from '@ag-grid-enterprise/filter-tool-panel';
import { StatusBarModule } from '@ag-grid-enterprise/status-bar';
import { MenuModule } from '@ag-grid-enterprise/menu';
import { Adaptable, AdaptableOptions, AdaptableApi } from '@adaptabletools/adaptable';

// Provide the Modules in an Array
const agGridModules: Module[] = [
  ClientSideRowModelModule,
  SideBarModule,
  ColumnsToolPanelModule,
  FiltersToolPanelModule,
  StatusBarModule,
  MenuModule 
  // and others, see list of recommended modules
];

const adaptableOptions: AdaptableOptions = {
  // NO modules property
};

// Add the Modules as a second argument to the init function
const adaptableApi: AdaptableApi = await Adaptable.init(adaptableOptions, { agGridModules });

AdapTable Angular

• AdapTable Angular has the following peer dependencies:

  • @ag-grid-community/core (instead of @ag-grid-community/all-modules)
  • @ag-grid-community/angular (unchanged)
  • @angular/common (unchanged)
  • @angular/core (unchanged)

• The AG Grid modules have to be provided using the standard AG Grid mechanisms

• Consequently, the user is responsible for the registration of the provided modules (just like in any other regular AG Grid instance), in one of 2 ways:

  • registering them globally in the ModuleRegistry
  • registering them to each individual grid

import { Module } from 'ag-grid-enterprise';
import { ClientSideRowModelModule } from '@ag-grid-community/client-side-row-model';
import { SideBarModule } from '@ag-grid-enterprise/side-bar';
import { ColumnsToolPanelModule } from '@ag-grid-enterprise/column-tool-panel';
import { FiltersToolPanelModule } from '@ag-grid-enterprise/filter-tool-panel';
import { StatusBarModule } from '@ag-grid-enterprise/status-bar';
import { MenuModule } from '@ag-grid-enterprise/menu';

@Component({
  selector: 'app-adaptable-root',
  template: `
    <ag-grid-angular
      [adaptableOptions]="adaptableOptions"
      [gridOptions]="gridOptions"
      [modules]="agGridModules"
    >
    </ag-grid-angular>
  `})
export class AppComponent {
  public agGridModules: Module[] = [
    ClientSideRowModelModule,
    SideBarModule,
    ColumnsToolPanelModule,
    FiltersToolPanelModule,
    StatusBarModule,
    MenuModule
    // and others, see list of recommended modules
  ];
  public adaptableOptions: AdaptableOptions = {
    // NO modules property
  }
  // ...
}

AdapTable React

• AdapTable React has the following peer dependencies:

  • @ag-grid-community/core (instead of @ag-grid-community/all-modules)
  • @ag-grid-community/react (unchanged)
  • react (unchanged)
  • react-dom (unchanged)

• The AG Grid modules have to be provided using the standard AG Grid mechanisms

• Consequently, the user is responsible for the registration of the provided modules (just like in any other regular AG Grid instance), in one of 2 ways:

  • registering them globally in the ModuleRegistry
  • registering them to each individual grid

import { Module } from 'ag-grid-enterprise';
import { ClientSideRowModelModule } from '@ag-grid-community/client-side-row-model';
import { SideBarModule } from '@ag-grid-enterprise/side-bar';
import { ColumnsToolPanelModule } from '@ag-grid-enterprise/column-tool-panel';
import { FiltersToolPanelModule } from '@ag-grid-enterprise/filter-tool-panel';
import { StatusBarModule } from '@ag-grid-enterprise/status-bar';
import { MenuModule } from '@ag-grid-enterprise/menu';
import { AgGridReact } from '@ag-grid-community/react';
import AdaptableReact from '@adaptabletools/adaptable-react-aggrid';

const agGridModules: Module[] = [
  ClientSideRowModelModule,
  SideBarModule,
  ColumnsToolPanelModule,
  FiltersToolPanelModule,
  StatusBarModule,
  MenuModule
  // and others, see list of recommended modules
];

const adaptableOptions: AdaptableOptions = {
  // NO modules property
};

const App = () => {
  return (
    <div>
      <AdaptableReact gridOptions={gridOptions} adaptableOptions={adaptableOptions}/>
      <div>
        <AgGridReact 
          gridOptions={gridOptions} 
          modules={agGridModules} 
        />
      </div>
    </div>
)
}

React 18 support

• React 18 is now fully supported by AdapTable:
  • React 17 Users need to do nothing new
  • React 18 Users should provide an implementation for the renderReactRoot prop

Format Column Conditions

• Conditions - both Predicates and Expressions - have been extended to Format Columns
• AdapTable will automatically merge all Conditional Styles into Format Columns

Styled Columns

• A new Styled Columns section in Adaptable State has been created
• This contains the Gradient and PercentBar styles previously in Format Columns
• AdapTable will automatically upgrade any Format Columns that contain these objects to the new Config

AdapTable QL

• Provided VAR Expression Functions are listed individually in the Expression Editor's Functions dropdown
• Changes to how to add Custom Expression Functions and hide System Expression Functions

Finsemble Plugin

• A new Finsemble Plugin designed for using AdapTable in the Finsemble Smart Desktop
• Contains 3 additional sets of functionality for Finsemble Users:
  • FDC3 can be used to communicate between multiple AdapTable instances and other widgets
  • AdapTable Alerts can be appear as actionable Finsemble Notifications
  • Adaptable State can be persisted in Finsemble's State

AdapTable No Code

• 2 new sections have been added to the Wizard in the AdapTable No Code Plugin:
  • UI Elements - allows users to choose with toolbars, status bars and other elements are visible
  • Entitlements - enables users to set Entitlements for the AdapTable instance

Coding Reference

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

Modules

• The ConditionalStyle Module is deprecated - Conditions should be provided via Column Formatting
• A new StyledColumn Module has been created

Initial Adaptable State

• The ConditionalStyle Section is deprecated - Conditions should be provided via the Rule property in Format Column Config
• A new Styled Column Config section has been added

Adaptable Options

• New properties in Expression Options for managing System and Custom Expression Functions

Adaptable API

• The ConditionalStyleAPI Class is deprecated - use methods in Format Column API
• A new Styled Column API section has been added

Change Logs

Version 13.1 Change Log

Version 13.0 Change Log