AdapTable Modules

Summary

Much of the functionality in AdapTable is organised through 'Modules'
Many Modules contain an array of Adaptable Objects that users can create, edit, delete or suspend, e.g. FormatColumn, Layout etc.
Modules which are not required can be set to Hidden in Entitlements (or ReadOnly if users shouldn't edit them)

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.

Find Out More

See Module Entitlements for a detailed look at how the ReadOnly Entitlement is configured for each Module

Changing Module Name

Each AdapTable Module has a ModuleName property.

Note

This allows you to easily reference Adaptable Modules when creating Initial Adaptable State
The Module Name will appear in a dropdown as you type

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).

Hint

The Friendly Name can be changed via the alternativeModuleNames property in User Interface Options

alternativeModuleNames

AlternativeModuleName[]

Alternative names to use for Adaptable Modules in toolbars and menus

AlternativeModuleName[]

If, for some reason, the default FriendlyName for a Module is not appropriate, then use this property to set what AdapTable should use instead.

The AlternativeModuleName object contains just 2 properties:

Property	Description
adaptableModule	Adaptable Module to rename
newName	New name to use

and is used like this:

// 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

Note

Most Modules have a section in Initial Adaptable State which is the same as the ModuleName (e.g. CustomSort)
Similarly the AdapTableOptions property is typically ModuleName followed by "Options" (e.g. CustomSortOptions)

Available Modules

This is the full list of AdapTable Modules indicating which provide Initial Adaptable State or Adaptable Options:

Module	Initial State	Options	Description
Alerts	✅	✅	Notifies Users when important things happen in Adaptable
Bulk Update	❌	❌	Update multiple cell simultaneously
Calculated Column	✅	❌	Bespoke Column where value derived from Expressions
Cell Summary	❌	✅	Summary information on a group of cells
Charts	✅	✅	AdapTable users can save and reload AG Grid charts
Column Filters	ℹ️	✅	Enable users to filter AG Grid to see precise data required
Column Info	❌	❌	Display detailed information about each Grid Column
Comments	❌	✅	Users can create and share comments on AdapTable cells
Custom Sort	✅	✅	Provide bespoke sorting information for Columns
Dashboard	✅	✅	Area above Grid providing AdapTable functionality
Data Change History	❌	✅	Shows list of recent Data changes with option to undo
Data Import	❌	✅	Allows run-time users to import data into AG Grid
Data Set	✅	✅	Replace AG Grid data source with pre-populated data sets
Export	✅	✅	Export data as reports from AG Grid to numerous locations
FDC3	❌	✅	Provides support for FDC3
Flashing Cells	✅	✅	Cells will automatically flash when a rule is met
Format Column	✅	✅	Format Column with style or a display format
FreeText Column	✅	❌	Dynamic column showing custom content provided by user
Grid Filter	ℹ️	✅	Applies a full Grid filter
Grid Info	❌	❌	Display detailed information about AG Grid and AdapTable
Layout	✅	✅	Organise columns into named sets with multiple properties
Named Query	✅	❌	Reusable Queries for use in AdapTableQL
Notes	✅	✅	Enables users to create private Notes
Plus Minus	✅	❌	Configure how cell value edits when + or - keys are pressed
Quick Search	✅	✅	Quickly highlight all cells in grid containing matching text
Schedule	✅	❌	Schedule AdapTable functionality to run at bespoke times
Settings Panel	❌	✅	Where all Adaptable objects are managed
Shortcuts	✅	❌	Rules how numeric cells update in response to keyboard press
Smart Edit	❌	❌	Edits numeric cells using mathematical operations
State Management	❌	✅	Manages Adaptable State, User State & Initial Adaptable State
Status Bar	✅	❌	Configures the Adaptable Status Bar
Styled Column	✅	❌	Create a Gradient, Percent Bar, Badge or Sparkline style
System Status	❌	❌	Provide messages about the Status of your application
Team Sharing	❌	✅	Enables AdapTable users to share objects with colleagues
Theme	✅	❌	Theme AdapTable with a bespoke colour configuration set
Tool Panel	✅	✅	Runs the Adaptable Tool Panel Component

Note

Items marked with ℹ️ are properties in Layout State, rather than sections of Initial State in their own right

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

This table lists all the Modules and which UI elements they support.

Note

For Status Bar we tick Modules which provide a dedicated Status Bar that contains discrete functionality

Adaptable Module	Settings Panel	Wizard	Toolbar	Tool Panel	Status Panel	Column Menu	Context Menu
Alerts	✅	✅	✅	✅	✅		✅
Bulk Update			✅	✅			✅
Calculated Column	✅	✅				✅
Cell Summary			✅	✅	✅	✅	✅
Charts		✅	✅	✅	✅
Column Filters	✅		✅	✅	✅	✅	✅
Column Info	✅					✅	✅
Comments	✅						✅
Custom Sort	✅	✅				✅
Dashboard	✅	✅		✅		✅	✅
Data Change History	✅		✅	✅
Data Import	✅	✅				✅	✅
Data Set	✅	✅	✅	✅	✅
Export	✅	✅	✅	✅	✅
FDC3							✅
Flashing Cells	✅	✅				✅	✅
Format Column	✅	✅				✅
FreeText Column	✅	✅				✅
Grid Filter	✅		✅	✅	✅
Grid Info	✅					✅	✅
Layout	✅	✅	✅	✅	✅
Plus Minus	✅	✅				✅
Notes	✅						✅
Named Queries	✅	✅	✅	✅	✅
Quick Search	✅		✅	✅	✅
Schedule	✅	✅
Settings Panel	✅					✅	✅
Shortcuts	✅	✅
Smart Edit			✅	✅			✅
State Management	✅		✅	✅
Status Bar	✅
Styled Column	✅	✅				✅
System Status	✅		✅	✅		✅	✅
Team Sharing	✅
Theme	✅		✅	✅	✅
Tool Panel	✅

Plugin-based Modules

Module	Toolbar	Tool Panel
ipushpull	✅	✅
interop.io
OpenFin	✅	✅

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:

Module	Predicates	Expressions
Alerts	✅	✅
Badge Styled Columns	✅	❌
Calculated Column	❌	✅
Column Filters	✅	❌
Grid Filters	❌	✅
Conditional Styles	✅	✅
Export	❌	✅
Flashing Cells	✅	✅
Named Queries	❌	✅
Plus Minus	❌	✅

FAQ

Can we hide particular Modules from our users as they are not relevant (i.e. we are a readonly grid so don't require Smart Edit or Shortcuts Modules)? Yes, you can use Entitlements to set which Modules are available to each user, and whether they are hidden, editable or readonly.

Do you plan to add more Modules? Yes, we continually add more Modules, primarily in response to suggestions and ideas submitted by our Users.

Can I change the Name of the Dashboard Module as we already have a Dashboard section in our application? Yes, use the the alternativeModuleNames property in User Interface Options which allows you provide an alternative name for a Module and will used whenever the Module name is displayed.

PreviousPlugins

Framework: