Options
All
  • Public
  • Public/Protected
  • All
Menu

AdapTable Developer Documentation

Accessing AdapTable through code

These pages provide auto-generated Help for AdapTable and are very 'code-related'. For general overviews on AdapTable, and it's key concepts, see the Read Me Docs.

There are 3 primary ways that developers / users 'interact' with the code in AdapTable:

These 3 objects are linked as follows:

Predefined Configuration is a property of AdaptableOptions which is passed into the AdapTable constructor that returns the AdaptableApi

// Create an AdaptableOptions object to pass in to the constructor
 const adaptableOptions: AdaptableOptions = {
    primaryKey: 'tradeId', // a unique column
    vendorGrid: gridOptions, // the underlying vendor DataGrid
    predefinedConfig: applicationJSON, // the predefined config we created
  };

// The async AdapTable constructor returns a Promise
// this contains the Adaptable Api object for runtime access
 const adaptableApi: AdaptableApi = await Adaptable.init(adaptableOptions);

AdapTable Options

You use AdaptableOptions to set up AdapTable at design time so that it fits your requirements. There are 2 mandatory properties (primaryKey and vendorGrid) and a host of optional ones (including Predefined Config - see below). Where a property is not provided, AdapTable provides a default. The developer documentation lists all the available properties and their default values.

AdapTable Options Developer Documentation

Predefined Configuration

You can provide AdapTable at start-up with Predefined Configuration which ensures that when AdapTable first loads it contains all the bespoke objects that your users will need. This includes Entitlements.

Predefined Configuration Developer Documentation

AdapTable Api

AdapTable's api provides full safe, run-time access to all the functionality and state inside AdapTable. This allows you to create, save and delete AdapTable objects in your our screens bypassing AdapTable's UI, or to access the Store in a safe non-mutable manner.

AdapTable Api Developer Documentation

Additional Resources

You can find further information about AdapTable at these sites:

Generated using TypeDoc