Using the AdapTable for AG Grid Documentation

Summary

  • Guide to this documentation - describes the contents of each section
  • Explains what regular pages mean (e.g. Using, Configuring, Technical Reference)
  • Information on the demos an videos included in the 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.

Important

  • These Help Pages support the latest version of AdapTable (22)
  • There is full documentation available for older AdapTable versions

The AdapTable documentation contains hundreds of help pages, demos & videos designed to help new users get up and running quickly with AdapTable, and for existing users to find

Feedback

  • This documentation is being continually expanded, and we aim to make it as comprehensive as possible
  • Please contact the AdapTable Team with any questions, suggestions and feedback

Sections

The documentation is divided into a number of sections:

  • Getting Started - everything you need to know to get up and running with AdapTable
  • Framework Versions - guides for using AdapTable React and AdapTable Angular
  • Layouts - creating Table and Pivot Layouts in order to manage Columns, Grouping, Aggregations etc
  • UI Components - guides to the Settings Panel, Dashboard, Tool Panel and Status Bar
  • 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, Seorting, 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 ipusphull, 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:

Technical Reference

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

Note

  • Some sections also have a "Using" page which explains what run-time users are able to do
  • It will typically include guides to using relevant wizards and explain how and where the feature can be accessed.

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.

Note

  • The majority of the demos show AdapTable using the dark Theme as that is generally the most popular
  • But this can be changed in each demo through the Settings Panel or Tool Panel

By default all the provided are written using plain AdapTable (Typescript), but they can also be run in the 3 Framewwork versions we provide:

Hint

  • Select the Framework to run the demos by clicking the React, Angular or Vue buttons at the top of the page
  • Additionally, each demo can be run separately and fully in a Sandbox

Find Out More

Learn more about the features provided in each demo (and a full list of demos) in the Documentation Demo Guide

Vidoes

The documentation also includes a number of videos that describe a particular feature or module.

Hint

Each video states which version of AdapTable was used to record it

Find Out More

See a full list of Videos included in the docs

Older Versions

AdapTable maintains versions of the documentation from AdapTable 12 onwards.

Find Out More

See the older versions of the AdapTable documentation

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.

PreviousWhat's NewNextRunning the Demos