# AdapTableModules

Canonical page: https://www.adaptabletools.com/docs/technical-reference-adaptable-modules

- Much of the functionality in AdapTable is organised through 'Modules'
- Many Modules contain an array of [Adaptable Objects](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-initial-state/index.md#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](https://www.adaptabletools.com/docs/handbook-permissioning/index.md) (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](https://www.adaptabletools.com/docs/handbook-permissioning/index.md) (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_.

See [Module Entitlements](https://www.adaptabletools.com/docs/handbook-permissioning-modules/index.md) for a detailed look at how the `ReadOnly` Entitlement is configured for each Module

## Changing Module Name

Each AdapTable Module has a `ModuleName` property.

- 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](https://www.adaptabletools.com/docs/ui-settings-panel/index.md), [Menus](https://www.adaptabletools.com/docs/ui-column-menu/index.md) and [Toolbars](https://www.adaptabletools.com/docs/ui-dashboard/index.md#tabs-and-toolbars)).

The Friendly Name can be changed via the `alternativeModuleNames` property in [User Interface Options](https://www.adaptabletools.com/docs/technical-reference-ui/index.md)

### `alternativeModuleNames`

Alternative names to use for Adaptable Modules in toolbars and menus

  [`AlternativeModuleName[]`](https://www.adaptabletools.com/docs/reference/alternativemodulename.md)

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`](https://www.adaptabletools.com/docs/reference/alternativemodulename.md) object contains just 2 properties:

| Property | Type | Description |
| --- | --- | --- |
| [adaptableModule](https://www.adaptabletools.com/docs/reference/alternativemodulename.md#adaptablemodule) | [`AdaptableModule`](https://www.adaptabletools.com/docs/reference/adaptablemodule.md) | Adaptable Module to rename |
| [newName](https://www.adaptabletools.com/docs/reference/alternativemodulename.md#newname) | `string` | New name to use |

and is used like this:

```ts {5}
// 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',
      },
    ],
  },
};
```

### `alternativeModuleIcons`

Alternative icons to use for Adaptable Modules in the UI

  [`AlternativeModuleIcon[]`](https://www.adaptabletools.com/docs/reference/alternativemoduleicon.md)

Replaces the Module Glyph in the [Settings Panel](https://www.adaptabletools.com/docs/ui-settings-panel/index.md), Dashboard / Tool Panel buttons, Status Bar and menus. Same shape as `alternativeModuleNames`: the Module, plus a [Adaptable Icon](https://www.adaptabletools.com/docs/ui-tutorial-creating-icon/index.md).

```ts {4-7}
const adaptableOptions: AdaptableOptions = {
  userInterfaceOptions: {
    alternativeModuleIcons: [
      { adaptableModule: 'Layout', newIcon: { name: 'grid' } },
      { adaptableModule: 'Export', newIcon: { name: 'download' } },
    ],
  },
};
```

## Configuring Modules

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

- Providing [Initial Adaptable State](https://www.adaptabletools.com/docs/technical-reference-initial-state/index.md) - the _AdapTable State_ that will be available when the application first loads
- Supplying properties in the relevant [Adaptable Options](https://www.adaptabletools.com/docs/technical-reference-adaptable-options/index.md) class

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

See the [Features Guide](https://www.adaptabletools.com/docs/getting-started-features-guide/index.md) for details of which are configured through [Initial Adaptable State](https://www.adaptabletools.com/docs/technical-reference-initial-state/index.md) or [Adaptable Options](https://www.adaptabletools.com/docs/technical-reference-adaptable-options/index.md)

| Module                                                                                    | Description                                                                               |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| [Alerts](https://www.adaptabletools.com/docs/handbook-alerting/index.md)                                    | Notify Users when important things happen in the Grid                                     |
| [Bulk Update](https://www.adaptabletools.com/docs/handbook-editing-bulk-update/index.md)                    | Update multiple cells simultaneously                                                      |
| [Calculated Column](https://www.adaptabletools.com/docs/handbook-calculated-column/index.md)                | Bespoke Column where value derived from Expressions                                       |
| [Cell Summary](https://www.adaptabletools.com/docs/handbook-summarising/index.md)                           | Summary information on a group of cells                                                   |
| [Charts](https://www.adaptabletools.com/docs/handbook-charts/index.md)                                      | AdapTable users can save and reload AG Grid charts                                        |
| [Column Filters](https://www.adaptabletools.com/docs/handbook-column-filter/index.md)                       | Enable users to filter AG Grid to see precise data                                        |
| [Column Info](https://www.adaptabletools.com/docs/ui-settings-panel-column-info/index.md)                   | Display detailed information about each Grid Column                                       |
| [Comments](https://www.adaptabletools.com/docs/handbook-comments/index.md)                                  | Users can create and share comments                                                       |
| [Custom Sort](https://www.adaptabletools.com/docs/handbook-custom-sorting/index.md)                         | Provide bespoke sorting information for Columns                                           |
| [Dashboard](https://www.adaptabletools.com/docs/ui-dashboard/index.md)                                      | Area above Grid providing AdapTable functionality                                         |
| [Data Change History](https://www.adaptabletools.com/docs/handbook-monitoring-data-change-history/index.md) | Shows list of recent Data changes with option to undo                                     |
| [Data Import](https://www.adaptabletools.com/docs/handbook-importing/index.md)                              | Allows run-time users to import data into AG Grid                                         |
| [Data Set](https://www.adaptabletools.com/docs/handbook-data-sets/index.md)                                 | Replace Grid data source with pre-populated data sets                                     |
| [Export](https://www.adaptabletools.com/docs/handbook-exporting/index.md)                                   | Export data as reports to numerous locations                                              |
| [FDC3](https://www.adaptabletools.com/docs/handbook-fdc3/index.md)                                          | Provides support for FDC3                                                                 |
| [Flashing Cells](https://www.adaptabletools.com/docs/handbook-flashing-cell/index.md)                       | Cells will automatically flash when a rule is met                                         |
| [Format Column](https://www.adaptabletools.com/docs/handbook-column-formatting/index.md)                    | Format Column with style or a display format                                              |
| [FreeText Column](https://www.adaptabletools.com/docs/handbook-freetext-column/index.md)                    | Dynamic column with custom user-provided content                                          |
| [Grid Filter](https://www.adaptabletools.com/docs/handbook-grid-filter/index.md)                            | Applies a full Grid filter                                                                |
| [Grid Info](https://www.adaptabletools.com/docs/ui-settings-panel-grid-info/index.md)                      | Display detailed info about AG Grid & AdapTable                                           |
| [ipushpull](https://www.adaptabletools.com/docs/integrations-ipushpull/index.md)                            | Plugin for ipushpull data sharing and distribution                                        |
| [Layout](https://www.adaptabletools.com/docs/handbook-layouts/index.md)                                     | Named column sets with multiple properties (Table and Pivot layouts)                      |
| [Named Query](https://www.adaptabletools.com/docs/handbook-named-queries/index.md)                          | Reusable Queries for use in AdapTableQL                                                   |
| [Notes](https://www.adaptabletools.com/docs/handbook-notes/index.md)                                        | Enables users to create private Notes                                                     |
| [OpenFin](https://www.adaptabletools.com/docs/integrations-openfin/index.md)                                | Plugin for OpenFin desktop containers (snap, dock, notifications)                         |
| [Plus Minus](https://www.adaptabletools.com/docs/handbook-editing-plus-minus/index.md)                      | Configure how cell value edits when pressing +/- keys                                     |
| [Quick Search](https://www.adaptabletools.com/docs/handbook-quick-search/index.md)                          | Quickly highlight all Grid cells containing matching text                                 |
| [Settings Panel](https://www.adaptabletools.com/docs/ui-settings-panel/index.md)                            | Where all Adaptable objects are managed                                                   |
| [Shortcuts](https://www.adaptabletools.com/docs/handbook-editing-shortcut/index.md)                         | Rules to update numeric cells when keyboard pressed                                       |
| [Smart Edit](https://www.adaptabletools.com/docs/handbook-editing-smart-edit/index.md)                      | Edits numeric cells using mathematical operations                                         |
| [State Management](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-management/index.md)       | Manages Adaptable State, User State & Initial Adaptable State                             |
| [Status Bar](https://www.adaptabletools.com/docs/ui-status-bar/index.md)                                    | Configures the Adaptable Status Bar                                                       |
| [Styled Column](https://www.adaptabletools.com/docs/handbook-styled-column-overview/index.md)               | Create a Gradient, Percent Bar, Badge, Sparkline, Bullet, Rating, Range Bar or Icon style |
| [System Status](https://www.adaptabletools.com/docs/handbook-system-status-message/index.md)                | Provide messages about the Status of your application                                     |
| [Team Sharing](https://www.adaptabletools.com/docs/handbook-team-sharing/index.md)                          | Enables users to share objects with colleagues                                            |
| [Theme](https://www.adaptabletools.com/docs/handbook-theming/index.md)                                      | Theme AdapTable with a bespoke colour set                                                 |
| [Tool Panel](https://www.adaptabletools.com/docs/ui-tool-panel/index.md)                                    | Runs the Adaptable Tool Panel Component                                                   |

## Module UI Components

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

- Most Modules have a dedicated screen in the [Settings Panel](https://www.adaptabletools.com/docs/ui-settings-panel/index.md)
- These often contain [Wizards](https://www.adaptabletools.com/docs/ui-settings-panel-wizards/index.md) to provide step-by-step ways to create and edit [Adaptable Objects](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-initial-state/index.md#adaptable-objects)
- Many Modules - e.g. Layouts, Export - provide [Dashboard Toolbars](https://www.adaptabletools.com/docs/ui-dashboard/index.md#tabs-and-toolbars) for easy access to required functionality
- Many Modules also offer [Module ToolPanels](https://www.adaptabletools.com/docs/ui-tool-panel/index.md) which are displayed in the AdapTable ToolPanel Component
- Some Modules provide rich Status Bar Panels to display in the [Status Bar](https://www.adaptabletools.com/docs/ui-status-bar/index.md)
- Many Modules also provide Menu Entries for both the [Column Menu](https://www.adaptabletools.com/docs/ui-column-menu/index.md) and [Context Menu](https://www.adaptabletools.com/docs/ui-context-menu/index.md)

See the [Features Guide](https://www.adaptabletools.com/docs/getting-started-features-guide/index.md) for a full list of which components are used by each Module

## Expressions

These Modules include Rules which can be evaluated using [Expressions](https://www.adaptabletools.com/docs/adaptable-ql-expression/index.md) - rich, human-readable, multi-column and multi-operator constructs for advanced scenarios:

- [Badge Styled Columns](https://www.adaptabletools.com/docs/handbook-styled-column-badge/index.md)
- [Calculated Column](https://www.adaptabletools.com/docs/handbook-calculated-column/index.md)
- [Column Filters](https://www.adaptabletools.com/docs/handbook-column-filter/index.md)
- [Grid Filters](https://www.adaptabletools.com/docs/handbook-grid-filter/index.md)
- [Conditional Styles](https://www.adaptabletools.com/docs/handbook-column-formatting-conditions/index.md)
- [Export](https://www.adaptabletools.com/docs/handbook-exporting/index.md)
- [Flashing Cells](https://www.adaptabletools.com/docs/handbook-flashing-cell/index.md)
- [Named Queries](https://www.adaptabletools.com/docs/handbook-named-queries/index.md)
- [Plus Minus](https://www.adaptabletools.com/docs/handbook-editing-plus-minus/index.md)

## AG Grid Modules

See the [Guide to using AG Grid Modules](https://www.adaptabletools.com/docs/getting-started-aggrid-modules/index.md) 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.

### 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](https://www.adaptabletools.com/docs/handbook-permissioning/index.md) 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 `alternativeModuleNames` property in User Interface Options to provide an alternative name for a Module. It is used whenever the Module name is displayed.
