AdapTable Types Reference
The full list of all public types available in AdapTable for AG Grid
| Name | Summary |
|---|---|
| AccessLevel | Whether an Entitlement is `ReadOnly`, `Hidden` or `Full` |
| ActionButtonCommand | Commands to assign to Action Buttons that open Row Forms: 'create', 'clone', 'edit' or 'delete' |
| ActionColumn | A Special Column that wraps an AdapTable Button |
| ActionColumnApi | Functions for accessing Action Columns |
| ActionColumnButton | Button that is displayed inside an Action Column |
| ActionColumnContext | Context required by functions when using an Action Column Button |
| ActionColumnDefaultConfiguration | Default configuration to use for an FDC3 Action Column |
| ActionColumnOptions | Options related to Action Columns in AdapTable |
| ActionColumnSettings | Set of optional properties that define an Action Columns behaviour |
| AdaptableAggregatedBooleanQuery | Wraps an AdapTableQL Aggregated Boolean Expression |
| AdaptableAggregatedScalarQuery | Wraps an AdapTableQL Aggregated Scalar Expression |
| AdaptableAlert | Defines an Alert fired by AdapTable |
| AdaptableAlertBase | Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change |
| AdaptableAlertCommand | Commands available in an Alert |
| AdaptableAlertQuery | Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression |
| AdaptableAlertType | Type of AdapTable Alert: generic, cellChange or rowChange |
| AdaptableApi | Provides developers with run-time access to AdapTable. Contains many classes each dedicated to a specific AdapTable Module or functionality |
| AdaptableBaseIcon | Base interface for AdaptableIcon |
| AdaptableBooleanQuery | Wraps an AdapTableQL Boolean Expression |
| AdaptableButton | Defines a Button that appears in numerous places including Adaptable Form |
| AdaptableCalculatedColumnQuery | Calculated Column Query which may be a Scalar or an AggregatedScalar Expression |
| AdaptableCellChangedAlert | Defines an Alert fired by AdapTable when a cell is changed |
| AdaptableClearStateFunction | Function that clears persisted state from the storage system. Only invoked during `StateApi.reloadInitialState()` operations. |
| AdaptableColumn | Defines an AdapTable Column - created at run-time based on AG Grid ColDef |
| AdaptableColumnBase | Base class for AdapTable Column containing most important properties |
| AdaptableColumnContext | Context provided for per Column callbacks |
| AdaptableColumnDataType | Defines data type of a Column; can be an AG Grid BaseCellDataType or an AdapTable array-related one |
| AdaptableColumnGroup | Defines a Column Group |
| AdaptableColumnMenuItem | Menu item used by Adaptable in Column Menus |
| AdaptableColumnMenuItemName | Name of Column Menu Item provided by AdapTable |
| AdaptableColumnPredicate | Restricts a Predicate to a given Column |
| AdaptableColumnsContext | Context provided for callbacks involving multiple Columns |
| AdaptableColumnSummary | Summary of a Column including filters and all unique values |
| AdaptableColumnTypeName | Column Types recognised by AdapTable; to be set in GridOptions |
| AdaptableComment | Comment that can be applied to a Cell in AdapTable |
| AdaptableComparerFunction | Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required |
| AdaptableConfig | Config used by No Code Plugin to set up AdapTable |
| AdaptableContainerValue | A resolved (non-function) container reference - `string` — an element ID (resolved via `document.getElementById`) - `AdaptableCSSSelector` — a CSS selector (resolved via `document.querySelector`) - `HTMLElement` — a direct reference to a DOM element |
| AdaptableContextMenuItem | Menu item used by Adaptable in Context Menus |
| AdaptableContextMenuItemName | Name of Context Menu Item provided by AdapTable |
| AdaptableCoordinate | Used by AdapTable to remember position of Floating Dashboard |
| AdaptableCSSSelector | CSS Selector used to target elements by CSS selectors (e.g. class, attribute, etc.) rather than elementID |
| AdaptableCustomIcon | Defines an icon from an external source |
| AdaptableDashboardToolbar | List of all the Toolbars that Adaptable provides |
| AdaptableDataChangeHistoryAction | Built in `undo` or `clear` data change action |
| AdaptableDateEditorParams | Params used by the AdapTable Date Editor |
| AdaptableElementIcon | Defines an icon as a provided DOM element or HTML string |
| AdaptableField | Used in Expressions to reference row values which are not a column definition |
| AdaptableFieldContext | Context used when providing Fields programatically |
| AdaptableFilterComponentLocation | AdapTable's Filter components: FilterBar or FilterForm |
| AdaptableFilterState | Current Filters in AdapTable |
| AdaptableFlashingCell | Defines an Alert fired by AdapTable |
| AdaptableForm | Defines a form which appears dynamically; used by Alerts & Export Custom Destinations |
| AdaptableFormat | Object containing formatting information for Numeric and Date Columns |
| AdaptableFormData | Data which appears in an AdapTable Form |
| AdaptableFormField | Defines a Field that appears in an Adaptable Form |
| AdaptableFormFieldType | Types of Controls used in an AdapTable Form |
| AdaptableFrameworkComponent | Base Component for Bespoke Components: can be Angular, React or Vue |
| AdaptableGenericAlert | Defines a generic AdapTable Alert |
| AdaptableIcon | Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.) |
| AdaptableLoadStateFunction | Function that retrieves Adaptable state from storage or external source. Called during initialization to hydrate the application state. |
| AdaptableLogger | AdapTable's Logger |
| AdaptableMenuItem | Generic Menu item used by Adaptable in Column or Context Menus |
| AdaptableMessageType | Defines a Message Types: 'Success', 'Info', 'Warning' or 'Error' |
| AdaptableModule | Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State |
| AdaptableModuleButton | List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button |
| AdaptableNoCodeWizardOptions | Adaptable Options used by the No Code Wizard |
| AdaptableNote | Note that can be applied to a Cell in AdapTable |
| AdaptableNotes | Collection of Cell Notes |
| AdaptableNumberCellEditorParams | Adaptable number editor parameters extending the AG Grid . |
| AdaptableObject | Base interface which all other Adaptable State-related objects extend |
| AdaptableObjectLookupCriteria | Lookup criteria for finding specific Adaptable Objects; all given criteria will be composed with an AND operator |
| AdaptableObjectTag | AdaptableObjectTag Object Tag - currently supporting only plain string values, but open for future extensions, if needed |
| AdaptableObservableQuery | Wraps an AdapTableQL Observable Expression |
| AdaptableOptions | Large group of options enabling developers to set up AdapTable at design time to fit precise requirements |
| AdaptablePercentageCellEditorParams | AdapTablePercentageCellEditor parameters - extends AdaptableNumberCellEditorParams |
| AdaptablePersistentState | The state object of Adaptable which is persisted |
| AdaptablePersistStateFunction | Function that handles persisting state to storage systems (localStorage, server, etc.). Called after `saveState()` to store the prepared state. |
| AdaptablePlugin | Base class for all AdapTable Plugins |
| AdaptablePredicate | Predicate object used by AdapTableQL - essentially a boolean function |
| AdaptablePredicateDef | Defines a Predicate - include where it can run and what it does |
| AdaptableQLModule | Modules which leverage AdapTableQL; can be used to set remote evaluation |
| AdaptableQuery | An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression |
| AdaptableReadyInfo | Object returned by `AdaptableReady` event - fired when AdapTable has loaded |
| AdaptableRowChangedAlert | Defines an Alert fired by AdapTable when a row is changed |
| AdaptableRowContext | Context provided for per Row callbacks |
| AdaptableSaveStateFunction | Function that transforms state before persistence. Called first in the persistence flow, before `persistState()`. |
| AdaptableScalarQuery | Wraps an AdapTableQL Scalar Expression |
| AdaptableSettingsPanel | Modules which can appear in the Settings Panel |
| AdaptableSharedEntity | Defines an AdaptableObject shared with Team Sharing |
| AdaptableSharedEntityConfig | Describes an AdaptableObject which is being Team Shared |
| AdaptableSortState | Overview of current, live, sorting state in grid |
| AdaptableState | The main state object of Adaptable |
| AdaptableStateChangedInfo | Object returned by the `AdaptableStateChanged` event |
| AdaptableStateFunctionConfig | State Function Config object passed into all State Options functions |
| AdaptableStateReloadedInfo | Object returned by the `AdaptableStateReloaded` event |
| AdaptableStatusBar | Defines an Adaptable Status Bar |
| AdaptableStatusBarPanel | Modules which can appear in the AdapTable Status Bar |
| AdaptableStyle | Style object used in numerous AdapTable Modules |
| AdaptableSystemColumnMenuItem | System Menu Item that is provided by AdapTable |
| AdaptableSystemContextMenuItem | System Menu Item that is provided by AdapTable |
| AdaptableSystemIcon | Defines an icon from the System AdapTable icon set |
| AdaptableSystemIconName | All AdapTable System Icon names |
| AdaptableTheme | Used for creating User (i.e. Custom) Themes |
| AdaptableToolPanel | Modules which can appear as AdapTable Tool Panels |
| AdaptableToolPanelDefinition | Defines a ToolPanel - Name and VisibilityMode (Expanded / Collapsed) |
| AdaptableTransientState | The state which is available in the internal Redux store but never persisted |
| AdaptableVersion | The current version of AdapTable being used |
| AggregatedBooleanFunctionName | List of all the Aggregation Functions available in AdaptableQL |
| AggregatedExpressionFilterRowContext | Context used when applying a filter to Rows before Reducer is called |
| AggregatedExpressionFunction | Defines an AdapTableQL function that aggregates data |
| AggregatedExpressionPrepareRowValueContext | Context used by prepareRowValue property in Aggregated Expressions |
| AggregatedExpressionProcessAggValueContext | Context used by processAggregatedValue property in Aggregated Expressions |
| AggregatedExpressionReducerContext | Context used by the reducer property in Aggregated Expressions |
| AggregatedScalarFunctionName | List of all the AggregatedScalar Functions available in AdaptableQL |
| AgGridColumnMenuItemType | Defines AG Grid Column Menu Items |
| AgGridConfig | Contains AG Grid Options and Modules - used when instantiating AdapTable vanilla |
| AgGridContextMenuItemType | Defines AG Grid Context Menu Items |
| AgGridMenuItem | Menu Item that is provided by AG Grid |
| AlertApi | Provides run-time access to Alert function and associated State |
| AlertButton | Defines a button that appears in an Alert Form |
| AlertButtonForm | Form triggered by an Alert which contains only Buttons |
| AlertDefinition | The Alert Definition object used in the Alert function |
| AlertDefinitionPredicate | Predicate used when creating a Predicate-based Rule for an Alert |
| AlertFiredInfo | Object returned by the `AlertFired` event |
| AlertForm | Form to show in an Alert |
| AlertFormContext | Context required by functions when using an Alert Button |
| AlertMessageContext | Context used for creating bespoke Alert messages |
| AlertOptions | Options related to Alerts in Adaptable. |
| AlertProperties | Additional properties that specify how a particular Alert will ALWAYS behave |
| AlertRule | The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery |
| AlertState | Adaptable State section for Alert Module |
| AlternativeModuleName | Defines a new name for an Adaptable Module (e.g. change Dashboard to Grid Manager) |
| AngularFrameworkComponent | Angular component defined by its type and (optional) initialisation callback |
| ApplicationApi | Provides run-time access to the Application Module |
| ApplicationDataEntry | Simple Key / Value pair object used to store custom - stringifiable - data in Adaptable State. |
| ApplicationState | Adaptable State Section for the Application Module |
| ApplyFilterAction | When to apply a Filter: 'Always', 'Never' or 'Throttle' |
| AST_Expression | Defines AST of an Expressoin |
| AST_Function | Defines AST of an Expression Function |
| AST | An AST Expression |
| AutoGenerateTagsForLayoutsContext | Context for `LayoutOptions.autoGenerateTagsForLayouts` method |
| AutoGroupColumnHeaderContext | Context for Columns created automatically by AG Grid when Row Grouping |
| BadgeStyle | Collection of Badge Style Definitions to display in a Badge Styled Column |
| BadgeStyleDefinition | Defines a Badge Style |
| BadgeStylePredicate | System Predicate definition for Badge Style |
| BaseColumnHeaderContext | Common properties for Column Header Context |
| BaseContext | Base class for all AdapTable callbacks and Events |
| BaseExportContext | Context information available in all Export-related functions |
| BaseState | Base Interface for all Adaptable State objects; contains`Revision` property, used for versioning |
| BooleanFunctionName | List of all the Boolean Functions available in AdaptableQL |
| BroadcastConfig | Config used when broadcasting FDC3 Context |
| BroadcastConfiguration | Defines config options for Broadcasting FDC3 Context |
| BulkUpdateApi | Provides run-time access to the Bulk Update Module |
| ButtonStyle | Defines the look and feel of an Adaptable Button |
| CalculatedColumn | Defines a Column where the display value is derived from other values in row, and the definition is stored in State. |
| CalculatedColumnApi | Provides run-time access to the Calculated Column Module |
| CalculatedColumnChangedInfo | EventInfo returned by CalculatedColumnChanged event |
| CalculatedColumnSettings | Set properties that define Calculated Column's behaviour (all optional except DataType) |
| CalculatedColumnState | Adaptable State Section for Calculated Column Module |
| CalendarApi | Calendar, Holiday and Working Day related functions, using supplied Holidays in Holiday Options |
| CalendarOptions | Options for managing Holidays and Working Days in AdapTable |
| CellAddress | Very lightweight object to define an AdapTable Cell |
| CellChangedInfo | EventInfo returned by CellChanged event |
| CellColorRange | Defines which Colours to show in Gradient and Percent Bar Styles |
| CellDataChangedInfo | Defines a Cell Edit - includes full details of old and new values, the column and the enclosing Row |
| CellEditableContext | Context used when checking Cell editability |
| CellHighlightInfo | Defines how a given Cell in AdapTable should be highlighted |
| CellSelectionChangedInfo | Event Info published by CellSelectionChanged event |
| CellSummaryApi | Provides run-time access to the Cell Summary Module |
| CellSummaryOptions | Options to provide custom Cell Summary Operations & Display Formats |
| CellSummmaryInfo | Defines the Summary operations which AdapTable provides for Selected Numeric Cells |
| CellTextOption | Text optionally to show in a Special Column Style special style: 'CellValue' or 'PercentageValue' |
| CellTextOptions | Array of CellTextOption available in Special Column Styles |
| CellUpdateRequest | Lightweight object used for identifying a Cell to be updated |
| ChartChangedInfo | Info used in Chart Changed Event |
| ChartContainer | Describes Location to display an AG Grid Chart |
| ChartDefinition | Wraps an AG Grid Chart Model |
| ChartDisplayedInfo | Defines a Displayed Chart |
| ChartingAggFunc | Aggregation function used in the Chart |
| ChartingApi | Provides run-time access to Charting Module and related State |
| ChartingOpenState | Currently opened Charts |
| ChartingOptions | Options for managing AG Grid's Charts |
| ChartingState | Persists AG Grid Charts in Adaptable State |
| ColDefWithId | AG Grid Column Definition with a mandatory `colId` property |
| ColumnApi | Provides run-time access to AdapTable Column related features |
| ColumnBooleanFalseMap | Defines a map of Columns with a Boolean value |
| ColumnComparison | Enables a Percent Bar or Gradient Style to use another column in its calculations |
| ColumnDirectionMap | Defines a map of Columns with a Left / Right direction value |
| ColumnFilter | Defines a Filter applied on a Column using a Predicate |
| ColumnFilterApi | Provides run-time access to Filter section of Adaptable State. |
| ColumnFilterAppliedInfo | EventInfo returned by the Column Filter Applied event |
| ColumnFilterDef | Column Filter Definition for a specific Column |
| ColumnFilterOptions | Options for managing Column Filtering in AdapTable |
| ColumnFilterPredicate | A Predicate used in Column Filtering |
| ColumnFriendlyNameContext | Context used when setting a Column Friendly Name |
| ColumnGroupScope | Defines Column Group Scope |
| ColumnGroupValues | Manages Column Group expand / collapse behaviour, including exceptions |
| ColumnGroupValuesWithExceptionKeys | Defines which Column Groups are expanded or collapsed |
| ColumnHeaderContext | Context provided to columnHeader function custom Headers to be provided for any type of AG Grid Column |
| ColumnMenuApi | Provides run-time access to Column Menu |
| ColumnMenuContext | Provides full details about the Column in which the Column Menu will appear |
| ColumnMenuOptions | Options for managing menus in AdapTable – provided using 2 collections |
| ColumnNumberMap | Defines a map of Columns with a Number value |
| ColumnOptions | Options related to managing Columns in Adaptable. |
| ColumnScope | Defines where a given Object / Module is active |
| ColumnScopeApi | Provides access to a suite of functions related to the `Column Scope` object |
| ColumnSizingDefinition | State & behaviour for column sizing (must set `width` or `flex` but not both); all other props optional |
| ColumnSizingMap | Defines a map of Columns with Sizing information |
| ColumnSort | Defines how a Column is sorted |
| ColumnStringMap | Defines a map of Columns with a String value |
| ColumnTypesContext | Context used when retrieving Column Types |
| ColumnValuesComparer | Comparer object for Column Values - used for custom sorting |
| CommandHandler | Handles an Alert Form Command |
| CommentableCellContext | Context used when determining if a cell can show Comments |
| CommentApi | Provides run-time access to Comment Module and related State |
| CommentChangedInfo | Event fired when a Comment has changed |
| CommentLoadContext | Context used when loading Comments |
| CommentOptions | Options for managing Comments and Comment Threads in AdapTable |
| CommentState | Internal State used for Comments Module |
| CommentThread | Thread of Comments for an Adaptable Cell |
| ContainerContext | Context available to `modalContainer`, `systemStatusContainer`, `alertContainer` and `transposedViewContainer` function callbacks |
| ContainerOptions | Options for managing the different div elements required by AdapTable |
| ContextMenuApi | Provides run-time access to Context Menu |
| ContextMenuContext | Provides full details about current cell (and selected cells) where the Context Menu will appear |
| ContextMenuOptions | Options for managing menus in AdapTable – provided using 2 collections |
| CreatedRowInfo | Info passed into RowFormSubmitted Event for Created Rows |
| CreateRowFormContext | Context used in a Create Row Form |
| CustomCellSummaryOperation | Defines a Custom Cell Summary operation provided by a user |
| CustomCellSummaryOperationContext | Context provided to a custom Cell Summary Operation function |
| CustomColumnMenuContext | Context info provided when building Custom Column Menus |
| CustomColumnMenuItem | Custom Column Menu Item |
| CustomContextMenuContext | Context info provided when building Custom Context Menus |
| CustomContextMenuItem | Custom Context Menu Item |
| CustomDestination | Defines a custom Export destination |
| CustomDestinationsContext | Context provided to `ExportOptions.customDestinations` callback |
| CustomDisplayFormatter | Defines a Custom Display Format |
| CustomDisplayFormatterContext | Context used in handler of CustomDisplayFormatter |
| CustomEditColumnValueInfo | Information about items in the custom Edit Controls |
| CustomEditColumnValuesContext | Context used when getting Distinct Column Values for Editing |
| CustomExportParams | Custom Export Params extending AG Grid's base export params; allows overriding AdapTable default export |
| CustomGroupColumnMenuItem | Defines a Grouped Menu Item in the Column Menu |
| CustomGroupContextMenuItem | Defines a Grouped Menu Item in the Context Menu |
| CustomIcon | Defines a bespoke Icon provided by a developer |
| CustomInFilterValuesContext | Context used when providing values for the IN Column Filter |
| CustomQueryVariableContext | Context passed when evaluating customQueryVariables |
| CustomRenderContext | Context provided for any custom rendering |
| CustomRenderFunction | Function which is called when rendering/destroying a custom framework-agnostic component |
| CustomSettingsPanel | Definition of a Custom Panel to add to the Adaptable Settings Panel |
| CustomSharedEntity | Defines a Custom object that will be shared using Team Sharing |
| CustomSharedEntityConfig | Describes a custom Object which is being Team Shared |
| CustomSort | Custom Sort object used in Custom Sort function. |
| CustomSortApi | Provides run-time access to the Custom Sort function |
| CustomSortOptions | Used to provide Custom Sorts comparers |
| CustomSortState | Adaptable State Section for Custom Sort Module |
| CustomToolbar | Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content |
| CustomToolbarButtonContext | Context required by functions when using a Custom Toolbar Button |
| CustomToolbarConfiguredInfo | EventInfo returned by the CustomToolbarConfigured event |
| CustomToolPanel | Defines a Custom ToolPanel - provided by Users and contains custom content |
| CustomToolPanelButtonContext | Context used for Custom Tool Panels containing Buttons |
| CustomWindowConfig | Config used to open a Custom Window |
| DashboardApi | Functions relating to the AdapTable Dashboard. |
| DashboardButtonContext | Context required by functions when using a Dashboard Button |
| DashboardButtonsLocation | Where Dashboard Buttons are displayed |
| DashboardChangedInfo | Object returned by the `DashboardChanged` event |
| DashboardOptions | Options related to the Dashboard in Adaptable. |
| DashboardState | Adaptable State Section for the AdapTable Dashboard |
| DashboardTab | Defines a named set of Toolbars in the AdapTable Dashboard |
| DataChangeDetectionPolicy | Cell Change that will trigger an Alert: can be 'rawValue' or 'formattedValue' |
| DataChangedScope | Defines where a Data Change should be monitored |
| DataChangeHistoryApi | Provides run-time access to the Data Change History Module |
| DataChangeHistoryButton | A custom AdaptableButton which provides a build in `undo` action |
| DataChangeHistoryContext | The context for the DataChangeHistoryButton |
| DataChangeHistoryOptions | Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes |
| DataFormatDataType | Defines the Format Data Types for all Data Types |
| DataFormatType | Format of exported Data - 'rawValue' or 'formattedValue' |
| DataImportApi | Provides run-time access to the Settings Panel |
| DataImportedInfo | Object returned by the `DataImported` event |
| DataImportFileHandler | Files that can be handled by Data Import |
| DataImportOptions | Options for managing the Data Import function |
| DataImportValidateContext | Context passed to the `validate` function |
| DataImportValidationError | Defines a Validation Error |
| DataRowConfig | Config object using for passing in rows to manageGridData function |
| DataSet | Defines a Data Set object that can provide data to AdapTable |
| DataSetApi | Provides run-time access to Data Sets |
| DataSetFormContext | Used when a DataSet displays a Form |
| DataSetOptions | Options to provide Data Sets |
| DataSetSelectedInfo | Object returned by the `DataSetSelected` event |
| DataUpdateConfig | Object used to configure GridApi row management methods |
| DateFormatterOptions | Formatter Options for Date Columns - contains a single `Pattern` property |
| DateInputOptions | Options for managing and customizing the date inputs. |
| DefaultAccessLevelContext | Provided to defaultAccessLevel function when setting Default Entitlement value programatically |
| DefaultAdaptableMenuStructure | The Context Menu provided by AadapTable by default |
| DefaultAgGridMenuStructure | AG Grid section of Context Menu provided by AadapTable by default |
| DefaultPredicateFilterContext | Context used for setting default Predicates for Column Filters |
| DeletedRowInfo | Info passed into RowFormSubmitted Event for Deleted Rows |
| DestroyConfig | Adaptable Destroy Configuration |
| DetailInitContext | Context passed to Detail Grids when using Master Detail Plugin |
| EditColumnValueInfo | Information about items in the Edit Controls |
| EditedRowInfo | Info passed into RowFormSubmitted Event for Edited Rows |
| EditOptions | Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Cell Editabiility |
| EditRowFormContext | Context used in an Edit Row Form |
| Entitlement | Defines a Permission in AdapTable - Module and Access Level |
| EntitlementApi | Provides functions for Entitlements and Permissions |
| EntitlementContext | Provided to moduleEntitlements function when setting Entitlements programatically |
| EntitlementOptions | Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as *Full*, *ReadOnly* or *Hidden*. |
| EvaluateExpressionExternallyContext | Context passed when evaluating `expressionOptions.evaluateExpressionExternally()` |
| EventApi | Responsible for publishing the many Events that AdapTable fires |
| ExportApi | Provides run-time access to the Export Module and Report state |
| ExportConfig | Config used when Exporting via API, allows fine grained exporting |
| ExportDataFormatContext | Context provided to `ExportOptions.exportDataFormat` callback |
| ExportDateFormatContext | Context provided to `ExportOptions.exportDateFormat` callback |
| ExportDestinationType | Configures which destination Reports get exported to |
| ExportFormContext | Context required by functions when using an Export Button |
| ExportOptions | Options regarding Exporting data from AdapTable |
| ExportResultData | Type of Export result data: string (CSV), ReportData (JSON), or Blob (Excel) |
| ExportState | Adaptable State Section for Export Module |
| ExpressionApi | Functions related to Expressions in AdapTableQL (the Adaptable Query Language) |
| ExpressionCategory | Categories for Expression Functions |
| ExpressionContext | Provides context to an Expression Function, including current row node and AdaptableApi |
| ExpressionFunction | Defines an AdaptableQL Function used in an Adaptable Expression |
| ExpressionFunctionDocBlock | Defines how an AdaptableQL Function is described in Expression Editor |
| ExpressionFunctionHandler | The javascript function which is invoked by an AdaptableQL Function |
| ExpressionFunctionInputType | Data Types of Inputs used by Expression (test, number, date, boolean) |
| ExpressionFunctionMap | Key-Value map of Expression Names and their implementation |
| ExpressionOptions | Options for managing Expressions in AdapTable's Query Language |
| ExtendedLayout | Defines an Extended Layout - provides a Layout and all objects that refer to it |
| ExternalChartingContext | Context passed to External Charting Options functions |
| ExternalChartingOptions | Options for managing External (i.e. non AG Grid) Charts |
| FDC3ActionColumn | Action Column used for FDC3 workflows |
| Fdc3AdaptableButton | Button used in FDC3 Action Columns |
| Fdc3Api | Provides run-time access to AdapTable's FDC3 functionality |
| Fdc3ButtonContext | Context provided in dynamic FDC3 Buttons |
| Fdc3ContextOptions | Options for configuring FDC3 Context Behaviour in AdapTable |
| Fdc3IntentOptions | Options for configuring FDC3 Intent Behaviour in AdapTable |
| Fdc3MessageInfo | EventInfo returned by FDC3 Message events |
| Fdc3MessageReceivedInfo | Event Info for FDC3 Received Message Event |
| Fdc3MessageSentInfo | Event Info for FDC3 Sent Message Event |
| Fdc3Options | Options for configuring FDC3 in AdapTable |
| FilterActionOnDataChange | Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set |
| FilterApi | Provides run-time access to Filtering in AdapTable |
| FilterOptions | Options for managing Column & Grid Filters in AdapTable |
| FlashingCellApi | Provides run-time access to Flashing Cell functionality and associated State |
| FlashingCellDefinition | The Flashing Cell Definition |
| FlashingCellDisplayedInfo | Object returned by the `FlashingCellDisplayed` event |
| FlashingCellOptions | Properties for Flashing Cell |
| FlashingCellState | Adaptable State Section for Flashing Cell module |
| FlashTarget | Where a Flash can happen |
| FormatColumn | Object used in Format Column function |
| FormatColumnApi | Provides run-time access to the Format Column Module and associated state |
| FormatColumnConfig | Config for api methods that get Format Columns |
| FormatColumnOptions | Provides Custom Formats used in Format Column Module |
| FormatColumnPredicate | Predicate used when creating a Format Column |
| FormatColumnRule | The Format Column Rule - can be either a Predicate or a BooleanExpression |
| FormatColumnState | Adaptable State Section for Format Column Module |
| FormatColumnTarget | Specifies whether Column's cells or header is formatted |
| FormContext | Context supplied to Buttons that appear in an Adaptable Form |
| FreeTextColumn | The FreeTextColumn object used in the Free Text Column function |
| FreeTextColumnApi | Provides run-time access to FreeTextColumn Module and associated state |
| FreeTextColumnSettings | Set of optional properties that define a FreeText Columns behaviour |
| FreeTextColumnState | Adaptable State Section for the Free Text Column Module |
| FreeTextStoredValue | Defines a cell value stored in a Free Text Column |
| GetDetailRowsContext | Context provided to `ExportOptions.getDetailRows()` callback used when exporting Detail Rows |
| GetPrimaryKeyValueContext | Context passed to the `getPrimaryKeyValue` function |
| GlobalExpressionFunctionsContext | Context provided to global expression functions properties property callback |
| GradientStyle | Used to display Gradient Styles in Special Column Style |
| GridApi | Provides access to important properties and functionalities of AdapTable e.g. sorting, selected cells etc. |
| GridCell | Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value |
| GridCellRange | Defines a range of Cell - used in Grid Api Selection methods Typically use either PrimaryKey Values or Row Indexes |
| GridCellWithCount | Extended GridCell, props to show how often appears in data source and how often visible |
| GridDataContextMapping | Mapping of FDC3 Context Types to Grid Data/Columns |
| GridFilter | Defines a Grid Filter (essentially a Boolean Expression) |
| GridFilterApi | Provides run-time access to Grid Filter section of Adaptable State. |
| GridFilterAppliedInfo | EventInfo returned by the GridFilterApplied event |
| GridFilterEditors | List of Editors that can be used when creating the Grid Filter |
| GridFilterOptions | Options for managing the Grid Filter in AdapTable |
| GridRow | Detailed information about a Row in AdapTable |
| GridSortedInfo | EventInfo returned by GridSorted event |
| GroupKeys | Enables setting Row Group behaviour with exceptions |
| HandleFdc3Context | Context used when handling incoming FDC3 messages |
| HandleFdc3IntentContext | Context used when handling incoming FDC3 Intents |
| HandleFdc3IntentResolutionContext | Context provided in `handleIntentResolution` callback |
| HandleImportedDataContext | Context used when importing Data |
| HandleImportedDataResolution | Resolution returned by the `handleImportedData` function |
| IAdaptableNoCodeWizard | When you want to configure an Adaptable via json file D&D, use this instead of the normal Adaptable constructor |
| Identifiable | Interface for objects that can be uniquely identified by a UUID |
| InFilterValue | Item in the IN Column Filter |
| InFilterValueInfo | Information about items in the IN Column Filter |
| InFilterValueResult | Result when providing custom values for the IN Column Filter |
| InitContainerContext | Context available to `adaptableContainer` and `agGridContainer` function callbacks (resolve **before** AdapTable initialises, so `adaptableApi` not available) |
| InitialState | The initial state of Adaptable which is populated at design-time and used to create the Adaptable State - must include at least one Layout. |
| InteropioPluginApi | Provides run-time access to the Interopio Plugin |
| InteropioPluginOptions | Options for using the Interop plugin |
| IPushPullApi | Provides run-time access to ipushpull Plugin |
| IPushPullDomain | Internal object that maps an IPushPull Domain object |
| IPushPullPluginOptions | Options available in ipushpull plugin; allows users to collborate and share data in powerful ways |
| IPushPullReport | An ipushpull report |
| IPushPullSchedule | Defines an ipushpull Schedule |
| IPushPullState | Internal State used by AdapTable for managing the ipushpull plugin |
| IsRowFilterableContext | Context used for setting whether a Row can be Column Filtered |
| Layout | Base Layout Type - Pivot or Table |
| LayoutApi | Provides run-time access to the Layout Module and associated state |
| LayoutArray | Array of Layouts - must contain at least one item |
| LayoutBase | Base object for both Table and Pivot Layouts |
| LayoutChangedAction | Trigger for Layout Changed Event |
| LayoutChangedInfo | EventInfo returned by LayoutChanged event |
| LayoutCreationDefaultProperties | Default properties to apply when creating a new Layout (Table or Pivot) |
| LayoutCreationDefaultPropertiesContext | Context for `LayoutOptions.layoutCreationDefaultProperties` function |
| LayoutExtendedConfig | Configuration for API methods which load objects that can be Layout extensions |
| LayoutExtendedContext | Context for `LayoutOptions.isObjectExtendedInLayout` function |
| LayoutExtension | Defines an object being extended in a Layout |
| LayoutExtensionModule | Modules which can provide objects in Extended Layouts |
| LayoutExtensionObject | Types of Adaptable Objects that can added to Extended Layouts |
| LayoutOptions | Options for configuring Layouts; manage Column visibility, order, sorting, grouping, width etc. |
| LayoutState | Adaptable State Section for Layout Module, containing collection of Layouts and name of Current Layout |
| LayoutTagOptions | Options for managing Tags in Layouts (used to enhance Layouts) |
| LayoutViewOptions | Customize how Layouts are displayed in Settings Panel |
| LiveDataChangedInfo | EventInfo returned by LiveDataChanged event |
| LiveReport | Defines which Adaptable Reports are 'Live' (i.e. will update the destination as data in Adaptable ticks or changes) |
| LoadingScreenOptions | Options for the Loading Screen shown when AdapTable is initialising |
| MasterDetailPluginOptions | Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument. |
| MenuCategory | Defines the Category of for a Menu Item |
| MenuSeparator | A separator to add to Column or Context Menu |
| ModuleExpressionFunctions | Type specific Expression Functions |
| ModuleExpressionFunctionsContext | Context provided to moduleExpressionFunctions property callback |
| ModuleExpressionFunctionsMap | Module specific Expression Functions |
| NamedQuery | Defines a Query which can be referenced in AdaptableQL Expressions |
| NamedQueryApi | Provides run-time access to Named Queries |
| NamedQueryState | Adaptable State Section for Named Query Module |
| NotableCellContext | Context used when determining if a Note can be added to a Cell |
| NoteApi | Provides run-time access to Notes Module and related State |
| NoteOptions | Options for managing AdapTable Notes |
| NoteState | Adaptable State Section for Note Module |
| NotificationsOptions | Options related to System Status Messages and Notifications in Adaptable. |
| NumberFormatterOptions | Formatter Options for Numeric Columns |
| NumericStyledColumn | Base type for Numeric Styled Columns (i.e. Gradient and Percent Bar) |
| ObjectTagsContext | Context used when evaluating Object Tags |
| ObservableFunctionName | List of all the Observable Functions available in AdaptableQL |
| OpenFinApi | Provides run-time access to the OpenFin Plugin |
| OpenFinPluginOptions | Options required for when using the OpenFin plugin |
| OpenFinReport | An OpenFin report |
| OpenFinSchedule | Defines a OpenFin Schedule - used in Schedule Module |
| OpenFinState | Internal State used by AdapTable for managing the OpenFin plugin |
| OptionsApi | Range of functions to access Adaptable Options |
| PercentBarStyle | Style used to display Percent Bars in Special Column Style |
| PivotAggregationColumns | Defines an Aggregated Column in a Pivot Layout |
| PivotAggregationTotalHeaderContext | Context for Pivot Aggregation Totals |
| PivotColumnGroupHeaderContext | Context for Pivot Column Groups |
| PivotColumnTotalHeaderContext | Context for Pivot Total Columns |
| PivotGrandTotalHeaderContext | Context for Pivot Grand Total Columns |
| PivotLayout | Defines a Pivot-based Layout |
| PivotLayoutCreationDefaultProperties | Default properties to apply when creating a new Pivot Layout |
| PivotPreviewColumnsContext | Context uses for pivotPreviewColumns function in Layout Options |
| PivotResultColumnHeaderContext | Context for Pivot Result Columns |
| PivotTotalPosition | Defines the position of Pivot Total position - 'before' or 'after' the Value Column(s) |
| PluginsApi | API methods dealing with AdapTable plugins |
| PlusMinusApi | Provides run-time access to the Plus / Minus Module and associated state |
| PlusMinusNudge | Defines a Plus Minus Rule - used in the Plus Minus Module |
| PlusMinusState | Adaptable State Section for Plus Minus Module |
| PopupType | Type of Popup |
| PredefinedConfig | Deprecated initial state object (now replaced by InitialState) |
| PredicateApi | Functions which manage the Predicate object in AdapTable |
| PredicateDefHandlerContext | Object passed into an Adaptable Predicate Definition |
| PredicateDefInput | Defines an Input to a Predicate |
| PredicateDefToStringParams | Inputs required for a Predicate |
| PredicateModuleScope | Defines which Modules use the Predicate |
| PredicateOptions | Options for managing Adaptable Predicates using AdaptableQL |
| PredicatesOperator | Logic used to join multiple Predicates |
| PreprocessRowDataContext | Context used when pre-processing Import Data |
| ProcessExportContext | Context used by the processExport function |
| ProgressIndicatorConfig | Config when displaying a Progress Indicator |
| QueryableColumnContext | Context passed when evaluating Queryable Columns |
| QuickSearchApi | Provides run-time access to Quick Search Module |
| QuickSearchContext | Context used when applying Quick Search in bespoke fashion |
| QuickSearchOptions | Options for configuring Quick Search |
| QuickSearchState | Adaptable State Section for Quick Search Module |
| RaiseIntentConfig | Config used when raising an FDC3 Intent |
| RaiseIntentConfiguration | Defines config options for Raising FDC3 Intents |
| RangeValueType | Whether the Range is Number or Percent based |
| ReactFrameworkComponent | A function that returns a ReactNode |
| ReminderSchedule | Schedules a Reminder to appear at a given point in time |
| Report | A Report which can export data from AdapTable |
| ReportColumn | A Column exported in a Report |
| ReportColumnScope | Columns to be included in a Report |
| ReportContext | Report Context sent when using Custom Export Destinations |
| ReportData | Defines the data in a Report run by AdapTable |
| ReportFileNameContext | Context used for providing a custom filename for a Report |
| ReportFormatType | Type of Report Format |
| ReportNameType | Type of Report Name |
| ReportRowScope | AG Grid Row Data to be included in a Report |
| ReportSchedule | Defines a Scheduled Report - used in Schedule Module (where State is stored) |
| ResolveContextDataContext | Used to build Context Data |
| RowChangedInfo | EventInfo returned by the RowChanged event |
| RowDataChangedInfo | Info for RowDataChangedEvent, which rows changed and why |
| RowDataChangeTrigger | What row action triggered the Row Change: 'Add', 'Update', 'Delete' or 'Load' |
| RowFormApi | Functions for accessing Action Columns |
| RowFormColumnContext | Context used when decided if column should be included in a Row Form |
| RowFormContext | Context passed into a Row Form - can be `CreateRowFormContext` or `EditRowFormContext` |
| RowFormFieldContext | Context used for overriding Field elements in Row Form |
| RowFormOptions | Options related to Dynamic Row Forms in AdapTable |
| RowFormSubmittedInfo | Info passed into RowFormSubmitted Event - can be `CreatedRowInfo`, `EditedRowInfo` or `DeletedRowInfo` |
| RowFormTitleContext | Context used for overriding Title and Description of Row Form |
| RowFormType | Type of RowForm: 'rowCreated' | 'rowEdited' | 'rowDeleted' |
| RowGroupColumnHeaderContext | Context for Columns created when Row Grouping |
| RowGroupValues | Manages Row Group expand / collapse behaviour, including exceptions |
| RowGroupValuesWithExceptionKeys | Defines which Row Groups are expanded or collapsed |
| RowHighlightInfo | Define how to highlight a Row |
| RowInfo | Provides meta data about a Row in Adaptable |
| RowScope | Defines which types of Rows to exclude when rendering Format Columns, Action Columns and Badges |
| RowSelectionChangedInfo | Event Info published by RowSelectionChanged event |
| RowsHighlightInfo | Defines how to highlight a set of Rows |
| RowSummary | Defines a Row Summary used in a Layout |
| RowSummaryPosition | Position of Row Summary - 'Top' or 'Bottom' |
| SaveChartBehaviour | How Charts are saved |
| ScalarFunctionName | List of all the Scalar Functions available in AdaptableQL |
| Schedule | Defines when an action will be run - either one-off or recurring |
| ScheduleApi | Provides run-time access to the Schedule Module and associated state |
| ScheduleState | Adaptable State Section for the Schedule Module |
| ScheduleTriggeredInfo | EventInfo returned by the ScheduleTriggered event |
| SelectedCellInfo | Describes which Cells are currently selected in AdapTable |
| SelectedRowInfo | Description of currently selected Rows in AdapTable |
| ServerValidationContext | Context used when validating data edits on Server |
| ServerValidationResult | Used for Server Validation ie. after an edit in AG Grid which must be checked on Server |
| SetPrimaryKeyValueContext | Context for the setPrimaryKeyValue function |
| SettingsPanelApi | Provides run-time access to the Settings Panel |
| SettingsPanelOptions | Options for managing the AdapTable Settings Panel |
| SharedEntitiesContext | Context provided to `TeamSharingOptions.loadSharedEntities()` callback |
| SharedEntity | Defines an object used in Team Sharing. The union type is discriminated by the `EntityType` property (`adaptableEntity` / `customEntity`). |
| SharedEntityType | Type of Shared Entity - Snapshot or Active |
| Shortcut | Used to define a Shortcut as used in Shortcut State |
| ShortcutApi | Provides run-time access to Shortcut Module and associated state |
| ShortcutScopeDataType | Shortcut scope data type. |
| ShortcutState | Adaptable State Section for Shortcut Module |
| SmartEditApi | Provides run-time access to the Smart Edit Module |
| SmartEditCustomOperation | Custom Operation used in Smart Edit Module |
| SmartEditOperation | Operation used by Smart Edit - either System or Custom |
| SmartEditOperationContext | Context used in Custom Smart Edit Operations |
| SparklineStyle | Style to show for a Sparkline Column |
| SpecialColumnSettings | Base Settings for both Calculated and FreeText Columns |
| StateApi | Range of functions to access Initial and Full Adaptable State |
| StateOptions | Options related to Adaptable State hydration / dehydration; allows users to intercept state persistence and loading with custom functionality |
| StatusBarApi | Methods for managing the AdapTable Status Bar |
| StatusBarState | Adaptable State Section for the Adaptable Status Bar |
| StringFormatterOptions | Formatter Options for String Columns |
| StyledColumn | Object used in Special Column Style function |
| StyledColumnApi | Provides run-time access to Styled Column Module and associated state |
| StyledColumnState | Adaptable State Section for Styled Column Module |
| SuspendableObject | Interface that extends Adaptable Object for those config items that can be suspended at run-time |
| SystemAlertPredicateId | List of System Predicates available for Alerts |
| SystemAlertPredicateIds | Array containing all System Alert Predicates |
| SystemBadgeStylePredicateId | Predicates available when creating a Badge Style Rule |
| SystemBadgeStylePredicateIds | System Predicate Ids available for Badge Style |
| SystemExportDestination | Export Destinations provided by AdapTable |
| SystemExportDestinationsContext | Context provided to `ExportOptions.systemExportDestinations` callback |
| SystemFilterPredicateId | List of System Predicates available for Filters |
| SystemFilterPredicateIds | Array containing all System Filter Predicates |
| SystemFlashingCellPredicateId | List of System Predicates available for Flashing Cells |
| SystemFlashingCellPredicateIds | Array containing all System Flashing Cell Predicates |
| SystemFormatColumnPredicateId | List of System Predicates available for Format Columns |
| SystemFormatColumnPredicateIds | Array containing all System Format Column Predicates |
| SystemPredicatesContext | Context used for setting which System Predicates are available |
| SystemReportFormat | System report formats provided by AdapTable |
| SystemReportFormatsContext | Context provided to `ExportOptions.systemReportFormats` callback |
| SystemReportName | System report names provided by AdapTable |
| SystemReportNames | Array containing all System Report names |
| SystemReportNamesContext | Context provided to `ExportOptions.systemReportNames` callback |
| SystemStatusApi | Provides access to System Status Module and associated state |
| SystemStatusMessageDisplayedInfo | Object returned by SystemStatusMessageDisplayed Event |
| SystemStatusMessageInfo | Wraps a System Status Message |
| TableAggregationColumns | Defines an Aggregated Column in a Table Layout |
| TableColumnGroupHeaderContext | Context for Column Group headers |
| TableColumnHeaderContext | Context for standard Table Layout Columns |
| TableLayout | Defines a Table-based Layout |
| TableLayoutCreationDefaultProperties | Default properties to apply when creating a new Table Layout |
| TeamSharingApi | Provides run-time access to Team Sharing Module and associated state |
| TeamSharingEntityChangedInfo | EventInfo returned by TeamSharingEntityChanged event |
| TeamSharingOptions | Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues |
| TeamSharingState | State for Team Sharing; internal so not designed to be provided as part of Initial Adaptable State |
| ThemeApi | Provides run-time access to the Theme Module and associated state |
| ThemeChangedInfo | Object returned by the `ThemeChanged` event |
| ThemeState | Theme section of Adaptable State |
| ToastPositions | Different positions offered by Notifications |
| ToastTransitions | Different transitions offered by Notifications |
| Token | Token used by the AdapTableQL parser |
| ToolbarAction | Action available in Custom Toolbar - Close or Configure |
| ToolbarActions | List of Actions available in Custom Toolbar |
| ToolPanelApi | Functions for managing the AdapTable ToolPanel Component (at side of grid) |
| ToolPanelButtonContext | Context required by functions when using a ToolPanel Button |
| ToolPanelOptions | Options related to managing the AdapTable ToolPanel Component |
| ToolPanelState | Adaptable State Section for the AdapTable ToolPanel |
| ToolPanelVisibilityMode | Whether a ToolPanel displays as expanded or collapsed |
| TransposeConfig | Config used when transposing a Grid |
| UIControlConfig | Used to customise FDC3 controls (e.g. Action Columns) |
| UniqueGridCell | Defines a Unique Cell Value (incl. how many times it appears in Grid) |
| UpgradeConfig | Config object used by State Auto-migration Wizard |
| UserColumnMenuItem | Column Menu Item that is provided by User |
| UserContextMenuItem | Context Menu Item that is provided by User |
| UserInterfaceApi | Functions relating to User Interface section of Adaptable State |
| UserInterfaceOptions | Options for managing the User Interface of AdapTable |
| UserInterfaceState | Adaptable State Section for the User Interface Controls the visibility and behaviour of AdapTable UI elements |
| UserMenuItem | Menu Item which is added to Column or Context Menu - can contain sub items |
| VueFrameworkComponent | Creates a Vue Component to be used in AdapTable UI controls |
| WeightedAverageAggregation | Defines a Weighted Average Agg |
| WindowPosition | Defines position of a Custom Window |
| WindowSize | Defines size of a Custom Window |