# AdaptableOptions

Canonical page: https://www.adaptabletools.com/docs/reference/adaptableoptions

Design-time configuration for one AdapTable instance.

These options are fixed by the application. Objects the user can change and that are persisted (Layouts, Alerts, Format Columns, Calculated Columns and the other module objects) belong in , not here.

`primaryKey` and `initialState` are required. Every `*Options` property is optional: omit it to keep that module&#39;s defaults.

```ts title="TypeScript"
export interface AdaptableOptions<TData = any, TContext = Record<string, any>> 
```

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [actionColumnOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#actioncolumnoptions) | [`ActionColumnOptions`](https://www.adaptabletools.com/docs/reference/actioncolumnoptions.md)`<TData>` | Action Columns: columns of buttons, menus, toggles and other controls that run an action on the row.<br/><br/>The columns themselves are supplied here. They are not part of Initial State. |   |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#adaptablecontext) | `TContext` | Values from the host application, passed into every callback and event as `adaptableContext`.<br/><br/>Use it for things the grid should see but not store, such as the current user, permissions or a service. It is not persisted. |  |
| [adaptableId](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#adaptableid) | `string` | Identifies this grid when more than one AdapTable is on the page.<br/><br/>Also the default key under which state is stored, unless  is set. A generated id (`adaptable_id_` plus a random number) is used when this is omitted, so state will not survive a reload. | &#39;adaptable_id_$random_number&#39; |
| [adaptableStateKey](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#adaptablestatekey) | `string` | Key under which this grid&#39;s state is stored, instead of .<br/><br/>Set it when several grids should share one state, or when the storage key should change without changing `adaptableId`.  is applied only when nothing is already stored under this key. | `adaptableId` value |
| [alertOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#alertoptions) | [`AlertOptions`](https://www.adaptabletools.com/docs/reference/alertoptions.md)`<TData>` | How fired alerts behave: how many are kept, how long a cell or row stays highlighted, and the text shown when an alert fires.<br/><br/>The Alert Definitions themselves (the rules) belong in Initial State. |   |
| [autogeneratePrimaryKey](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#autogenerateprimarykey) | `boolean` | Invents a primary key when the data has no unique column.<br/><br/>Use it only as a last resort. Notes, comments, data-change history and row identity then cannot follow a real business key, and some of those features are limited. | false |
| [calculatedColumnOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#calculatedcolumnoptions) | [`CalculatedColumnOptions`](https://www.adaptabletools.com/docs/reference/calculatedcolumnoptions.md) | Calculated Columns whose values come from an AdapTableQL expression: formula trace, and how often aggregated columns recompute after row changes.<br/><br/>The column definitions belong in Initial State. |   |
| [calendarOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#calendaroptions) | [`CalendarOptions`](https://www.adaptabletools.com/docs/reference/calendaroptions.md) | Which days are working days. Weekend days and holidays are excluded from working-day expression functions. |   |
| [cellSummaryOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#cellsummaryoptions) | [`CellSummaryOptions`](https://www.adaptabletools.com/docs/reference/cellsummaryoptions.md)`<TData>` | Extra summary operations for the selected cells, beyond the ones AdapTable ships (sum, average and the rest), and how the result is formatted. |   |
| [chartingOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#chartingoptions) | [`ChartingOptions`](https://www.adaptabletools.com/docs/reference/chartingoptions.md) | Saving and reopening AG Grid charts, which containers they open in, and external (non-AG Grid) charts.<br/><br/>Chart definitions the user saves are stored in state. These options control that behaviour. |   |
| [columnMenuOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#columnmenuoptions) | [`ColumnMenuOptions`](https://www.adaptabletools.com/docs/reference/columnmenuoptions.md)`<TData>` | Replaces or extends the menu opened from a column header. The callback receives AdapTable&#39;s default items. |   |
| [columnOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#columnoptions) | [`ColumnOptions`](https://www.adaptabletools.com/docs/reference/columnoptions.md) | Column captions and friendly names, column types used by Column Scope, and whether a missing column is logged. |   |
| [commentOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#commentoptions) | [`CommentOptions`](https://www.adaptabletools.com/docs/reference/commentoptions.md)`<TData>` | Comments on cells: which cells can be commented, and how threads are loaded and saved.<br/><br/>Comments are not part of AdapTable State. The application loads and persists them through these callbacks. |   |
| [containerOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#containeroptions) | [`ContainerOptions`](https://www.adaptabletools.com/docs/reference/containeroptions.md) | DOM elements that host the grid, the AG Grid instance, the Settings Panel, alerts, system status and the transposed view.<br/><br/>Set these when AdapTable is not mounted into the default divs. |   |
| [contextMenuOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#contextmenuoptions) | [`ContextMenuOptions`](https://www.adaptabletools.com/docs/reference/contextmenuoptions.md)`<TData>` | Replaces or extends the right-click menu. The callback receives AdapTable&#39;s default items. |   |
| [customSortOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#customsortoptions) | [`CustomSortOptions`](https://www.adaptabletools.com/docs/reference/customsortoptions.md) | Comparer functions for a Custom Sort, used when the sort order is not a simple list of values.<br/><br/>The Custom Sort objects (the ordered values) belong in Initial State. |   |
| [dashboardOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#dashboardoptions) | [`DashboardOptions`](https://www.adaptabletools.com/docs/reference/dashboardoptions.md) | The Dashboard above the grid: whether it can float, custom toolbars and buttons, and where the module buttons sit.<br/><br/>Which toolbars are on each tab is stored in Dashboard state. |   |
| [dataChangeHistoryOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#datachangehistoryoptions) | [`DataChangeHistoryOptions`](https://www.adaptabletools.com/docs/reference/datachangehistoryoptions.md)`<TData>` | The log of cell value changes: whether it starts active, which changes are recorded, and the undo button. |   |
| [dataImportOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#dataimportoptions) | [`DataImportOptions`](https://www.adaptabletools.com/docs/reference/dataimportoptions.md) | The import wizard: how a file or pasted text becomes rows, how those rows are validated, and how they are written into the grid. |   |
| [dataSetOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#datasetoptions) | [`DataSetOptions`](https://www.adaptabletools.com/docs/reference/datasetoptions.md)`<TData>` | Named sets of rows the user can switch between. Each set supplies its own data. |   |
| [editOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#editoptions) | [`EditOptions`](https://www.adaptabletools.com/docs/reference/editoptions.md)`<TData>` | Cell editing: which cells can be edited, server-side validation, the values offered in a dropdown editor, Plus Minus nudges and Smart Edit. |   |
| [entitlementOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#entitlementoptions) | [`EntitlementOptions`](https://www.adaptabletools.com/docs/reference/entitlementoptions.md) | Which modules a user may see or change. `Full`, `ReadOnly` or `Hidden`, per module or as a default.<br/><br/>A module that defaults to hidden (such as State) stays hidden until `moduleEntitlements` allows it. |   |
| [exportOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#exportoptions) | [`ExportOptions`](https://www.adaptabletools.com/docs/reference/exportoptions.md)`<TData>` | Reports: which system reports, formats and destinations are offered, custom destinations, and whether a column is included.<br/><br/>Report definitions the user creates are stored in Export state. |   |
| [expressionOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#expressionoptions) | [`ExpressionOptions`](https://www.adaptabletools.com/docs/reference/expressionoptions.md)`<TData>` | AdapTableQL: custom functions, which columns and fields an expression may use, case sensitivity, and how the expression editor is presented.<br/><br/>Expressions saved on objects (a filter, an alert rule, a calculated column) live on those objects. These options change how every expression is evaluated and edited. |   |
| [fdc3Options](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#fdc3options) | [`Fdc3Options`](https://www.adaptabletools.com/docs/reference/fdc3options.md) | FDC3: which intents and contexts this grid raises, listens for and broadcasts, and how a row&#39;s columns map onto an FDC3 context. |   |
| [filterOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#filteroptions) | [`FilterOptions`](https://www.adaptabletools.com/docs/reference/filteroptions.md)`<TData>` | Column Filters and the Grid Filter: whether AdapTable&#39;s filters are used instead of AG Grid&#39;s, the quick filter bar, and the default operator for each data type.<br/><br/>The filters the user creates are stored in the Layout. |   |
| [flashingCellOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#flashingcelloptions) | [`FlashingCellOptions`](https://www.adaptabletools.com/docs/reference/flashingcelloptions.md) | Defaults for a flashing cell when a Flashing Cell definition does not set them: up, down and neutral styles, whether the cell or the row flashes, and for how long.<br/><br/>The definitions themselves belong in Initial State. |   |
| [formatColumnOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#formatcolumnoptions) | [`FormatColumnOptions`](https://www.adaptabletools.com/docs/reference/formatcolumnoptions.md) | Display formatters beyond the ones AdapTable ships, used by Format Columns.<br/><br/>The Format Column objects (which column, which style and format) belong in Initial State. |   |
| [initialState](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#initialstate) | [`InitialState`](https://www.adaptabletools.com/docs/reference/initialstate.md) | Objects shipped with the grid for its first run: at least one Layout, plus any Alerts, Format Columns, Calculated Columns and other module objects.<br/><br/>Applied only when no state is already stored for this grid. After that, the stored state is used and later edits to `initialState` are ignored until that stored state is cleared or the state key changes. | undefined |
| [layoutOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#layoutoptions) | [`LayoutOptions`](https://www.adaptabletools.com/docs/reference/layoutoptions.md)`<TData>` | How Layouts are created and shown: a layout built from the AG Grid column definitions, defaults for a new Table or Pivot Layout, and whether layout extensions are offered in the UI.<br/><br/>The Layout objects belong in Initial State. A grid needs at least one. |   |
| [licenseKey](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#licensekey) | `string` | Commercial licence key.<br/><br/>Without a current licence, AdapTable shows licence notices and limits some functionality. |   |
| [noteOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#noteoptions) | [`NoteOptions`](https://www.adaptabletools.com/docs/reference/noteoptions.md) | Notes on cells: which cells can hold a note, the note type applied on creation, and how the timestamp is formatted.<br/><br/>The notes themselves are stored in Note state. |   |
| [notificationsOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#notificationsoptions) | [`NotificationsOptions`](https://www.adaptabletools.com/docs/reference/notificationsoptions.md) | Toasts: where they appear, how long they stay, and how many system status messages are kept. |   |
| [plugins](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#plugins) | [`AdaptablePlugin`](https://www.adaptabletools.com/docs/reference/adaptableplugin.md)`[]` | Plugins constructed by the application and handed to AdapTable: OpenFin, ipushpull, interop.io and Master-Detail.<br/><br/>Each plugin is created with its own options. This array registers them. |   |
| [primaryKey](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#primarykey) | `string` | Column whose values uniquely identify a row. Required.<br/><br/>AdapTable uses it to find a row for edits, notes, comments, alerts, history and row forms. The values must be unique. | n/a (Mandatory) |
| [quickSearchOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#quicksearchoptions) | [`QuickSearchOptions`](https://www.adaptabletools.com/docs/reference/quicksearchoptions.md)`<TData>` | Quick Search: which cells are searched, whether matching rows are filtered, and whether the search is case sensitive. |   |
| [rowFormOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#rowformoptions) | [`RowFormOptions`](https://www.adaptabletools.com/docs/reference/rowformoptions.md)`<TData>` | Create, clone and edit forms for a row: which columns appear, how the primary key of a new row is set, and whether AdapTable writes the result into the grid. |   |
| [settingsPanelOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#settingspaneloptions) | [`SettingsPanelOptions`](https://www.adaptabletools.com/docs/reference/settingspaneloptions.md) | The Settings Panel: its title and icon, which modules appear and in which groups, and whether it opens as a modal or a movable window. |   |
| [stateOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#stateoptions) | [`StateOptions`](https://www.adaptabletools.com/docs/reference/stateoptions.md) | Where state is loaded from and saved to. The default is `localStorage`.<br/><br/>Replace `loadState` and `persistState` to keep state on a server. `saveState` and `applyState` change the object just before it is stored or applied. |   |
| [teamSharingOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#teamsharingoptions) | [`TeamSharingOptions`](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md) | Sharing Adaptable Objects with other users. The application loads and saves the shared objects; AdapTable does not ship a server.<br/><br/>Turn it on with `enableTeamSharing`, then provide `loadSharedEntities` and `persistSharedEntities`. |   |
| [toolPanelOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#toolpaneloptions) | [`ToolPanelOptions`](https://www.adaptabletools.com/docs/reference/toolpaneloptions.md) | The tool panel beside the grid: custom panels, custom buttons, and whether the panel dropdown is shown. |   |
| [userInterfaceOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#userinterfaceoptions) | [`UserInterfaceOptions`](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md)`<TData>` | Shared UI: the application icon, custom icons, editable and read-only cell styles, the colour picker, date inputs, the loading screen, and the names shown for modules. |   |
| [userName](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#username) | `string` | Name of the person using this grid.<br/><br/>Stamped on Notes and Comments when the author is not supplied, and shown where Team Sharing records who shared an object. | &#39;anonymous&#39; |
| [wizardOptions](https://www.adaptabletools.com/docs/reference/adaptableoptions.md#wizardoptions) | [`WizardOptions`](https://www.adaptabletools.com/docs/reference/wizardoptions.md) | Wizards and the other action popups (Bulk Update, Smart Edit, Cell Summary): modal or window, and the window&#39;s position and size.<br/><br/>Independent of the Settings Panel. Ignored when `containerOptions.modalContainer` places every popup in one element. |   |

## Property Details

### actionColumnOptions

Action Columns: columns of buttons, menus, toggles and other controls that run an action on the row.

The columns themselves are supplied here. They are not part of Initial State.

```ts title="TypeScript"
actionColumnOptions?: ActionColumnOptions<TData>;
```

###### Property Value

[`ActionColumnOptions`](https://www.adaptabletools.com/docs/reference/actioncolumnoptions.md)`<TData>`

### adaptableContext

Values from the host application, passed into every callback and event as `adaptableContext`.

Use it for things the grid should see but not store, such as the current user, permissions or a service. It is not persisted.

```ts title="TypeScript"
adaptableContext?: TContext;
```

###### Default Value

###### Property Value

`TContext`

### adaptableId

Identifies this grid when more than one AdapTable is on the page.

Also the default key under which state is stored, unless  is set. A generated id (`adaptable_id_` plus a random number) is used when this is omitted, so state will not survive a reload.

```ts title="TypeScript"
adaptableId?: string;
```

###### Default Value

&#39;adaptable_id_$random_number&#39;

###### Property Value

`string`

### adaptableStateKey

Key under which this grid&#39;s state is stored, instead of .

Set it when several grids should share one state, or when the storage key should change without changing `adaptableId`.  is applied only when nothing is already stored under this key.

```ts title="TypeScript"
adaptableStateKey?: string;
```

###### Default Value

`adaptableId` value

###### Property Value

`string`

### alertOptions

How fired alerts behave: how many are kept, how long a cell or row stays highlighted, and the text shown when an alert fires.

The Alert Definitions themselves (the rules) belong in Initial State.

```ts title="TypeScript"
alertOptions?: AlertOptions<TData>;
```

###### Property Value

[`AlertOptions`](https://www.adaptabletools.com/docs/reference/alertoptions.md)`<TData>`

### autogeneratePrimaryKey

Invents a primary key when the data has no unique column.

Use it only as a last resort. Notes, comments, data-change history and row identity then cannot follow a real business key, and some of those features are limited.

```ts title="TypeScript"
autogeneratePrimaryKey?: boolean;
```

###### Default Value

false

###### Property Value

`boolean`

### calculatedColumnOptions

Calculated Columns whose values come from an AdapTableQL expression: formula trace, and how often aggregated columns recompute after row changes.

The column definitions belong in Initial State.

```ts title="TypeScript"
calculatedColumnOptions?: CalculatedColumnOptions;
```

###### Property Value

[`CalculatedColumnOptions`](https://www.adaptabletools.com/docs/reference/calculatedcolumnoptions.md)

### calendarOptions

Which days are working days. Weekend days and holidays are excluded from working-day expression functions.

```ts title="TypeScript"
calendarOptions?: CalendarOptions;
```

###### Property Value

[`CalendarOptions`](https://www.adaptabletools.com/docs/reference/calendaroptions.md)

### cellSummaryOptions

Extra summary operations for the selected cells, beyond the ones AdapTable ships (sum, average and the rest), and how the result is formatted.

```ts title="TypeScript"
cellSummaryOptions?: CellSummaryOptions<TData>;
```

###### Property Value

[`CellSummaryOptions`](https://www.adaptabletools.com/docs/reference/cellsummaryoptions.md)`<TData>`

### chartingOptions

Saving and reopening AG Grid charts, which containers they open in, and external (non-AG Grid) charts.

Chart definitions the user saves are stored in state. These options control that behaviour.

```ts title="TypeScript"
chartingOptions?: ChartingOptions;
```

###### Property Value

[`ChartingOptions`](https://www.adaptabletools.com/docs/reference/chartingoptions.md)

### columnMenuOptions

Replaces or extends the menu opened from a column header. The callback receives AdapTable&#39;s default items.

```ts title="TypeScript"
columnMenuOptions?: ColumnMenuOptions<TData>;
```

###### Property Value

[`ColumnMenuOptions`](https://www.adaptabletools.com/docs/reference/columnmenuoptions.md)`<TData>`

### columnOptions

Column captions and friendly names, column types used by Column Scope, and whether a missing column is logged.

```ts title="TypeScript"
columnOptions?: ColumnOptions;
```

###### Property Value

[`ColumnOptions`](https://www.adaptabletools.com/docs/reference/columnoptions.md)

### commentOptions

Comments on cells: which cells can be commented, and how threads are loaded and saved.

Comments are not part of AdapTable State. The application loads and persists them through these callbacks.

```ts title="TypeScript"
commentOptions?: CommentOptions<TData>;
```

###### Property Value

[`CommentOptions`](https://www.adaptabletools.com/docs/reference/commentoptions.md)`<TData>`

### containerOptions

DOM elements that host the grid, the AG Grid instance, the Settings Panel, alerts, system status and the transposed view.

Set these when AdapTable is not mounted into the default divs.

```ts title="TypeScript"
containerOptions?: ContainerOptions;
```

###### Property Value

[`ContainerOptions`](https://www.adaptabletools.com/docs/reference/containeroptions.md)

### contextMenuOptions

Replaces or extends the right-click menu. The callback receives AdapTable&#39;s default items.

```ts title="TypeScript"
contextMenuOptions?: ContextMenuOptions<TData>;
```

###### Property Value

[`ContextMenuOptions`](https://www.adaptabletools.com/docs/reference/contextmenuoptions.md)`<TData>`

### customSortOptions

Comparer functions for a Custom Sort, used when the sort order is not a simple list of values.

The Custom Sort objects (the ordered values) belong in Initial State.

```ts title="TypeScript"
customSortOptions?: CustomSortOptions;
```

###### Property Value

[`CustomSortOptions`](https://www.adaptabletools.com/docs/reference/customsortoptions.md)

### dashboardOptions

The Dashboard above the grid: whether it can float, custom toolbars and buttons, and where the module buttons sit.

Which toolbars are on each tab is stored in Dashboard state.

```ts title="TypeScript"
dashboardOptions?: DashboardOptions;
```

###### Property Value

[`DashboardOptions`](https://www.adaptabletools.com/docs/reference/dashboardoptions.md)

### dataChangeHistoryOptions

The log of cell value changes: whether it starts active, which changes are recorded, and the undo button.

```ts title="TypeScript"
dataChangeHistoryOptions?: DataChangeHistoryOptions<TData>;
```

###### Property Value

[`DataChangeHistoryOptions`](https://www.adaptabletools.com/docs/reference/datachangehistoryoptions.md)`<TData>`

### dataImportOptions

The import wizard: how a file or pasted text becomes rows, how those rows are validated, and how they are written into the grid.

```ts title="TypeScript"
dataImportOptions?: DataImportOptions;
```

###### Property Value

[`DataImportOptions`](https://www.adaptabletools.com/docs/reference/dataimportoptions.md)

### dataSetOptions

Named sets of rows the user can switch between. Each set supplies its own data.

```ts title="TypeScript"
dataSetOptions?: DataSetOptions<TData>;
```

###### Property Value

[`DataSetOptions`](https://www.adaptabletools.com/docs/reference/datasetoptions.md)`<TData>`

### editOptions

Cell editing: which cells can be edited, server-side validation, the values offered in a dropdown editor, Plus Minus nudges and Smart Edit.

```ts title="TypeScript"
editOptions?: EditOptions<TData>;
```

###### Property Value

[`EditOptions`](https://www.adaptabletools.com/docs/reference/editoptions.md)`<TData>`

### entitlementOptions

Which modules a user may see or change. `Full`, `ReadOnly` or `Hidden`, per module or as a default.

A module that defaults to hidden (such as State) stays hidden until `moduleEntitlements` allows it.

```ts title="TypeScript"
entitlementOptions?: EntitlementOptions;
```

###### Property Value

[`EntitlementOptions`](https://www.adaptabletools.com/docs/reference/entitlementoptions.md)

### exportOptions

Reports: which system reports, formats and destinations are offered, custom destinations, and whether a column is included.

Report definitions the user creates are stored in Export state.

```ts title="TypeScript"
exportOptions?: ExportOptions<TData>;
```

###### Property Value

[`ExportOptions`](https://www.adaptabletools.com/docs/reference/exportoptions.md)`<TData>`

### expressionOptions

AdapTableQL: custom functions, which columns and fields an expression may use, case sensitivity, and how the expression editor is presented.

Expressions saved on objects (a filter, an alert rule, a calculated column) live on those objects. These options change how every expression is evaluated and edited.

```ts title="TypeScript"
expressionOptions?: ExpressionOptions<TData>;
```

###### Property Value

[`ExpressionOptions`](https://www.adaptabletools.com/docs/reference/expressionoptions.md)`<TData>`

### fdc3Options

FDC3: which intents and contexts this grid raises, listens for and broadcasts, and how a row&#39;s columns map onto an FDC3 context.

```ts title="TypeScript"
fdc3Options?: Fdc3Options;
```

###### Property Value

[`Fdc3Options`](https://www.adaptabletools.com/docs/reference/fdc3options.md)

### filterOptions

Column Filters and the Grid Filter: whether AdapTable&#39;s filters are used instead of AG Grid&#39;s, the quick filter bar, and the default operator for each data type.

The filters the user creates are stored in the Layout.

```ts title="TypeScript"
filterOptions?: FilterOptions<TData>;
```

###### Property Value

[`FilterOptions`](https://www.adaptabletools.com/docs/reference/filteroptions.md)`<TData>`

### flashingCellOptions

Defaults for a flashing cell when a Flashing Cell definition does not set them: up, down and neutral styles, whether the cell or the row flashes, and for how long.

The definitions themselves belong in Initial State.

```ts title="TypeScript"
flashingCellOptions?: FlashingCellOptions;
```

###### Property Value

[`FlashingCellOptions`](https://www.adaptabletools.com/docs/reference/flashingcelloptions.md)

### formatColumnOptions

Display formatters beyond the ones AdapTable ships, used by Format Columns.

The Format Column objects (which column, which style and format) belong in Initial State.

```ts title="TypeScript"
formatColumnOptions?: FormatColumnOptions;
```

###### Property Value

[`FormatColumnOptions`](https://www.adaptabletools.com/docs/reference/formatcolumnoptions.md)

### initialState

Objects shipped with the grid for its first run: at least one Layout, plus any Alerts, Format Columns, Calculated Columns and other module objects.

Applied only when no state is already stored for this grid. After that, the stored state is used and later edits to `initialState` are ignored until that stored state is cleared or the state key changes.

```ts title="TypeScript"
initialState: InitialState;
```

###### Default Value

undefined

###### Property Value

[`InitialState`](https://www.adaptabletools.com/docs/reference/initialstate.md)

### layoutOptions

How Layouts are created and shown: a layout built from the AG Grid column definitions, defaults for a new Table or Pivot Layout, and whether layout extensions are offered in the UI.

The Layout objects belong in Initial State. A grid needs at least one.

```ts title="TypeScript"
layoutOptions?: LayoutOptions<TData>;
```

###### Property Value

[`LayoutOptions`](https://www.adaptabletools.com/docs/reference/layoutoptions.md)`<TData>`

### licenseKey

Commercial licence key.

Without a current licence, AdapTable shows licence notices and limits some functionality.

```ts title="TypeScript"
licenseKey?: string;
```

###### Property Value

`string`

### noteOptions

Notes on cells: which cells can hold a note, the note type applied on creation, and how the timestamp is formatted.

The notes themselves are stored in Note state.

```ts title="TypeScript"
noteOptions?: NoteOptions;
```

###### Property Value

[`NoteOptions`](https://www.adaptabletools.com/docs/reference/noteoptions.md)

### notificationsOptions

Toasts: where they appear, how long they stay, and how many system status messages are kept.

```ts title="TypeScript"
notificationsOptions?: NotificationsOptions;
```

###### Property Value

[`NotificationsOptions`](https://www.adaptabletools.com/docs/reference/notificationsoptions.md)

### plugins

Plugins constructed by the application and handed to AdapTable: OpenFin, ipushpull, interop.io and Master-Detail.

Each plugin is created with its own options. This array registers them.

```ts title="TypeScript"
plugins?: AdaptablePlugin[];
```

###### Property Value

[`AdaptablePlugin`](https://www.adaptabletools.com/docs/reference/adaptableplugin.md)`[]`

### primaryKey

Column whose values uniquely identify a row. Required.

AdapTable uses it to find a row for edits, notes, comments, alerts, history and row forms. The values must be unique.

```ts title="TypeScript"
primaryKey: string;
```

###### Default Value

n/a (Mandatory)

###### Property Value

`string`

### quickSearchOptions

Quick Search: which cells are searched, whether matching rows are filtered, and whether the search is case sensitive.

```ts title="TypeScript"
quickSearchOptions?: QuickSearchOptions<TData>;
```

###### Property Value

[`QuickSearchOptions`](https://www.adaptabletools.com/docs/reference/quicksearchoptions.md)`<TData>`

### rowFormOptions

Create, clone and edit forms for a row: which columns appear, how the primary key of a new row is set, and whether AdapTable writes the result into the grid.

```ts title="TypeScript"
rowFormOptions?: RowFormOptions<TData>;
```

###### Property Value

[`RowFormOptions`](https://www.adaptabletools.com/docs/reference/rowformoptions.md)`<TData>`

### settingsPanelOptions

The Settings Panel: its title and icon, which modules appear and in which groups, and whether it opens as a modal or a movable window.

```ts title="TypeScript"
settingsPanelOptions?: SettingsPanelOptions;
```

###### Property Value

[`SettingsPanelOptions`](https://www.adaptabletools.com/docs/reference/settingspaneloptions.md)

### stateOptions

Where state is loaded from and saved to. The default is `localStorage`.

Replace `loadState` and `persistState` to keep state on a server. `saveState` and `applyState` change the object just before it is stored or applied.

```ts title="TypeScript"
stateOptions?: StateOptions;
```

###### Property Value

[`StateOptions`](https://www.adaptabletools.com/docs/reference/stateoptions.md)

### teamSharingOptions

Sharing Adaptable Objects with other users. The application loads and saves the shared objects; AdapTable does not ship a server.

Turn it on with `enableTeamSharing`, then provide `loadSharedEntities` and `persistSharedEntities`.

```ts title="TypeScript"
teamSharingOptions?: TeamSharingOptions;
```

###### Property Value

[`TeamSharingOptions`](https://www.adaptabletools.com/docs/reference/teamsharingoptions.md)

### toolPanelOptions

The tool panel beside the grid: custom panels, custom buttons, and whether the panel dropdown is shown.

```ts title="TypeScript"
toolPanelOptions?: ToolPanelOptions;
```

###### Property Value

[`ToolPanelOptions`](https://www.adaptabletools.com/docs/reference/toolpaneloptions.md)

### userInterfaceOptions

Shared UI: the application icon, custom icons, editable and read-only cell styles, the colour picker, date inputs, the loading screen, and the names shown for modules.

```ts title="TypeScript"
userInterfaceOptions?: UserInterfaceOptions<TData>;
```

###### Property Value

[`UserInterfaceOptions`](https://www.adaptabletools.com/docs/reference/userinterfaceoptions.md)`<TData>`

### userName

Name of the person using this grid.

Stamped on Notes and Comments when the author is not supplied, and shown where Team Sharing records who shared an object.

```ts title="TypeScript"
userName?: string;
```

###### Default Value

&#39;anonymous&#39;

###### Property Value

`string`

### wizardOptions

Wizards and the other action popups (Bulk Update, Smart Edit, Cell Summary): modal or window, and the window&#39;s position and size.

Independent of the Settings Panel. Ignored when `containerOptions.modalContainer` places every popup in one element.

```ts title="TypeScript"
wizardOptions?: WizardOptions;
```

###### Property Value

[`WizardOptions`](https://www.adaptabletools.com/docs/reference/wizardoptions.md)
