# Adaptable Options Reference

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

- Adaptable Options are configuration properties provided by developers at Design-Time
- They are designed to help developers set up AdapTable to fit their precise requirements
- Adaptable Options includes many properties and options sets including:
  - options to manage [Searches](https://www.adaptabletools.com/docs/technical-reference-quick-search/index.md), [Column Filters](https://www.adaptabletools.com/docs/technical-reference-filter/index.md), [Layouts](https://www.adaptabletools.com/docs/technical-reference-layouts/index.md), [Editing](https://www.adaptabletools.com/docs/technical-reference-editing/index.md) etc.
  - configuration settings for the AdapTable UI: [Settings Panel](https://www.adaptabletools.com/docs/technical-reference-settings-panel/index.md), [Dashboard](https://www.adaptabletools.com/docs/technical-reference-dashboard/index.md), [Tool Panel](https://www.adaptabletools.com/docs/technical-reference-tool-panel/index.md) etc.
  - advanced Grid functionality like [AdapTableQL](https://www.adaptabletools.com/docs/technical-reference-expression/index.md), [Team Sharing](https://www.adaptabletools.com/docs/handbook-team-sharing/index.md), [Menus](https://www.adaptabletools.com/docs/ui-column-menu/index.md), [Entitlements](https://www.adaptabletools.com/docs/handbook-permissioning/index.md) & [State Management](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-management/index.md)
  - any [Initial Adaptable State](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-initial-state/index.md) required for first-time application use
  - many other grouped sets of options required to ensure a full, rich user experience
- Run-time access to Adaptable Options is available via [`Options API`](https://www.adaptabletools.com/docs/reference/optionsapi.md) on the [Adaptable API](https://www.adaptabletools.com/docs/technical-reference-adaptable-api/index.md)

`AdaptableOptions` is the only object created that AdapTable requires to initialise and run.

It is set up by developers at design-time and passed into the AdapTable constructor at startup.

- Adaptable Options contains behaviour and functionality that **will never change at run-time**.
- [Initial Adaptable State](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-initial-state/index.md) contains objects that users can amend and delete through the AdapTable UI.

The [`AdaptableOptions`](https://www.adaptabletools.com/docs/reference/adaptableoptions.md) class consists of a few 'base' properties and a number of `xxxOptions` properties which are themselves collections of related properties (e.g. Search, Layout).

- Typically you will only need to populate a few of the properties in base AdaptableOptions
- And you will likely only require a few of the properties in some of the xxxOptions classes.

For the complete generated property list (every root field and `xxxOptions` type), see [`AdaptableOptions`](https://www.adaptabletools.com/docs/reference/adaptableoptions.md) in the API reference.

Any property that is not supplied by the user when populating the object, will use the default value which is the most sensible and popular option.

## Adaptable Options Contents

| Adaptable Options Section                                                                                             | Details                                                                                                                                                                    |
| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Base Options](#base-options)                                                                                         | Key options required for configuring an AdapTable instance                                                                                                                 |
| [Action Column Options](https://www.adaptabletools.com/docs/technical-reference-action-column/index.md)                        | Configures [Action Columns](https://www.adaptabletools.com/docs/handbook-action-column/index.md)                                                                                             |
| [Alert Options](https://www.adaptabletools.com/docs/technical-reference-alerting/index.md)                                     | Configures [Alerts](https://www.adaptabletools.com/docs/handbook-alerting/index.md) behaviour and forms                                                                                      |
| [Calendar Options](https://www.adaptabletools.com/docs/technical-reference-calendar/index.md)                                   | Defines [Holidays](https://www.adaptabletools.com/docs/dev-guide-tutorial-holiday-calendars/index.md)                                                                                        |
| [Calculated Column Options](https://www.adaptabletools.com/docs/technical-reference-calculated-column/index.md)                | Manages UI options for [Calculated Columns](https://www.adaptabletools.com/docs/handbook-calculated-column/index.md)                                                                         |
| [Cell Summary Options](https://www.adaptabletools.com/docs/technical-reference-summarising/index.md)                           | Supplies Custom [Cell Summary Operations](https://www.adaptabletools.com/docs/handbook-summarising/index.md)                                                                                 |
| [Charting Options](https://www.adaptabletools.com/docs/technical-reference-charts/index.md)                                    | Manages [Charts](https://www.adaptabletools.com/docs/handbook-charts/index.md) support for AG Grid Charting                                                                                  |
| [Column Options](https://www.adaptabletools.com/docs/technical-reference-column/index.md)                                       | Options relating to different Column types in AdapTable                                                                                                                    |
| [Column Menu Options](https://www.adaptabletools.com/docs/technical-reference-column-menu/index.md)                                  | Configures the AdapTable [Column Menu](https://www.adaptabletools.com/docs/ui-column-menu/index.md)                                                                                          |
| [Comment Options](https://www.adaptabletools.com/docs/technical-reference-comments/index.md)                                   | Configures [Comments](https://www.adaptabletools.com/docs/handbook-comments/index.md)                                                                                                        |
| [Container Options](https://www.adaptabletools.com/docs/technical-reference-container/index.md)                               | Manages the different Div elements and popups used by AdapTable                                                                                                            |
| [Context Menu Options](https://www.adaptabletools.com/docs/technical-reference-context-menu/index.md)                                | Configures the AdapTable [Context Menu](https://www.adaptabletools.com/docs/ui-context-menu/index.md)                                                                                        |
| [Custom Sort Options](https://www.adaptabletools.com/docs/technical-reference-custom-sorting/index.md)                         | Provides Custom Sort Comparers for [Custom Sort](https://www.adaptabletools.com/docs/handbook-custom-sorting/index.md)                                                                       |
| [Dashboard Options](https://www.adaptabletools.com/docs/technical-reference-dashboard/index.md)                                      | Sets the [Dashboard](https://www.adaptabletools.com/docs/ui-dashboard/index.md) including custom items                                                                                       |
| [Data Change History Options](https://www.adaptabletools.com/docs/technical-reference-monitoring-data-change-history/index.md) | Configures how [Data Change History](https://www.adaptabletools.com/docs/handbook-monitoring-data-change-history/index.md) operates                                                          |
| [Data Import Options](https://www.adaptabletools.com/docs/technical-reference-importing/index.md)                              | Manages [Importing Data](https://www.adaptabletools.com/docs/handbook-importing/index.md) into AdapTable                                                                                     |
| [Data Set Options](https://www.adaptabletools.com/docs/technical-reference-data-set/index.md)                                  | Provides [Data Sets](https://www.adaptabletools.com/docs/handbook-data-sets/index.md)                                                                                                        |
| [Edit Options](https://www.adaptabletools.com/docs/technical-reference-editing/index.md)                                       | Manages [Editing](https://www.adaptabletools.com/docs/handbook-editing/index.md) in AdapTable                                                                                                |
| [Entitlement Options](https://www.adaptabletools.com/docs/technical-reference-permissioning/index.md)                          | Used for setting up [Permissions and Entitlements](https://www.adaptabletools.com/docs/handbook-permissioning/index.md) in AdapTable                                                         |
| [Export Options](https://www.adaptabletools.com/docs/technical-reference-exporting/index.md)                                   | Configures AdapTable [Reports](https://www.adaptabletools.com/docs/handbook-exporting/index.md) and [Export Destinations](https://www.adaptabletools.com/docs/handbook-exporting/index.md#export-destinations) |
| [Expression Options](https://www.adaptabletools.com/docs/technical-reference-expression/index.md)                          | Options for using [AdapTableQL](https://www.adaptabletools.com/docs/adaptable-ql-expression/index.md) Expressions                                                                            |
| [FDC3 Options](https://www.adaptabletools.com/docs/technical-reference-fdc3/index.md)                                          | Options for when collaborating via [FDC3](https://www.adaptabletools.com/docs/handbook-fdc3/index.md)                                                                                        |
| [Filter Options](https://www.adaptabletools.com/docs/technical-reference-filter/index.md)                               | Configures [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) (`filterOptions`)    |
| [Flashing Cell Options](https://www.adaptabletools.com/docs/technical-reference-flashing-cell/index.md)                        | Manages [Flashing Cells](https://www.adaptabletools.com/docs/handbook-flashing-cell/index.md) functionality in AdapTable                                                                     |
| [Format Column Options](https://www.adaptabletools.com/docs/technical-reference-styling-formatting/index.md)                   | Manages [Custom Display Formats](https://www.adaptabletools.com/docs/handbook-column-formatting-display-format-custom/index.md) in AdapTable                                                 |
| [Layout Options](https://www.adaptabletools.com/docs/technical-reference-layouts/index.md)                                     | How [Layouts](https://www.adaptabletools.com/docs/handbook-layouts/index.md) in AdapTable will operate                                                                                       |
| [Note Options](https://www.adaptabletools.com/docs/technical-reference-notes/index.md)                                         | Configures [Notes](https://www.adaptabletools.com/docs/handbook-notes/index.md)                                                                                                              |
| [Notification Options](https://www.adaptabletools.com/docs/technical-reference-notifications/index.md)                              | Manages [Alerts](https://www.adaptabletools.com/docs/handbook-alerting/index.md) and [Toast Notifications](https://www.adaptabletools.com/docs/ui-tutorial-using-toast-notifications/index.md)                 |
| [Quick Search Options](https://www.adaptabletools.com/docs/technical-reference-quick-search/index.md)                          | Sets up [searching](https://www.adaptabletools.com/docs/handbook-quick-search/index.md) in AdapTable                                                                                         |
| [Row Form Options](https://www.adaptabletools.com/docs/technical-reference-row-form/index.md)                                  | Configures [Row Forms](https://www.adaptabletools.com/docs/handbook-row-form/index.md)                                                                                                       |
| [Settings Panel Options](https://www.adaptabletools.com/docs/technical-reference-settings-panel/index.md)                            | Configures the [Settings Panel](https://www.adaptabletools.com/docs/ui-settings-panel/index.md)                                                                                              |
| [State Options](https://www.adaptabletools.com/docs/dev-guide-adaptable-state-persistence/index.md)                                     | Manages how [AdapTable State](https://www.adaptabletools.com/docs/dev-guide-adaptable-state/index.md) is persisted (and potentially enriched)                                                |
| [Team Sharing Options](https://www.adaptabletools.com/docs/technical-reference-team-sharing/index.md)                          | Configures the [Team Sharing](https://www.adaptabletools.com/docs/handbook-team-sharing/index.md) functionality in AdapTable                                                                 |
| [Tool Panel Options](https://www.adaptabletools.com/docs/technical-reference-tool-panel/index.md)                                    | Sets up the AdapTable [ToolPanel Component](https://www.adaptabletools.com/docs/ui-tool-panel/index.md)                                                                                      |
| [User Interface Options](https://www.adaptabletools.com/docs/technical-reference-ui/index.md)                                           | Configures how the AdapTable UI works                                                                                                                                      |
| [Wizard Options](https://www.adaptabletools.com/docs/technical-reference-settings-panel-wizards/index.md)                            | Options for managing size and position of [Wizards](https://www.adaptabletools.com/docs/ui-settings-panel-wizards/index.md)                                                                  |

### Plugin Options

| Plugin Options Section                                                            | Details                                                                                               |
| --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| [interop Plugin Options](https://www.adaptabletools.com/docs/integrations-interop/index.md)         | Options for when using the [interop.io Plugin](https://www.adaptabletools.com/docs/integrations-interop/index.md)       |
| [ipushpull Plugin Options](https://www.adaptabletools.com/docs/integrations-ipushpull/index.md)     | Options for when using the [ipushpull Plugin](https://www.adaptabletools.com/docs/integrations-ipushpull/index.md)      |
| [OpenFin Plugin Options](https://www.adaptabletools.com/docs/integrations-openfin/index.md)         | Options for when using the [OpenFin Plugin](https://www.adaptabletools.com/docs/integrations-openfin/index.md)          |
| [Master Detail Plugin Options](https://www.adaptabletools.com/docs/handbook-master-detail/index.md) | Options for creating [Master Detail Grids](https://www.adaptabletools.com/docs/handbook-master-detail/index.md)         |

## Base Options

Base Options are the properties in the root of Adaptable Options that are not grouped into a section.

- These are generally the more important options that need to be set
- You should try to provide values for each of these properties

The properties in the root of Adaptable Options include:

| Base Options Property                                                                                   | Description                                                                                                         | Mandatory |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | :-------: |
| [primaryKey](https://www.adaptabletools.com/docs/getting-started-primary-key/index.md)                                    | Column containing only unique values, used to identify rows                                                         |    ✅     |
| [autogeneratePrimaryKey](https://www.adaptabletools.com/docs/getting-started-primary-key/index.md#auto-generated-key)     | Primary key generated dynamically (if no suitable column)                                                           |           |
| [initialState](https://www.adaptabletools.com/docs/technical-reference-initial-state/index.md)                            | AdapTable State designed for first-time use in the application                                                      |    ✅     |
| [adaptableId](https://www.adaptabletools.com/docs/getting-started-adaptable-id/index.md)                                  | Name for this AdapTable instance                                                                                    |           |
| [adaptableStateKey](https://www.adaptabletools.com/docs/getting-started-adaptable-state-key/index.md)                      | Identifier for AdapTable State (used with local storage)                                                            |           |
| [licenseKey](https://www.adaptabletools.com/docs/getting-started-license-key/index.md)                                    | Key required for every commercial AdapTable instance                                                                |           |
| [userName](https://www.adaptabletools.com/docs/getting-started-user-name/index.md)                                        | Name of the current user                                                                                            |           |
| [adaptableContext](https://www.adaptabletools.com/docs/dev-guide-tutorial-providing-adaptable-context/index.md)           | Bespoke Application context included in callbacks & events                                                          |           |
| [`plugins`](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#plugins)                                               | Array of [`AdaptablePlugin`](https://www.adaptabletools.com/docs/reference/adaptableplugin.md) instances (see [Plugin Options](#plugin-options)) |           |

<hr/>

## Function Properties Context

Each section in AdapTable Options is made up of a mix of 2 elements:

- properties that require a value which is a **primitive data type** (i.e. a string, number, date or boolean)
- properties that require custom **functions** to supplied (which will return the required value)

Many properties can be of either element, e.g. can be a string or a function that returns a string

Nearly all functions used by AdapTable Options take a single object as the argument.

This object is usually named xxxContext, and contains function-specific data.

This is very similar to the xxxParams pattern used by AG Grid

Each context object derives from [`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md) object which contains these properties:

| Property | Type | Description |
| --- | --- | --- |
| [adaptableApi](https://www.adaptabletools.com/docs/reference/basecontext.md#adaptableapi) | [`AdaptableApi`](https://www.adaptabletools.com/docs/reference/adaptableapi.md) | Adaptable Api object |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/basecontext.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |
| [adaptableId](https://www.adaptabletools.com/docs/reference/basecontext.md#adaptableid) | `string` | Id of current AdapTable instance |
| [adaptableStateKey](https://www.adaptabletools.com/docs/reference/basecontext.md#adaptablestatekey) | `string` | Current Adaptable State Key |
| [clientTimestamp](https://www.adaptabletools.com/docs/reference/basecontext.md#clienttimestamp) | `Date` | Time on user&#39;s computer |
| [userName](https://www.adaptabletools.com/docs/reference/basecontext.md#username) | `string` | Name of Current User |

## Run-Time Access

AdapTable makes run time access to Adaptable Options available via [`Options API`](https://www.adaptabletools.com/docs/reference/optionsapi.md) in [Adaptable API](https://www.adaptabletools.com/docs/technical-reference-adaptable-api/index.md):

The full set of convenience functions to enable easy access to Adaptable Options properties is:

| Method | Returns | Description |
| --- | --- | --- |
| [addToAdaptableContext(key, value)](https://www.adaptabletools.com/docs/reference/optionsapi.md#addtoadaptablecontext) | `void` | Adds a key-value pair to the AdaptableContext |
| [clearAdaptableContext()](https://www.adaptabletools.com/docs/reference/optionsapi.md#clearadaptablecontext) | `void` | Clears all key-value pairs from the AdaptableContext |
| [getActionColumnOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getactioncolumnoptions) | `Readonly<`[`ActionColumnOptions`](https://www.adaptabletools.com/docs/reference/actioncolumnoptions.md)`>` | Returns `AdaptableOptions.actionColumnOptions` |
| [getAdaptableContext()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getadaptablecontext) | `TContext` | Returns `AdaptableOptions.adaptableContext` |
| [getAdaptableId()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getadaptableid) | `string` | Returns `AdaptableOptions.adaptableId` |
| [getAdaptableOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getadaptableoptions) | `Readonly<`[`AdaptableOptions`](https://www.adaptabletools.com/docs/reference/adaptableoptions.md)`>` | Returns provided `AdaptableOptions` |
| [getAdaptableStateKey()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getadaptablestatekey) | `string` | Returns `AdaptableOptions.adaptableStateKey` |
| [getAlertOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getalertoptions) | `Readonly<`[`AlertOptions`](https://www.adaptabletools.com/docs/reference/alertoptions.md)`>` | Returns `AdaptableOptions.alertOptions` |
| [getCalculatedColumnOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcalculatedcolumnoptions) | `Readonly<`[`CalculatedColumnOptions`](https://www.adaptabletools.com/docs/reference/calculatedcolumnoptions.md)`>` | Returns `AdaptableOptions.calculatedColumnOptions` |
| [getCalendarOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcalendaroptions) | `Readonly<`[`CalendarOptions`](https://www.adaptabletools.com/docs/reference/calendaroptions.md)`>` | Returns `AdaptableOptions.calendarOptions` |
| [getCellSummaryOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcellsummaryoptions) | `Readonly<`[`CellSummaryOptions`](https://www.adaptabletools.com/docs/reference/cellsummaryoptions.md)`>` | Returns `AdaptableOptions.cellSummaryOptions` |
| [getChartingOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getchartingoptions) | `Readonly<`[`ChartingOptions`](https://www.adaptabletools.com/docs/reference/chartingoptions.md)`>` | Returns `AdaptableOptions.chartingOptions` |
| [getColumnMenuOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcolumnmenuoptions) | `Readonly<`[`ColumnMenuOptions`](https://www.adaptabletools.com/docs/reference/columnmenuoptions.md)`>` | Returns `AdaptableOptions.columnMenuOptions` |
| [getColumnOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcolumnoptions) | `Readonly<`[`ColumnOptions`](https://www.adaptabletools.com/docs/reference/columnoptions.md)`>` | Returns `AdaptableOptions.columnOptions` |
| [getCommentOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcommentoptions) | `Readonly<`[`CommentOptions`](https://www.adaptabletools.com/docs/reference/commentoptions.md)`>` | Returns `AdaptableOptions.commentOptions` |
| [getContainerOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcontaineroptions) | `Readonly<`[`ContainerOptions`](https://www.adaptabletools.com/docs/reference/containeroptions.md)`>` | Returns `AdaptableOptions.containerOptions` |
| [getContextMenuOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcontextmenuoptions) | `Readonly<`[`ContextMenuOptions`](https://www.adaptabletools.com/docs/reference/contextmenuoptions.md)`>` | Returns `AdaptableOptions.contextMenuOptions` |
| [getCustomSortOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getcustomsortoptions) | `Readonly<`[`CustomSortOptions`](https://www.adaptabletools.com/docs/reference/customsortoptions.md)`>` | Returns `AdaptableOptions.customSortOptions` |
| [getDashboardOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getdashboardoptions) | `Readonly<`[`DashboardOptions`](https://www.adaptabletools.com/docs/reference/dashboardoptions.md)`>` | Returns `AdaptableOptions.dashboardOptions` |
| [getDataChangeHistoryOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getdatachangehistoryoptions) | `Readonly<`[`DataChangeHistoryOptions`](https://www.adaptabletools.com/docs/reference/datachangehistoryoptions.md)`>` | Returns `AdaptableOptions.dataChangeHistoryOptions` |
| [getDataImportOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getdataimportoptions) | `Readonly<`[`DataImportOptions`](https://www.adaptabletools.com/docs/reference/dataimportoptions.md)`>` | Returns `AdaptableOptions.dataImportOptions` |
| [getDataSetOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getdatasetoptions) | `Readonly<`[`DataSetOptions`](https://www.adaptabletools.com/docs/reference/datasetoptions.md)`>` | Returns `AdaptableOptions.dataSetOptions` |
| [getEditOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#geteditoptions) | `Readonly<`[`EditOptions`](https://www.adaptabletools.com/docs/reference/editoptions.md)`>` | Returns `AdaptableOptions.editOptions` |
| [getEntitlementOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getentitlementoptions) | `Readonly<`[`EntitlementOptions`](https://www.adaptabletools.com/docs/reference/entitlementoptions.md)`>` | Returns `AdaptableOptions.entitlementOptions` |
| [getExportOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getexportoptions) | `Readonly<`[`ExportOptions`](https://www.adaptabletools.com/docs/reference/exportoptions.md)`>` | Returns `AdaptableOptions.exportOptions` |
| [getExpressionOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getexpressionoptions) | `Readonly<`[`ExpressionOptions`](https://www.adaptabletools.com/docs/reference/expressionoptions.md)`>` | Returns `AdaptableOptions.expressionOptions` |
| [getFdc3Options()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getfdc3options) | `Readonly<`[`Fdc3Options`](https://www.adaptabletools.com/docs/reference/fdc3options.md)`>` | Returns `AdaptableOptions.fdc3Options` |
| [getFilterOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getfilteroptions) | `Readonly<`[`FilterOptions`](https://www.adaptabletools.com/docs/reference/filteroptions.md)`>` | Returns `AdaptableOptions.filterOptions` |
| [getFlashingCellOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getflashingcelloptions) | `Readonly<`[`FlashingCellOptions`](https://www.adaptabletools.com/docs/reference/flashingcelloptions.md)`>` | Returns `AdaptableOptions.flashingCellOptions` |
| [getFormatColumnOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getformatcolumnoptions) | `Readonly<`[`FormatColumnOptions`](https://www.adaptabletools.com/docs/reference/formatcolumnoptions.md)`>` | Returns `AdaptableOptions.formatColumnOptions` |
| [getLayoutOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getlayoutoptions) | `Readonly<`[`LayoutOptions`](https://www.adaptabletools.com/docs/reference/layoutoptions.md)`>` | Returns `AdaptableOptions.layoutOptions` |
| [getLicenseKey()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getlicensekey) | `string` | Returns `AdaptableOptions.licenseKey` |
| [getNoteOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getnoteoptions) | `Readonly<`[`NoteOptions`](https://www.adaptabletools.com/docs/reference/noteoptions.md)`>` | Returns `AdaptableOptions.noteOptions` |
| [getNotificationsOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getnotificationsoptions) | `Readonly<`[`NotificationsOptions`](https://www.adaptabletools.com/docs/reference/notificationsoptions.md)`>` | Returns `AdaptableOptions.notificationsOptions` |
| [getPrimaryKey()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getprimarykey) | `string` | Returns `AdaptableOptions.primaryKey` |
| [getQuickSearchOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getquicksearchoptions) | `Readonly<`[`QuickSearchOptions`](https://www.adaptabletools.com/docs/reference/quicksearchoptions.md)`>` | Returns `AdaptableOptions.quickSearchOptions` |
| [getRowFormOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getrowformoptions) | `Readonly<`[`RowFormOptions`](https://www.adaptabletools.com/docs/reference/rowformoptions.md)`>` | Returns `AdaptableOptions.rowFormOptions` |
| [getSettingsPanelOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getsettingspaneloptions) | `Readonly<`[`SettingsPanelOptions`](https://www.adaptabletools.com/docs/reference/settingspaneloptions.md)`>` | Returns `AdaptableOptions.settingsPanelOptions` |
| [getStateOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getstateoptions) | `Readonly<`[`StateOptions`](https://www.adaptabletools.com/docs/reference/stateoptions.md)`>` | Returns `AdaptableOptions.stateOptions` |
| [getTeamSharingOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getteamsharingoptions) | `Readonly<`[`TeamSharingOptions`](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md)`>` | Returns `AdaptableOptions.teamSharingOptions` |
| [getToolPanelOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#gettoolpaneloptions) | `Readonly<`[`ToolPanelOptions`](https://www.adaptabletools.com/docs/reference/toolpaneloptions.md)`>` | Returns `AdaptableOptions.toolPanelOptions` |
| [getUserInterfaceOptions()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getuserinterfaceoptions) | `Readonly<`[`UserInterfaceOptions`](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md)`>` | Returns `AdaptableOptions.userInterfaceOptions` |
| [getUserName()](https://www.adaptabletools.com/docs/reference/optionsapi.md#getusername) | `string` | Returns `AdaptableOptions.userName` |
| [isAutogeneratePrimaryKey()](https://www.adaptabletools.com/docs/reference/optionsapi.md#isautogenerateprimarykey) | `boolean` | Returns `AdaptableOptions.autogeneratePrimaryKey` |
| [removeFromAdaptableContext(key)](https://www.adaptabletools.com/docs/reference/optionsapi.md#removefromadaptablecontext) | `void` | Removes a key from the AdaptableContext |

## TypeScript Generics

Adaptable Options fully supports [TypeScript Generics](https://www.typescriptlang.org/docs/handbook/2/generics.html).

This allows for improved type safety and developer experience by providing the row data type to the Adaptable Options definition.

This integrates seamlessly with the [AG Grid TypeScript Generics](https://www.ag-grid.com/javascript-data-grid/typescript-generics/) for `Row Data`

### Using Generics in Adaptable Options

```ts {2,9}
// Row Data interface
interface ICar {
  make: string;
  model: string;
  price: number;
}

// Adaptable Options definition
const adaptableOptions: AdaptableOptions<ICar> = {
  // ...
};
```
