AdapTable Modules Overview

Most of the functionality in AdapTable is organised through 'Modules'.

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

note

Many Modules contain an array of AdaptableObjects that users can create, edit or delete (if their Entitlements allow), e.g. ConditionalStyle, Layouts etc.

tip

Use Entitlements to set Modules you don't need to 'Hidden' or don't want users to touch to 'ReadOnly'

AdapTable Modules

ModuleDescription
AlertGet notified when things happen in Adaptable that you need to know about
Bulk UpdateUpdate multiple cell simultaneously with a new or existing value
Calculated ColumnCreate bespoke columns whose cell value is derived dynamically from an Expression
Cell SummarySee summary information on a group of cells using multiple summary operations
Conditional StyleStyle columns and rows dynamically based on rules and cell values
Custom SortProvide bespoke sorting information for Columns (in place of alphabetical sorting)
Data SourceUpdate the entire data set in AdapTable using pre-populated data sources
ExportExport data from the Grid to numerous locations in numerous formats
FilterAdvanced filtering capability allows users to see precisely the data they want
Format ColumnCreate a column style, display format or cell alignment
FreeText ColumnDynamic column showing custom content (stored in state and not with grid data)
Grid InfoDisplay information about the Grid, the Options selected and all columns
LayoutNamed sets of column visibility, order, groupings, aggregation, pivots etc.
Plus MinusConfigure how a cell value will edit when the + or - keys are pressed
QueryRun real-time text-based queries using a wealth of powerful functions and operators
Quick SearchQuickly highlight all cells in the grid that contain matching query text
ReminderConfigure reminders (alerts) to popup with a a message at scheduled times
ScheduleSchedule AdapTable functionality to run at times of your choosing (e.g. run reports)
ShortcutSet up rules so cells update mathematically when keys are pressed in numeric cells
Smart EditEdit groups of numeric cells using mathematical operations (e.g. Multiply by 10)
State ManagementManages Adaptable State, User State and Predefined Config
System StatusProvide messages about the Status of your application
ThemeTheme AdapTable with a colour configuration set of your choosing

Modules UI

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

  • Most Modules have a dedicated Popup Screen. Modules that contain an array of items (e.g. ConditionalStyle) will typically display these in a table with buttons to add / edit. These items are created / edited via a Wizard which provides step-by-step way to edit the sometimes complex objects that can be created.

    Modules which perform actions (e.g SmartEdit, BulkUpdate) will contain UI controls to allow the Module to be used.

  • Some Modules - e.g. Layouts, Reports, Quick Search - provide Dashboard Toolbars which offer easy access to required functionality.

  • AdapTable Modules can also provide ToolPanels to be hosted in the AdapTable ToolPanel (at the side of the grid). Like toolbars, these provide ready access to common functionality (the same Modules generally provide both).

  • Many Modules also provide Menu Entries for both the Column Menu (available through clicking a Column Header) and Context Menu (available through right-clicking on a grid cell, or group of cells).

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

AdapTable Modules UI Components

Adaptable ModuleWizardToolbarTool PanelColumn MenuContext Menu
AlertYesYesYesNoYes
Bulk UpdateNoYesYesNoYes
Calculated ColumnYesNoNoYesNo
Cell SummaryNoYesYesNoYes
Conditional StyleYesNoNoYesNo
Custom SortYesNoNoYesNo
Data SourceYesYesYesNoNo
ExportYesYesYesNoNo
FilterNoYesYesYesYes
Format ColumnYesNoNoYesNo
FreeText ColumnYesNoNoYesNo
Grid InfoNoNoNoYesYes
LayoutYesYesYesNoNo
Plus MinusYesNoNoYesNo
QueryYesYesYesNoNo
Quick SearchNoYesYesNoNo
ReminderNoNoNoNoNo
ScheduleYesNoNoNoNo
ShortcutYesNoNoNoNo
Smart EditNoYesYesNoYes
System StatusNoYesYesYesYes
ThemeNoYesYesNoNo

Plugin-based Modules

ModuleWizardToolbarTool PanelColumn MenuContext Menu
ChartNoYesNoNoNo
ipushpullNoYesNoNoNo
Glue42NoYesNoNoNo
OpenFinNoYesNoNoNo
FinsembleNoNoNoNoNo

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.

Predefined Config / State

Design-time Users are able to pre-populate AdapTable with Predefined Config - this is the AdapTable State that will be available when the application first loads.

Nearly every Module has its own section / property in PredefinedConfig which will be the same as the ModuleName (e.g. 'CustomSort').

note

There are many sections in Predefined Config most which are Module-related.

Module Name

Each AdapTable Module has a ModuleName property.

note

This allows you to easily reference Adaptable Modules when creating Predefined Config as they will appear in a dropdown as you type.

An Adaptable Module also a FriendlyName property which is how the Module is referred to in AdapTable menus and toolbars.

tip

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

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 the Entitlements section of Predefined Config 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 continue to add more Modules all the time, 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 General Options which allows you provide an alternative name for a Module and will used whenever the Module name is displayed.