Adaptable Options Reference

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

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

The AdaptableOptions class consists of a few 'base' properties and a number of xxxOptions properties which are themselves collections of related properties (e.g. Search, Layout).

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

Adaptable Options Contents

Plugin Options

Base Options

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

The properties in the root of Adaptable Options include:

Function Properties Context

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

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

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

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

Each context object derives from BaseContext object which contains 3 properties:

Run-Time Access

AdapTable makes run time access to Adaptable Options available via Options API in Adaptable API:

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

TypeScript Generics

Since AdapTable Version 15, Adaptable Options supports TypeScript Generics.

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

// Row Data interface
interface ICar {
  make: string;
  model: string;
  price: number;
}

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