Using the AdapTable for AG Grid Documentation

This documentation aims to provide developers using AdapTable with everything they need to access the tool and shape it to meet their particular requirements.

The AdapTable documentation contains hundreds of help pages and demos designed to help new users get up and running quickly with AdapTable, and for existing users to find the information they need.

Framework Picker

The documentation is designed to run seamlessly according to the Selected Framework.

You can select a Framework by using the Framework Picker in the Header, which allows you to see integration, installation and custom component information for your selected framework.

There are 4 Framework variants:

• AdapTable Vanilla (TypeScript)
• AdapTable React
• AdapTable Angular
• AdapTable Vue

Sections

The documentation is divided into a number of sections:

• Getting Started - everything you need to know to get up and running with AdapTable
• Layouts - creating Table and Pivot Layouts in order to manage Columns, Grouping, Aggregations etc
• UI Components - overview of AdapTable UI surfaces (Dashboard, Settings Panel, Tool Panel, menus) plus theming and UI guides
• Core Features - most popular AdapTable features e.g. Alerts, Calculated Columns, Annotations etc.
• Searching & Filtering - how to use Quick Search, Column & Grid Filters and Data Set features
• Cell Rendering - using Format Columns, Conditional Styles, Styled Columns & Flashing Cells
• Editing - AdapTable's many editing modules, Validation, Data Change History, Cell Editors & Row Forms
• Grid Data - Exporting & Importing, Sorting, Selecting & Summarising data in AG Grid
• Advanced Features - Team Sharing, Scheduling and FDC3 Support
• Developer Guide - Everything developers needs e.g. State Management, key types, Tutorials etc.
• Technical Reference - Overview of Adaptable Options, Initial Adaptable State, AdapTable API, Events, Plugins
• AdapTableQL - Guide to Predicates and Expressions provided by AdapTable's native Query Language
• Partner Integrations - Instructions on how to use AdapTable with ipushpull, OpenFin, interop.io

Regular Pages

We try to be consistent within each section in terms of how pages are named.

In particular 2 pages appear in many sections:

Configuring

A "Configuring" page will explain how developers are able to leverage the feature.

It will typically one or both types of design-time configuration as required:

• Any Initial Adaptable State that needs to be defined
• Any Adaptable Options that can be configured

Technical Reference

Anything technical for that module is included in a "Technical Reference" page which can include any or all of:

• Initial Adaptable State
• Adaptable Options Properties
• Adaptable API Class
• Adaptable Event

FAQs

Many pages include a section contain relevant Frequently Asked Questions.

AdapTable Resources

Some pages will include an AdapTable Resources section that links to relevant material.

Older Versions

AdapTable maintains versions of the documentation from AdapTable 12 onwards.

Demos

The documentation includes a huge amount of demo examples.

Each demo is designed to show a particular feature of module with all the code provided.

Each demo will run automatically using the Framework selected in the framework picker at the top of the page.

The AdapTable documentation is liberally sprinkled with hundreds of Demos.

Every Demo illustrates a different piece of functionality or use case.

Each Demo is a full featured AdapTable (and AG Grid) instance that uses Sandpack.

Contents of the Demos

The Demos are designed to be as instructive, educational and helpful as possible.

Accordingly each Demo contains these features:

• ability between to toggle between showing the Code and seeing the AdapTable instance
• option to view the Demo in Full Screen

  Hint

  In full screen the Code and the AdapTable instance can be viewed side be side

• Reset button to undo any changes made and revert to the original version of the Demo
• Fork button to run the Demo in Codesandbox

• Description summarising what the Demo is designed to illustrate
• expandable Show More button which displays the most important snippet of code used
• Try It Out suggestion giving tips for something the user might want to try

Code View

Code View provides the most important code files that were used to create the Demo. It typically includes:

• adaptableOptions.ts - the Adaptable Options used in the Demo (including any Initial Adaptable State)
• gridOptions.ts - the AG Grid Grid Options file used
• columnDefs.ts - the AG Grid Column Definitions provided to Grid Options
• agGridModules.ts - the AG Grid Modules used in the Demo (typically the full set that AdapTable requires) and when required (i.e. when the Event has been subscribed):
• onAdaptableReady.ts - the code provided in the Adaptable Ready Event for the Demo

The Data Set

The overwhelming majority of the Demos contain the same Data Set.

It contains 25 rows, each showing the Github record of a different JavaScript framework.

Appendix: Demo List

This is the full list of Demos available in the Documentation.

Click to open the Demo of your choice.

Name	Description
Custom Predicates	Adds 3 Custom Predicates
Custom Predicates with Inputs	Creating Custom Predicates that receive inputs
Custom Predicates overriding System Predicates Behaviour	Overriding System Date Predicates with Custom Predicates (with Timezone support)
Custom Predicates overriding System Predicates Props	Overriding System Predicate labels and icons
Expression Logic: IF Function	Using Ternary Operator in Expressions
Expression Logic: Case Statements	Using Case Statements in Expressions
AdapTableQL: QUERY Expression Function	Using QUERY to reference other Expressions
Expressions using Row Data	Using non Column Row Data in Expressions
AdapTableQL: VAR Expression Function	Using VAR to provide placeholders and variables
AdapTableQL: Scalar Aggregation	Using Scalar Aggregation Expressions in AdapTable
AdapTableQL: Boolean Aggregation	Creating Aggregated Boolean Expressions in AdapTableQL
AdapTableQL: Grouped Aggregation	Using Scalar Aggregation Expressions with Grouping
AdapTableQL: Boolean Aggregations with WHERE	Aggregated Boolean Expressions with WHERE Clauses
AdapTableQL: Cumulative Aggregation	Using Cumulative Scalar Aggregation Expressions
AdapTableQL: Cumulative Aggregations Grouped	Using Cumulative Scalar Aggregations with Grouping
AdapTableQL: Custom Aggregation Functions	Using Custom Expression Functions
AdapTableQL: Custom Functions Scope	Adding Scope to Custom Expression Functions
AdapTableQL: Custom Scalar Functions	Using Custom Scalar Expression Functions
AdapTableQL: Limiting Functions	Removes some System AdapTableQL Expression Functions
AdapTableQL: Limiting Columns	Set some columns to be non queryable
AdapTableQL: Quantile Aggregation	Using Quantile Scalar Aggregation Expressions
AdapTableQL: Grouped Quantile Aggregation	Using Grouped Quantile Scalar Aggregation Expressions
AdapTableQL: Standard Expressions	Using Standard Expressions in AdapTable
AdapTableQL: Multi-Clause Boolean Expressions	Using Boolean Expressions with multiple Clauses
AdaptableQL Server Evaluation	Evaluating AdaptableQL on the Server
Custom Data in Adaptable State	Using Application Initial State to save bespoke user data
Adaptable State Changes	Monitoring changes in AdapTable State
Filtering Adaptable State Changed Messages	Filtering messages fired by the Adaptable State Changed Event
State Management Module	Managing Adaptable State with State Management Module
Remote State Persistence	Stores AdapTable State remotely (using Supabase)
Load & persist state based on user identity/role	Loading and persisting state based on user identity/role
Persisting state imperatively	Custom State Persistence: Suppressing automatic State Persistence and imperatively persisting State
Persisting specific state slices imperatively	Custom State Persistence: Suppressing specific State changes and persisting them imperatively
Array Cell Data Type	Using Array Columns
AG Grid Cell Data Types	Using AG Grid Cell Data Types in AdapTable
AG Grid Cell Rendering & Formatting	How AG Grid Column Components and Value Formatters work with AdapTable
Using AG Grid Pagination	How AG Grid Pagination works in AdapTable
Custom Column Headers Layout	Providing Alternative Column Headers in a Layout
Custom Column Headers Function	Providing Alternative Column Headers via a function
Column Info Panel	Using Column Info to see details about specific Columns
Column Type Scope	Column Scope in Format Columns
Special Column Types	Defining 'Special Column' Types in AG Grid
Hiding a Column in AdapTable UI	Hide a column so its never visible to a user
Updating Stateful Column Props at Runtime	How to safely update AG Grid Column properties using Column State at run-time
Updating Other Column Props at Runtime	How to safely update non-stateful AG Grid Column properties at run-time
Adding Column Definitions at Runtime	How to safely add AG Grid Column Definitions at run-time
Deleting Column Definitions at Runtime	How to safely add AG Grid Column Definitions at run-time
Setting Column Definitions at Runtime	How to safely replace AG Grid Column Definitions at run-time
SSRM - Calculated Columns	Server-Side Row Model: Calculated Columns
SSRM - Exporting	Server-Side Row Model: Running Reports
SSRM - Column Filtering	Server-Side Row Model: Applying Column Filters
SSRM - Grid Filter	Server-Side Row Model: Applying Grid Filter
SSRM - Formatting Columns	Server-Side Row Model: Styling and Formatting
SSRM - Row Grouping	Server-Side Row Model: Row Grouping
Server-Side Row Model	Server-Side Row Model: Full Demo
SSRM - Pivoting	Server-Side Row Model: Pivoting
SSRM - Searching	Server-Side Row Model: Applying Quick Search
SSRM - Sorting	Server-Side Row Model: Applying Sorts
SSRM - Custom Sorting	Server-Side Row Model: Applying Custom Sorts
SSRM - Updating Rows	Server-Side Row Model: Updating Data Rows
SSRM - Adding Rows	Server-Side Row Model: Adding Data Rows
Displaying Big Data	How AdapTable can handle very big data
AdapTable Performance	How AdapTable performs when lots is happening
Grid Info Panel	Using Grid Info to get overview of all AdapTable objects
Providing Custom Holidays	Settings Holidays and Working Days in AdapTable
Hot Keys	Using Hot Keys in AdapTable
Providing Adaptable Context	Sharing a `currentUser` object and a `userService` helper via Adaptable Context
Auto-Generated Primary Keys	Using Primary Keys dynamically generated by AdapTable
Action Columns: Usage	How to define Action Columns
Action Columns: Multiple Buttons	Action Columns with multiple Buttons
Action Columns: Dropdown	Action column with dropdown menu
Action Column Commands	Using Action Column Commands
Action Column Commands Pinned	Using Action Column Commands
Configuring Action Column Commands	Configuring Action Column Command Buttons
Action Columns: Defining in AG Grid	Action Columns: Adding AG Grid properties
Action Columns: Grouped Rows	Displaying Action Columns in Grouped and Summary Rows
Aggregations: Column Headers	Hiding the aggFunc from the Column Header
Aggregations: Formatting	Formatting and Styling Aggregations
Aggregations: Grand Total Row	Providing a Row showing Total of all Aggregations
Aggregations: Grand Total Row Formatting	Formatting Grand Total Rows
Aggregations: 'Only' Custom Aggregation	Using the Only Aggregation
Aggregations: 'Only' Custom Aggregation (Hiding)	Hiding the Only Aggregation
Using Weighted Averages	Providing Weighted Average Aggregations
Alerts: Aggregated Expressions	Alerts fired due to Aggregated Boolean Expressions
Events: Alert Fired	Event published when Alerts fire
Alerts: Alert Behaviours	Alerts configured with particular Behaviours
Alerts: Triggered by Predicates	Alerts fired due to Predicate Rules
Alerts: Multiple Predicates	Alerts fired due to Rules with Multiple Predicates
Alerts: Boolean Expressions	Alerts fired due to complex Boolean Expressions
Adaptable Forms in Alerts	Alerts can display an Adaptable Form when triggered
Custom Alert Messages (Definition)	Providing Custom Alert Message via Alert Definition
Custom Alert Messages (Templates)	Providing Custom Alert Message using Template Literals
Custom Alert Messages (Options)	Providing Custom Alert Message via Alert Options
System Alert Command Buttons	Using Alert Command Buttons
Custom Alert Command Buttons	Providing Custom Alert Command Buttons
Adaptable Forms in Alerts	Alerts can display an Adaptable Form when triggered
Alerts: Observing Row Changes	Observable Alerts fired on Row Changes
Alerts: Observing Grid Changes	Observable Alerts fired on Grid Changes
Alerts: Observing No Changes	Observable Alerts fired on No Changes
Alerts: Relative Any Change	Alerts fired due to Any Change
Alerts: Relative Percent Change	Alerts fired due to a Percent Change
Alerts: Relative Absolute Change	Alerts fired due to an Absolute Change
Alerts: Row Added	Alerts on Rows being Added to AdapTable
Alerts: Row Added with WHERE	Observable Alerts fired when Row Added with WHERE clause
Alerts: Row Removed	Alerts on Rows being Removed from AdapTable
Alerts: Scheduled	Creating Scheduled Alerts that run at a given time
Alerts: Validation Alerts	Alerts which prevent cell edits
Calculated Columns: Introducing	Calculated Columns: How they work
Calculated Columns: Formatting	Calculated Columns: Adding Formatting
Pivoting Calculated Columns	Using Calculated Columns inside Pivot Layouts
Calculated Columns: Defining in AG Grid	Calculated Columns: Adding AG Grid properties
Calculated Columns: Aggregated	Calculated Columns: Aggregated Scalar Expressions
Calculated Columns: Aggregated with GROUP_BY	Calculated Columns: Aggregated, Grouped Scalar Expressions
Calculated Columns: Aggregated with Row Grouping	Calculated Columns: Aggregated Scalar Expressions in Row Groups
Calculated Columns: Defining in AG Grid	Calculated Columns: Adding AG Grid properties
Calculated Columns: Cumulative	Calculated Columns: Cumulative Aggregated Expressions
Quantile Calculated Columns	Calculated Columns: Quantile Aggregations
Calculated Columns: Referencing	Calculated Columns: Reference other Calc Cols
Calculated Columns: Flashing	Calculated Columns flash when a referenced column changes
Calculated Columns: Alerts	Data Change Alerts on Calculated Columns
Charts Calculated Column	Charts using Calculated Columns
Basic Calculated Columns	Calculated Columns: Basic Standard
Calculated Columns: Complex Expressions	Calculated Columns: Complex Expressions
Date Picker Customising	Customise the AdapTable Date Picker
Date Picker Theming	Theming the AdapTable Date Picker
Numeric Cell Editor Params	Numeric Editor with Cell Editor Params
Percentage Editor	AdapTable Percentage Editor
Percentage Editor Params	Percentage Editor with Cell Editor Params
Select Editors	Providing Select Editors to speed up data entry
Saving AG Grid Charts	How to leverage AG Grid's Charts in AdapTable
Cross Filter Charts	Supporting AG Grid's Cross Filter Charts
Chart Locations	Showing AG Grid Charts in different locations
Multiple Charts in Location	Showing multiple AG Grid Charts in a Div
External Charts Library	Using external charts libraries
Saving External Charts	Using external charts libraries with Adaptable State
Displaying Saved Charts	Displayed visible Charts when AdapTable restarts
Read-Only Charts	Settings Charts to be Read-Only
Filters	Basic Filtering using System Predicates
Multiple Predicate Filters	Filtering using Multiple Predicates
Filter Bar Wildcards	Adding and removing Wildcards in Filter Bar
Filter Bar Configuration	Configuring Filters using Filter Options
Using AG Grid Filtering	Selecting AG Grid Filters instead of AdapTable
Non-Filterable Rows	Configuring which rows cannot be filtered
Column Filter Applied Event	Listening to Column Filter Applied Event
Custom Filters	Filtering using user-defined Custom Predicates
Custom Filters with Inputs	Creating Custom Filters that receive inputs
Custom Filters using Time	Creating Custom Filters will filter on Time
Ordering Custom Filters	Ordering Custom Predicates provided for Filters
Custom Filters accessing Other Columns	Creating Custom Filters that look up values in other Columns
In Filter: Values Count	Show a count of each item in In Filter
In Filter: Only Visible Values	Only show currently filtered values in In Filter
In Filter: Only Visible Values with Count	Only show currently filtered values in In Filter together with a Count
In Filter: Showing Raw Value	Show an item's raw value in In Filter
In Filter: Custom Label	Show a custom label for In Filter values
In Filter: Sorted Values	Sorting values in In Filter
In Filter: Ordered Values	Ordering values in In Filter
In Filter: Showing a Tooltip	Displaying a tooltip in In Filter
In Filter: Adding System Predicates	Add System and Custom Predicates to filtered values in In Filter
In Filter: Adding Custom Predicates	Add System and Custom Predicates to filtered values in In Filter
In Filter: Date Columns	In Filter showing Dates as a Tree structure
In Filter: Suppressing Search	Supressing Search in In Filter (enabling server valuation)
Not In Filter	Excluding Column Values from the Filter
In Filter: Arrays	The In Predicate with Array Columns
In Filter Performance	Using In Filter with very big data
Manually Apply Filters	Manually Applying Column Filters
System Filters	Configuring System Predicates in Filters
Default Predicates for Filters	Setting new default Predicates for Filters
Column Formatting	How Column Formatting Works
Format Column - Scope	Column Scope in Format Columns
Column Formatting: Column Styles	Column Formatting using Adaptable Styles
Column Formatting: CSS Classes	Format Column with an external CSS Class
Format Column - Conditions	Conditional Rules in Format Columns
Format Column - Expression Condition	Expression Conditions in Format Columns
Format Column - Predicate Condition	Predicate Conditions in Format Columns
Format Column - Multiple Predicate Conditions	Multiple Predicate Conditions in Format Columns
Format Column - Referenced Predicate Conditions	Referenced Predicate Conditions in Format Columns
Format Column: Custom Predicates	Using Custom Predicates in Format Columns
Column Formatting Composition	Merging multiple Format Columns together
Column Formatting Precedence Order	Multiple Format Columns are merged according to Precedence
Column Formatting - Excluding Rows	Applying Formats only in Grouped Rows
Column Formatting: Display Formats	Column Formatting with Display Formats
Column Formatting: Format Precedence	Column Formatting with a multiply Display Formats
Column Formatting: Custom Formatter	Column Formatting with a Custom Display Formatter
Column Formatting: Date Display Formats	Column Formatting with Date Display Formats
Column Formatting: Numeric Display Formats	Column Formatting with Numeric Display Formats
Column Formatting: Numeric Display Format Presets	Column Formatting with Numeric Display Format Presets
Column Formatting: String Display Formats	Column Formatting with String Display Formats
Column Formatting: Template Literal Display Formats	Column Formatting with Placholder Display Formats
Styling & Formatting Column Headers	Formatting and Styling Column Headers
Comments in AdapTable	Using Comments
Configuring Commentable Cells	Setting which Cells can display Comments
Comments CSS	Configuring Comments using CSS variables
Comments Date Format	Configuring the format for Comments timestamp
Comments Menu	Viewing Comments via Context Menu
Custom Sorts: Values	Providing Custom Sort Initial State
Custom Sorts: Functions	Providing Custom Sort Functions
Using Data Set Forms	Loading Data in AdapTable with Data Sets
Using Data Sets	Loading Data in AdapTable with Data Sets
Bulk Update	Updating numerous cells in one operation
Bulk Update Validation	Bulk Update validating proposed edits
Edit Custom Values	Providing custom values when editing a Column
Using Plus/Minus	Nudging numeric cells using Plus Minus
Using Plus/Minus Rules	Applying custom Plus Minus rules
Custom Plus/Minus Keys	Configuring Custom Plus / Minus Keys
Plus/Minus Key Combinations	Triggering Plus / Minus Nudges with keyboard shortcut combinations
Using Shortcuts	Editing data quickly using custom Shortcuts
Shortcuts in Row Forms	Shortcuts are available also in Row Forms
Smart Edit	Editing numeric Columns using Smart Edit
Smart Edit Custom Operations	Adding bespoke Smart Edit Operations
Exporting in AdapTable	Exporting Data from AdapTable
Configuring Export	Providing fine-grained control over Export in AdapTable
Configuring Report FileNames	Configuring the Names of the Report Files in Export
Setting Exportable Columns	Configuring which columns are exportable
Skipping Column Headers	Excluding Column Headers from exported Report
Configuring System Export Destinations	Configuring which System Export Destinations are available
Custom Export Destination via Function	Custom Export Destination: via a Function
Custom Export Destination via a Form	Custom Export Destination: via a Form
Formatting Report Values	Exporting Data using bespoke formatting rules
Formatting Dates in Reports	Exporting data with dates in special format
Processing: Creating Reports on Server	Report processing to run report on server
Processing: Stopping Export	Report processing to stop Exports
Exporting System Reports	Exporting data from AdapTable using System Reports
Configuring System Reports	Configuring which System Reports are available
Custom Reports	Exporting Data from AdapTable via Custom-created Reports
Configuring System Report Formats	Configuring which System Report Formats are available
CSV Report Format	Exporting Data from AdapTable in CSV Format
Excel Column Type	Exporting to Excel using Excel Column Types (to preserve formatting)
JSON Report Format	Exporting Data from AdapTable in JSON Format
VisualExcel Report Format Type	Using the VisualExcel Report Format Type for a WYSIWYG export
Schedules	Scheduling Reports in AdapTable
Flashing Cells	Flashing Cells on Any Change
Flashing Cells using a Rule	Flashing Cells when change matches a Rule
Changing Flashing Cell Defaults	Changing Flashing Colours and Duration
Flashing Rows on Cell Change	Flashing a Whole Row when Cells Change
Free Text Columns	Using Free Text Columns in AdapTable
Free Text Columns Formatting	Formatting Free Text Columns in AdapTable
Applying a Grid Filter	Using AdapTableQL to run Grid Filter
Comparing Column values with the Grid Filter	Using Grid Filter to compare values in 2 Columns
Grid Filter and Column Filters	Applying a Grid Filter with Column Filters
Grid Filter with Query Builder only	Grid Filter: Setting which UI Components are available
Column Groups	Using Column Grouping in AdapTable
Column Groups with Special Columns	Column Groups containing Calculated, FreeText or Action Columns
Column Groups: Expanded and Collapsed	Setting Column Groups to be Expanded or Collapsed
Column Groups: Expanded and Collapsed	Setting Column Groups to be Expanded or Collapsed
Row Grouping: Basics	Configuring Row Groups in AdapTable
Row Grouping: Multiple Columns	Displaying each Row Group in its own Column
Row Grouping: Positioning Single	Positioning Single Row Groups in AdapTable
Row Grouping: Positioning Multiple	Positioning Multiple Row Groups in AdapTable
Row Grouping: Pinning Single Row Group	Pinning Single Row Grouped Columns in AdapTable
Row Grouping: Pinning Multiple Row Groups	Pinning Multiple Row Grouped Columns in AdapTable
Row Grouping: Sizing Row Group Column	Sizing Row Grouped Columns in AdapTable
Row Grouping: Setting Default Behaviour	Default Row Group Behaviour
Row Grouping Behaviour: Single Row Grouping	Setting and Saving Expanded Single Row Groups
Row Grouping Behaviour: Multiple Row Grouping	Setting and Saving Expanded Multiple Row Groups
Row Grouping Behaviour: Display Type Multi	Setting and Saving Expanded Row Groups with DisplayType of Multi
Row Grouping Behaviour: Pivot Layouts	Setting and Saving Expanded Row Groups in Pivot Layouts
Row Grouping: Filtering Single RowGroupDisplayType	Filtering Row Grouped Columns with Display Type Single
Row Grouping: Existing Filters	Filtering Row Grouped Columns on Columns with existing Column Filters
Row Grouping: Setting Row Grouped Column Filter	Setting Filter for the Row Grouped Column
Row Grouping: Filtering with Field	Setting Filter for the Row Grouped Column when Field is set
Row Grouping: Filtering Multi RowGroupDisplayType	Filtering Row Grouped Columns with Display Type Multi
Row Grouping: Formatting Single	Formatting Row Grouped Columns
Row Grouping: Formatting Multi	Formatting Multiple Row Grouped Columns
Row Grouping: Conditional Styles	Providing Conditional Styling for Row Grouped Columns
Row Grouping: Styling Whole Grouped Row	Providing Conditional Styling for entire Row Grouped Column Row
Full Width Grouped Rows	Displaying full-width Grouped Rows
Grouped Rows: Format Columns	Using Format Columns in Grouped Rows
Grouped Rows: Styled Columns	Badge, Gradient, and Percent Bar on Grouped Rows
Row Grouping: Action Columns in Grouped Rows	Adding Action Columns in Grouped Rows created by Row Grouped Columns
Row Grouping: Sorting	Sorting Row Groups in AdapTable
Highlighting Cells and Rows	Using Grid API to highlight cells and rows in AdapTable
Jumping to Cells and Rows	Using Grid API to move focus to given Cells, Rows & Columns
Data Import - Update Rows	Updating Data using Data Import
Data Import - Add Rows	Adding New Rows using Data Import
Data Import - Adding all data	Adding All Data using Data Import
Data Import - Matching Columns	Data Import with Column Matching
Data Import - Validation	Validating Data in Data Import
Data Import - Custom CSV File Handler	Custom file handlers.
Basic Layout	Using Layouts in AdapTable
Default Creation Props	Providing Default Creation Props in Layout Options
Default Layout Props	Providing Default Layout Properties via State Functions
Extended Layouts	Extending Layouts by using Tags to limit Scope
Sharing Extended Layouts	Sharing an Extended Layout
Cloning Extended Layouts	Cloning an Extended Layout
Layouts With Metadata	Adding MetaData to Layouts
Layout Changed	Event triggered when the Layout is changed
Pivot Layouts	Creating Pivot Layouts In AdapTable
Pivot Layouts - Expand Cells	Opening a Pivot Cell to see full contents in Table View
Pivot Column Groups: Expanded Collapsed	Configuring Expanded Collapsed Behaviour for Pivot Column Groups
Expanding Pivot Columns	Pivot Layout with Expanded Pivot Columns configured
Pivot Aggregation Layouts	Pivot Layout with Agg Columns
Pivot: Column Filtering	Applying Column Filtering when Pivoting
Pivot Result Columns: Filtering	Applying Column Filtering in Pivot Result Columns
Pivot - Formatting Aggregation Columns	Adding Styles and Column Formatting to Pivot Aggregation Columns
Pivot - Formatting Result Columns	Applying Column Formatting and Styling to Pivot Result Columns
Pivot - Formatting Row Groups	Applying Column Formatting and Styling to Pivot Row Grouping Columns
Excluding formatting from Pivot Layouts	Ensuring Styles are excluded from Pivot Layouts
Pivot Result Columns	Using Pivot Result Columns
Pivot Layouts: Row Selection	Row Selection in Pivot Layouts
Pivot Aggregation Columns: Widths	Setting & Saving Column Widths of Pivot Aggregation Columns
Pivot Result Columns: Widths	Setting & Saving Column Widths of Pivot Result Columns
Pivot Sorting: Aggregation Columns	Setting & Saving Column Sorting for Pivot Aggregation Columns
Pivot Sorting: Pivot Result Columns	Setting & Saving Column Sorting for Pivot Result Columns
Pivot Sorting: Custom Sorts	Using Custom Sorts in Pivot Layout
Pivot Grand Totals	Pivot Grand Total Columns
Pivot Column Totals	Pivot Column Totals
Pivot Aggregation Totals Layout	Pivot Aggregation Total Columns per Layout
Pivot Aggregation Totals Pivot Column	Pivot Aggregation Total Columns per Pivot Column
Total Columns Formatting Inheritance	Formatting Pivot Aggregation Total Columns
Total Columns Formatting Column Types	Formatting Pivot Aggregation Total Columns
Formatting Pivot Column Totals	Formatting Pivot Column Groups Expanded / Collapsed
Totals Columns Customising Header	Configuring Headers for Pivot Total Columns
Updating Pivot Total Columns	Updating Pivot Total Columns at runtime via api
Manually Saving Layouts	Non-auto saving of Layouts
Synchronising Layouts	Using Layout Changed Event to synchronise between Layouts
Table Layouts	Creating Table Layouts
Table Layouts: Column Headers	Creating Table Layouts with custom Column Headers
Table Layouts: Column Order	Creating Table Layouts with default Column Order
Table Layouts: Column Sizing	Creating Table Layouts with custom Column Widths & Flex
Table Layouts: ColDef Widths	Creating Table Layouts with custom ColDef Widths
Table Layouts: Column Visibility	Creating Table Layouts with custom Column Visibility
Table Layouts: Column Pinning	Creating Table Layouts with Column Pinning
Table Layouts: ColDef Pinning	Creating Table Layouts with custom ColDef Pinning
Table Layouts: Row Selection Mode	Setting Row Selection Mode in a Layout
Table Layouts: Row Selection Checkboxes	Defining Row Selection Column in a Layout
Table Layouts: Row Selection Position	Positioning Row Selection Column in a Layout
Table Layouts: Row Selection Pinning	Pinning Row Selection Column in a Layout
Table Layouts: Row Selection Sizing	Sizing Row Selection Column in a Layout
Table Layouts: Row Selection Click Behaviour	Setting Click Behaviour for a Row Selection Column
Table Layouts: Row Selection with Row Grouping	Configuring Row Selection while Row Grouping
Table Layouts: Sorting	Creating Table Layouts with Column Sorting
Sorting on Invisible Columns	Sorting the Grid using Hidden Columns
Updating Layouts Programmatically	Updating Layout using the updateLayout api function
Setting Cell Values	Using Grid API to set individual cell values
Row Changed Events	Events triggered when Rows are added or deleted
Cell Changed Event	Event triggered when Cells are edited
Loading Grid Data	Loading data in AG Grid and AdapTable at run-time
Delaying Grid Data	Adding extra columns after AG Grid has loaded
Adding Row Data	Adding Rows to AG Grid at run-time
Deleting Row Data	Deleting Rows from AG Grid at run-time
Managing Row Data	Managing AG Grid Rows at run-time
Updating Row Data	Updating Rows in AG Grid at run-time
Master Detail	Using the Master Detail Plugin
Master Detail - Detail Init	Initialising the Detail Grids
Data Change History	Seeing editing activing in Data Change History
Data Change History: Button Actions	Using Undo and Clear Actions in Data Change History
Data Change History: Undo Button	Extending Data Change history with Undo Buttons
Data Change History: Limiting Changes	Setting which edits will display in Data Change History
Data Change History: Showing all Changes	Setting Data Change History to show all the changes made to each Cell
Named Queries	Defining and Saving "Named Queries" for Re-Use
Referencing Named Queries	Referencing Named Queries by using the QUERY keyword
AdapTable No Code	Using the AdapTable No Code Plugin
No Code Adapter for AdapTable React	AdapTable React — No Code plugin
AdapTable No Code Data Source	Providing a Custom Data Source step to No Code Wizard
Notes in AdapTable	Adding Notes to cells
Configuring Notable Cells	Setting which Cells can display Notes
Notes CSS	Configuring Notes using CSS variables
Notes Menu	Viewing Notes via Context Menu
Entitlements: Default Access Level	Providing a default Entitlement with a value
Entitlements: By List	Managing Entitlements through a 'hard-coded' list
Entitlements: By Function	Managing Entitlements through a JavaScript function
Entitlements: ReadOnly Objects	Permissioning invididual objects to be ReadOnly
Quick Search	Running Quick Search in AdapTable
Quick Search as Filter	Quick Search: Filtering Results
Customising Quick Search as Filter	Quick Search: Filtering Results using Custom Evaluation
Quick Search Raw Value	Running Quick Search using the Cell's Raw Value
Bespoke Quick Search	Providing a bespoke Quick Search implementation
Quick Search Exclude Cells	Excluding Cells from Quick Search
Quick Search Placeholder	Changing Quick Search Placeholder
Floating Quick Search	Using Floating Quick Search in AdapTable
Quick Search Matching Styles	Setting Quick Search Matching Styles
Create Row Form	Displaying the Create Row Form
Edit Row Form	Displaying the Edit Row Form
Clone Row Form	Displaying the Clone Row Form
Delete Row Form	Triggers the Delete Row Form
Row Form Events	Listening to the Row Form Submitted Event
Row Form Config	Configuring a Row Form
Cell Selection	Selecting Cells in AdapTable
Row Selection	Selecting Rows in AdapTable
Selecting Cell Ranges	Selecting Ranges using Adaptable API
Selecting using Expressions	Selecting cells using Expressions
Selecting Columns	Selecting Columns using Adaptable API
Selecting Rows	Selecting Rows using Adaptable API
Selecting whole Grid	Selecting all Cells using Adaptable API
Badge Styled Columns	Displaying Badge Styles
Badge Style: Cell & Alignment	Cell chrome and centred badge row
Badge Styles: Multiple Rules	Styling Badges with Multiple Rules (per Predicate)
Badge Styles: Custom Icons	Showing Custom Icons in Badges
Badge Styles: Only Icons	Showing Only Icons (and no text) in Badges
Badge Styles: Arrays	Badge Styles in Array Columns
Badge Styles: Custom Predicates	Badge Styles using Custom Predicates
Bullet Chart: Number Bands	Qualitative bands and a fixed target
Bullet Chart: Percentage Bands	Percentage bands and a column-average target
Bullet Chart: Column Target	A different target on every row
Bullet Chart: Multiple Targets	Two markers in one cell
Bullet Chart: Negative Values	Centred axis for signed values
Bullet Chart: Vertical	Vertical orientation with taller rows
Bullet Chart: Cell Text	Merged value and tooltip
Gradient Style: Number Ranges	Number Range gradients
Gradient Style: Percentage Ranges	Percentage Range gradients
Gradient Style: Zero Centred	Gradient Style Zero Centred
Gradient Style: Column Comparison	Gradient Style using Column Comparison
Gradient Style: Reverse Gradient	Reverse Gradient on a Number Range band
Gradient Style: Alpha Bounds	MinAlpha and MaxAlpha on a single Number Range
Gradient Style: Formatting	Gradient Style with Format Column styling
Icon Style: Flags	Country flags with code beside the glyph
Icon Style: Currencies	Preset plus custom overrides
Icon Style: Trend	Buy and Sell arrows from the Trend preset
Icon Style: Status	Traffic-light preset on a status column
Icon Style: Custom Mappings	Hand-built key → icon rows
Icon Style: Fallback	Hide, raw text, or fallback icon on miss
Icon Style: Companion Text	Flag + code vs flag + country name
Icon Style: System Icons	Bundled AdapTable icons instead of emoji
Styled Columns	Styled Columns in AdapTable
Percent Bar: Numeric Ranges	Percent Bars using Numeric Ranges
Percent Bar: Percentage Ranges	Percent Bars using Percentage Ranges
Percent Bar: Column Comparisons	Percent Bars Using Column Comparisons
Percent Bar: Negative Values	Centred-axis bars for signed values
Percent Bar: Custom Origin	Bars growing from a fixed baseline
Percent Bar: Cell Properties	Percent Bars with Back Colour, Cell Text and Tooltip
Range Bar: Column Bounds	Per-row Min/Max from columns with a reference marker
Range Bar: Number Bands	Column-wide scale with numeric bands behind the track
Range Bar: Percentage Bands	Percentage bands on a column-wide track
Range Bar: Vertical	Vertical track with tall row height
Range Bar: Out Of Range	Overflow vs clamp when values exceed Max
Rating Style: Stars	Stars with half icons, value label and tooltip
Rating Style: Other Shapes	Heart and Circle icon shapes
Rating Style: Allow Half	Half icons vs rounded whole icons
Rating Style: Cell Style	Showing Rating Style with cell box styling using Thumbs up
Styled Column: Sparkline	Styled Columns showing Basic Sparklines
Sparkline: Cell Style	Cell chrome behind a line sparkline
Styled Column: Sparkline Advanced	Styled Columns showing Complex Sparklines
Sparkline Columns: Calculated	Sparkline Columns: Inside Calculated Columns
Summarising Grid Data	Summarising Grid Data in AdapTable
Cell Summary	Summarising selected cells
Summarising Pivot Cells	Cell Summary in Pivot Layouts
Custom Cell Summaries	Providing Custom Cell Summaries
Cell Summary Formatting	Formatting Cell Summary values
Cell Summary Ticking Data	Cell Summary values automatic updates
Row Summary	Displaying Row Summaries
Formatted Row Summary	Formatting Row Summaries
Filtered Row Summary	Row Summaries with Filters
System Status	Sending and Displaying System Status Messages
System Status	Configuring System Status Messages
Team Sharing	Basic Team Sharing
Team Sharing with Multiple Teams	Team Sharing between multiple teams of users
Active Team Sharing	Active Team Sharing
Configuring and customizing state management	Configuring and customizing TeamSharing State Management
Team Sharing Admin and User	A user is an admin and can share entities, and one is a normal user that can only apply shared entities.
Team Sharing with Custom Objects	Using Team Sharing to share bespoke data
Referenced Team Sharing: Adaptable Objects	Team Sharing with Adaptable Objects
Referenced Team Sharing: Layouts	Team Sharing Layouts with Special Columns
Referenced Team Sharing: Extended Layouts	Team Sharing with Extended Layouts with Tagged Objects
OS Theme	Using OS Theme in AdapTable
Co-ordinated Themes	Rose/red brand on AdapTable and AG Grid — switch light and dark together
AG Grid Themes	AG Grid built-in themes in AdapTable
AG Grid Custom Theme	Creates a custom AG Grid theme and pairs it with AdapTable's `Dark` theme.
Demo: Key Theme Variables	Override core theme variables — different brand for light and dark
Demo: Component Variables & Selectors	Lower-level variables and targeted CSS — light theme only
Demo: Date Picker Variables	Styling the Date Picker
Demo: CSS Variables in Adaptable Styles	Format Columns that follow the active theme
Transposing the Grid	Show a Grid in Transposed View
Transposing: Configuring Columns	Select which Columns are transposed in Transposed View
Transposing: Configuring Rows	Select which Rows are transposed in Transposed View
Transposing the Grid	Display Transposed View in custom location
Tree Data Formatting	Adding Format Columns to Tree Data in AdapTable
Tree Data Quick Search	Using Quick Search with Tree Data
Tree Data Column Filtering	Using Column Filters with Tree Data
Tree Data Pinning	Pinning Key Column in Tree Grid
Tree Data Sizing	Setting width of Key Column in Tree Grid
Tree Data Sorting	Sorting the Key Column in Tree Grid
Data Validation	Performing Data Validation with a Prevent Edit Alert
Client Data Validation	Performing Client Data Validation with a Prevent Edit Alert
Editable Cells	Setting particular cells in AdapTable to be editable
Server Validation	Performing Server Validation
Introducing AdapTable	How AdapTable integrates with - and extends - AG Grid
Introducing AdapTable	How AdapTable integrates with - and extends - AG Grid
Introducing AdapTable	How AdapTable integrates with - and extends - AG Grid
Introducing AdapTable	How AdapTable integrates with - and extends - AG Grid
Using the useAdaptableState and useCurrentLayout hooks	Using the `useAdaptableState` and `useCurrentLayout` hooks
Passing Component State in AdaptableOptions	Passing Component State in AdaptableOptions (React)
Column Menu: Reordering Menu Items	Reordering items in the AdapTable Column Menu
Column Menu: Restructuring Menu Items	Restructuring Items in AdapTable Column Menu
Column Menu: Removing Menu Items	Removing Items in AdapTable Column Menu
Column Menu: Row Group Columns	Managing Row Group Items in AdapTable Column Menu
Column Menu: Custom Menu Items	Adding Custom Menu Items to Column Menus
Column Menu: Standard Custom Items	Standard custom Column Menu items (React)
React Custom Column Menu Item	Providing a React Component as a Custom Column Menu Item
Column Menu: Standard Custom Items	Standard custom Column Menu items (Angular)
Angular Custom Column Menu Item	Providing an Angular Component as a Custom Column Menu Item
Column Menu: Standard Custom Items	Standard custom Column Menu items (Vue)
Vue Custom Column Menu Item	Providing a Vue Component as a Custom Column Menu Item
Context Menu: Reordering Menu Items	Reordering items in the AdapTable Context Menu
Context Menu: Restructuring Menu Items	Restructuring Items in AdapTable Context Menu
Context Menu: Removing Menu Items	Removing Items in AdapTable Context Menu
Context Menu: Row Group Columns	Managing Row Group Items in AdapTable Context Menu
Context Menu: Custom Menu Items	Adding Custom Menu Items to Context Menus
Context Menu: Standard Custom Items	Standard custom Context Menu items (React)
Context Menu: Framework Menu Row (React)	Providing a React Component as a Custom Context Menu Item
Context Menu: Standard Custom Items	Standard custom Context Menu items (Angular)
Context Menu: Framework Menu Row (Angular)	Providing an Angular Component as a Custom Context Menu Item
Context Menu: Standard Custom Items	Standard custom Context Menu items (Vue)
Context Menu: Framework Menu Row (Vue)	Providing a Vue Component as a Custom Context Menu Item
Dashboard: Overview	Using the AdapTable Dashboard
Dashboard: Module Buttons	Displaying Module Buttons in the Dashboard
Dashboard: Custom Buttons	Displaying Custom Buttons in the Dashboard
Dashboard: Configuring	Configuring the AdapTable Dashboard
Dashboard: Stacking Toolbars	Stacking Toolbars in the Dashboard
Custom Toolbar: Using Buttons	Providing Custom Toolbars with AdapTable Buttons
Custom Toolbar: Automating Buttons	Custom Toolbars with dynamic AdapTable Buttons
Custom Toolbar: Inline Form	Providing Custom Toolbars with declarative form controls reacting per-field
Custom Toolbar: All Field Types	A single Custom Toolbar exercising every supported AdaptableFormFieldType plus validation, helpText, tooltips, conditional visibility and form-validity-aware buttons
Custom Toolbar: Advanced Fields	Multi-select, dependent (dynamic) options, the built-in slider and radio field types, a computed custom read-out, and Enter-to-submit
Custom Toolbars: Bespoke Content	Providing bespoke content in a Custom Toolbar
Angular Components: Custom Toolbars	Providing Angular Components as Custom Toolbars
React Components as Custom Toolbars	Providing React Components as Custom Toolbars
Vue Components as Custom Toolbars	Providing Vue Components as Custom Toolbars
Dashboard; Collapsed Mode	Showing Dashboard in Collapsed Mode
Dashboard: Floating Mode	Showing Dashboard in Floating Mode
Dashboard: Hiding	Hiding the Dashboard altogether
Dashboard: Tabs & Toolbars	Providing Tabs and Module Toolbars in the Dashboard
Dashboard: Pinned Toolbars	Using Pinned Toolbars
AdapTableQL Expression Editor	How to use the Expression Editor in AdapTable
Configuring Loading Screen	Custom loading screen title, text, and delay during initialisation
Creating a Custom Window	Displaying a Custom Window
Angular Components as Custom Windows	Providing Angular Components as Custom Windows
React Components as Custom Windows	Providing React Components as Custom Windows
Vue Components as Custom Windows	Providing Vue Components as Custom Windows
Displaying a Progress Indicator	Display a Progress Indicator
Angular Components as Progress Indicators	Providing Angular Components as Progress Indicators
React Components as Progress Indicators	Providing React Components as Progress Indicators
Vue Components as Progress Indicators	Providing Vue Components as Progress Indicators
AdapTableQL Query Builder	Using Expression Query Builder
Settings Panel	Settings Panel: Using it in AdapTable
Setting Items in Settings Panel	Settings Panel: Setting order & visibility of Items
Customising the Settings Panel	Settings Panel: Configuring for personal requirements
Custom Settings Panel (Vanilla)	Custom Settings Panel with HTML render and custom navigation
Custom Settings Panel (Angular)	Angular component as a Custom Settings Panel
Custom Settings Panel (React)	React component as a Custom Settings Panel
Custom Settings Panel (Vue)	Vue component as a Custom Settings Panel
AdapTable Status Bar	Using the Status Bar in AdapTable
AdapTable and AG Grid Status Bars	Integrating AdapTable & AG Grid Status Bars
Status Bar replacing Dashboard	Using the Status Bar to replace the Dashboard
AdapTable Tool Panel: Introduction	Introducing the AdapTable Tool Panel Component
AdapTable Tool Panel: Configuration	Configuring the AdapTable Tool Panel Component
ToolPanel Module Buttons	Module Buttons in AdapTable ToolPanel
ToolPanel Custom Buttons	Custom Buttons in AdapTable ToolPanel
Custom Tool Panel: Using Buttons	Providing a Custom Tool Panel with AdapTable Buttons
Custom Tool Panel: Bespoke Content	Providing bespoke HTML in Custom Tool Panels (Vanilla)
Angular Components: Custom Tool Panels	Providing Angular Components as Custom Tool Panels
React Components as Custom Tool Panels	Providing React Components as Custom Tool Panels
Vue Components as Custom Tool Panels	Providing Vue Components as Custom Tool Panels
Module ToolPanels	Configuring Module ToolPanels
Using US English	Setting English Variant to US (in place of default GB)
Custom React Toolbars with state from context	Using React state in Custom Components
System Adaptable Icons	Leveraging System Icons in AdapTable
Custom Adaptable Icons	How to use Custom Icons in Adaptable Buttons
Element Icons	Providing Element Icons
Application Icon	Providing an Application Icon
Adaptable Style: Custom Palette	Customising the Colour Picker via theme CSS variables
Styling Editable Cells	Styling the Editable Grid Cells in AdapTable
Styling Read-Only Cells	Styling the Read-Only Grid Cells in AdapTable
Styling Edited Cells	Styling the Edited Grid Cells in AdapTable
Hiding AdapTable UI from Users	How to hide / show the AdapTable UI
Hiding AdapTable Mentions from Users	How to ensure users are unaware AdapTable is being used
Adaptable Style: Color Picker	Setting Colours for the AdapTable Style
Notifications in AdapTable	Keeping end users notified and updated
Toast Notifications	Configuring Toast Notifications