# Adaptable API Reference

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

- Adaptable API enables full **run-time programmatic access** to all functionality in AdapTable
- It also enables developers to retrieve and modify [Adaptable State](https://www.adaptabletools.com/docs/dev-guide-adaptable-state/index.md)
- Every [Adaptable Object](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-initial-state/index.md#adaptable-objects) can be added, edited, deleted, suspended or shared using the Adaptable API
- The Adaptable API is divided into a series of classes of related material:
  - Many are grouped around an [Adaptable Module](https://www.adaptabletools.com/docs/technical-reference-adaptable-modules/index.md) (e.g. Alert, Calculated Column etc)
  - Others are thematic groups of properties (e.g. Scope, Expressions, Grid)
  - Also includes access to AG Grid's Grid Api object
- The Adaptable API contains an Event class which is used for subscribing to [Adaptable Events](https://www.adaptabletools.com/docs/technical-reference-adaptable-events/index.md)

## API Classes

There are many sections in Adaptable API - based around Modules or thematic functionality.

| API Section                                                                                          | Details                                                                                                                                                     |
| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [AG Grid](https://www.adaptabletools.com/docs/technical-reference-getting-started/index.md)                            | AG Grid's own Grid API, exposed as the `agGridApi` property                                                                                                 |
| [Action Column](https://www.adaptabletools.com/docs/technical-reference-action-column/index.md)                        | Functions for accessing [Action Columns](https://www.adaptabletools.com/docs/handbook-action-column/index.md)                                                                 |
| [Alert](https://www.adaptabletools.com/docs/technical-reference-alerting/index.md)                                     | Contains methods for managing [Alerts](https://www.adaptabletools.com/docs/handbook-alerting/index.md) in Adaptable                                                           |
| [Application](https://www.adaptabletools.com/docs/technical-reference-adaptable-state/index.md)                        | Used for saving [Custom AdapTable State](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-custom/index.md)                                                       |
| [Bulk Update](https://www.adaptabletools.com/docs/technical-reference-editing/index.md)                    | Functions to apply [Bulk Updates](https://www.adaptabletools.com/docs/handbook-editing-bulk-update/index.md) programmatically                                                 |
| [Calculated Column](https://www.adaptabletools.com/docs/technical-reference-calculated-column/index.md)                | Functions relating to [Calculated Columns](https://www.adaptabletools.com/docs/handbook-calculated-column/index.md)                                                           |
| [Calendar](https://www.adaptabletools.com/docs/technical-reference-calendar/index.md)                                  | Manages [Holidays and Working Days](https://www.adaptabletools.com/docs/dev-guide-tutorial-holiday-calendars/index.md)                                                        |
| [Cell Summary](https://www.adaptabletools.com/docs/technical-reference-summarising/index.md)                           | Accesses AG Grid [Cell and Row Summary](https://www.adaptabletools.com/docs/handbook-summarising/index.md) information                                                        |
| [Charting](https://www.adaptabletools.com/docs/technical-reference-charts/index.md)                                    | Enables persistence of [Charts](https://www.adaptabletools.com/docs/handbook-charts/index.md) in AdapTable                                                                    |
| [Column](https://www.adaptabletools.com/docs/technical-reference-column/index.md)                                      | Numerous functions for managing [Adaptable Columns](https://www.adaptabletools.com/docs/dev-guide-columns-adaptable-column/index.md)                                          |
| [Column Menu](https://www.adaptabletools.com/docs/technical-reference-column-menu/index.md)                            | Manages the [Column Menu](https://www.adaptabletools.com/docs/ui-column-menu/index.md)                                                                                        |
| [Column Scope](https://www.adaptabletools.com/docs/technical-reference-column-scope/index.md)                          | Enables programmatic access to [Column and DataType Scoping](https://www.adaptabletools.com/docs/dev-guide-columns-scope/index.md)                                            |
| [Comments](https://www.adaptabletools.com/docs/technical-reference-comments/index.md)                                  | Run-time access to [Comments](https://www.adaptabletools.com/docs/handbook-comments/index.md)                                                                                 |
| [Context Menu](https://www.adaptabletools.com/docs/technical-reference-context-menu/index.md)                          | Manages the [Context Menu](https://www.adaptabletools.com/docs/ui-context-menu/index.md)                                                                                      |
| [Custom Sort](https://www.adaptabletools.com/docs/technical-reference-custom-sorting/index.md)                         | Contains methods for managing [Custom Sorts](https://www.adaptabletools.com/docs/handbook-custom-sorting/index.md)                                                            |
| [Dashboard](https://www.adaptabletools.com/docs/technical-reference-dashboard/index.md)                                | Contains methods for managing the [AdapTable Dashboard](https://www.adaptabletools.com/docs/ui-dashboard/index.md)                                                            |
| [Data Change History](https://www.adaptabletools.com/docs/technical-reference-monitoring-data-change-history/index.md) | Functions enabling [Data Change History](https://www.adaptabletools.com/docs/handbook-monitoring-data-change-history/index.md) to be configured                               |
| [Data Import](https://www.adaptabletools.com/docs/technical-reference-importing/index.md)                              | Used for [Importing Data](https://www.adaptabletools.com/docs/handbook-importing/index.md) into AdapTable                                                                     |
| [Data Set](https://www.adaptabletools.com/docs/technical-reference-data-set/index.md)                                  | Accesses [Data Set](https://www.adaptabletools.com/docs/handbook-data-sets/index.md) functionality at runtime                                                                 |
| [Entitlement](https://www.adaptabletools.com/docs/technical-reference-permissioning/index.md)                          | Manages [Entitlements and Permissions](https://www.adaptabletools.com/docs/handbook-permissioning/index.md)                                                                   |
| [Event](https://www.adaptabletools.com/docs/technical-reference-adaptable-events/index.md)                             | Used for publishing [Adaptable Events](https://www.adaptabletools.com/docs/technical-reference-adaptable-events/index.md)                                                     |
| [Export](https://www.adaptabletools.com/docs/technical-reference-exporting/index.md)                                   | Allows [Reports](https://www.adaptabletools.com/docs/handbook-exporting/index.md) to be run programmatically                                                                  |
| [Expression](https://www.adaptabletools.com/docs/technical-reference-expression/index.md)                              | Used for configuring [Expressions](https://www.adaptabletools.com/docs/adaptable-ql-expression/index.md) in [AdapTableQL](https://www.adaptabletools.com/docs/adaptable-ql-expression/index.md) |
| [FDC3](https://www.adaptabletools.com/docs/technical-reference-fdc3/index.md)                                          | Functions relating to collaborating via [FDC3](https://www.adaptabletools.com/docs/handbook-fdc3/index.md)                                                                    |
| [Filter](https://www.adaptabletools.com/docs/technical-reference-filter/index.md)                                      | Manages both [Column Filters](https://www.adaptabletools.com/docs/handbook-column-filter/index.md) and the [Grid Filter](https://www.adaptabletools.com/docs/handbook-grid-filter/index.md)     |
| [Flashing Cell](https://www.adaptabletools.com/docs/technical-reference-flashing-cell/index.md)                        | Accesses the [Flashing Cells](https://www.adaptabletools.com/docs/handbook-flashing-cell/index.md) functionality in AdapTable                                                 |
| [Format Column](https://www.adaptabletools.com/docs/technical-reference-styling-formatting/index.md)                   | Functions that access AdapTable [Format Columns](https://www.adaptabletools.com/docs/handbook-column-formatting/index.md)                                                     |
| [Free Text Column](https://www.adaptabletools.com/docs/technical-reference-freetext-column/index.md)                   | Contains methods for managing [FreeText Columns](https://www.adaptabletools.com/docs/handbook-freetext-column/index.md)                                                       |
| [Grid](https://www.adaptabletools.com/docs/technical-reference-managing-grid-data/index.md)                            | Contains functions for managing AG Grid and row data                                                                                                        |
| [Layout](https://www.adaptabletools.com/docs/technical-reference-layouts/index.md)                                     | Provides run-time access to [Layouts](https://www.adaptabletools.com/docs/handbook-layouts/index.md)                                                                          |
| [Named Query](https://www.adaptabletools.com/docs/technical-reference-named-query/index.md)                            | Functions that manage [Named Queries](https://www.adaptabletools.com/docs/handbook-named-queries/index.md)                                                                    |
| [Notes](https://www.adaptabletools.com/docs/technical-reference-notes/index.md)                                        | Run-time access to [Notes](https://www.adaptabletools.com/docs/handbook-notes/index.md)                                                                                       |
| [Options](https://www.adaptabletools.com/docs/technical-reference-adaptable-options/index.md)                          | Provides access to [Adaptable Options](https://www.adaptabletools.com/docs/technical-reference-adaptable-options/index.md)                                                    |
| [Plus Minus](https://www.adaptabletools.com/docs/technical-reference-editing/index.md)                      | Functions enabling [Plus Minus Nudges and Rules](https://www.adaptabletools.com/docs/handbook-editing-plus-minus/index.md)                                                    |
| [Quick Search](https://www.adaptabletools.com/docs/technical-reference-quick-search/index.md)                          | Applying and managing [Quick Searches](https://www.adaptabletools.com/docs/handbook-quick-search/index.md) in AdapTable                                                       |
| [Row Form](https://www.adaptabletools.com/docs/technical-reference-row-form/index.md)                                  | Methods for displaying [Row Forms](https://www.adaptabletools.com/docs/handbook-row-form/index.md)                                                                            |
| [Settings Panel](https://www.adaptabletools.com/docs/technical-reference-settings-panel/index.md)                      | Accesses AdapTable's [Settings Panel](https://www.adaptabletools.com/docs/ui-settings-panel/index.md)                                                                         |
| [Shortcut](https://www.adaptabletools.com/docs/technical-reference-editing/index.md)                          | Create [Shortcut](https://www.adaptabletools.com/docs/handbook-editing-shortcut/index.md) rules at runtime                                                                    |
| [Smart Edit](https://www.adaptabletools.com/docs/technical-reference-editing/index.md)                      | Functions to apply [Smart Edits](https://www.adaptabletools.com/docs/handbook-editing-smart-edit/index.md) programmatically                                                   |
| [State](https://www.adaptabletools.com/docs/technical-reference-adaptable-state/index.md)                              | Functions for accessing and manipulating [AdapTable State](https://www.adaptabletools.com/docs/dev-guide-adaptable-state/index.md)                                            |
| [Status Bar](https://www.adaptabletools.com/docs/technical-reference-status-bar/index.md)                              | Programmatic access to the [Status Bar](https://www.adaptabletools.com/docs/ui-status-bar/index.md)                                                                           |
| [Styled Column](https://www.adaptabletools.com/docs/technical-reference-styled-column/index.md)                        | Manages [Styled Columns](https://www.adaptabletools.com/docs/handbook-styled-column-overview/index.md) in Adaptable                                                           |
| [System Status](https://www.adaptabletools.com/docs/technical-reference-system-status-message/index.md)                | Manages displaying [System Status](https://www.adaptabletools.com/docs/handbook-system-status-message/index.md) messages                                                      |
| [Team Sharing](https://www.adaptabletools.com/docs/technical-reference-team-sharing/index.md)                          | Enables [Team Sharing](https://www.adaptabletools.com/docs/handbook-team-sharing/index.md) to be managed programmatically                                                     |
| [Theme](https://www.adaptabletools.com/docs/technical-reference-theming/index.md)                                      | Contains methods for managing [Themes](https://www.adaptabletools.com/docs/handbook-theming/index.md) in AdapTable                                                            |
| [Tool Panel](https://www.adaptabletools.com/docs/technical-reference-tool-panel/index.md)                              | Manages the [AdapTable Tool Panel Component](https://www.adaptabletools.com/docs/ui-tool-panel/index.md)                                                                      |
| [User Interface](https://www.adaptabletools.com/docs/technical-reference-ui/index.md)                                  | Configures colours, styles, and UI behaviour (Dashboard, Settings Panel, Tool Panel, and related components)                                                |

### Plugin API Classes

| Plugin API Section                                                    | Details                                                                                        |
| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| [Plugins](https://www.adaptabletools.com/docs/technical-reference-plugins/index.md)     | Manages access to the Plugins and individual plugin api classes                                |
| [interop](https://www.adaptabletools.com/docs/technical-reference-interop/index.md)     | Functions relating to the [interop.io plugin](https://www.adaptabletools.com/docs/integrations-interop/index.md) |
| [ipushpull](https://www.adaptabletools.com/docs/technical-reference-ipushpull/index.md) | Runtime access to the [ipushpull plugin](https://www.adaptabletools.com/docs/integrations-ipushpull/index.md)    |
| [OpenFin](https://www.adaptabletools.com/docs/technical-reference-openfin/index.md)     | Functions relating to the [OpenFin plugin](https://www.adaptabletools.com/docs/integrations-openfin/index.md)    |

### AG Grid's Grid API Class

`agGridApi` is documented in the [Getting Started Technical Reference](https://www.adaptabletools.com/docs/technical-reference-getting-started/index.md).
