• Public
  • Public/Protected
  • All

Adaptable Blotter Code Documentation

Accessing Adaptable Blotter through code

There are 3 main ways that developers / users 'interact' with the code in the Adaptable Blotter:

  • Setting Blotter Options when instantianting the Adaptable Blotter

  • Providing the Adaptable Blotter at startup with Predefined Configuration

  • Using the Blotter API (at runtime) which gives full access to all the Adaptable Blotter functionality and state through code.

Blotter Options

See Blotter Options Code

You use the Blotter Options to set up the Adaptabble Blotter 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, the Adaptable Blotter provides a default. The code documentation lists all the available properties and their default values.

Predefined Configuration

See Predefined Configuration Code

You can provide the Adaptable Blotter at start-up with Predefined Configuration which ensures that when the Blotter first loads it contains all the objects that users need. This includes entitlements.

Blotter API

See Adaptable Blotter API Code

The Adaptable Blotter API provides full safe, run-time access - through code - to all the functionality and state of the Adaptable Blotter. This allows you to create, save and delete Adaptable Blotter objects in your our screens bypassing the Blotter's UI, or to access the Store in a safe non-mutable manner.

Additional Resources

You can find further information about the Adaptable Blotter at these sites:

Generated using TypeDoc