AdapTable & AG Grid Modules

AdapTable Modules

An AdapTable Module is essentially a set of discrete functionality e.g. 'CustomSort', 'ColumnFilter', 'SmartEdit' etc. which users will interact with as required.

Entitlements

All Modules are subject to Entitlements (aka permissions).

This means that end-users will only be able to access a Module according to whether it has been given an Entitlement of Full, ReadOnly or Hidden.

Changing Module Name

Each AdapTable Module has a ModuleName property.

An Adaptable Module also has a FriendlyName property - this sets how the Module is referred to in the AdapTable UI (e.g. in the Settings Panel, Menus and Toolbars).

// Rename Dashboard Module to 'Grid Setting'
// Rename System Status to 'Server Updates'
const adaptableOptions: AdaptableOptions = {
  userInterfaceOptions: {
    alternativeModuleNames: [
      {
        adaptableModule: 'Dashboard',
        newName: 'Grid Settings',
      },
      {
        adaptableModule: 'SystemStatus',
        newName: 'Server Updates',
      },
    ],
  },
};

Configuring Modules

Design-time Users are able to configure AdapTable Modules in 2 ways:

• Providing Initial Adaptable State - the AdapTable State that will be available when the application first loads
• Supplying properties in the relevant Adaptable Options class

Available Modules

This is the full list of AdapTable Modules:

Module UI Components

There are numerous ways in which end-Users can interact with AdapTable Modulea in the AdapTable UI:

• Most Modules have a dedicated screen in the Settings Panel
• These often contain Wizards to provide step-by-step ways to create and edit Adaptable Objects
• Many Modules - e.g. Layouts, Export - provide Dashboard Toolbars for easy access to required functionality
• Many Modules also offer Module ToolPanels which are displayed in the AdapTable ToolPanel Component
• Some Modules provide rich Status Bar Panels to display in the Status Bar
• Many Modules also provide Menu Entries for both the Column Menu and Context Menu

Predicates and Expressions

Many Modules include Rules which can be evaluated using either:

• Predicates - used for relatively simply boolean evaluations (e.g. Column Filters)
• Expressions - rich, human-readable, multi-column and multi-operator constructs for advanced scenarios

Some Modules only use Predicates, others just Expressions and some allow both as follows:

AG Grid Modules

See the Guide to using AG Grid Modules to learn how best to set up AG Grid Modules in AdapTable.

This also includes details about which Modules are mandatory and which are ignored.