Adaptable Options is a large group of property options designed to help developers set up AdapTable at design time so that it fits their precise requirements.
It provides the Vendor Grid, Predefined Config and other information required to ensure a full, rich user experience.
This is the only object created that AdapTable requires to initialise and run; it is set up by developers at design-time and injected into the AdapTable constructor at startup.
AdaptableOptions class contains a few regular properties and a number of
xxxOptions properties where the type is itself a collection of related properties.
Typically you will only need to populate a few of the properties in AdaptableOptions, and just a few properties in the xxxOptions classes.
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.
|Base Options||The most important options e.g. Predefined Config, AdaptableId and Vendor Grid|
|Audit Options||Audit Log related options|
|Edit Options||Editing (and server-editing) related options|
|Filter Options||Options relating to filtering functionality in AdapTable|
|General Options||General set of Options (e.g. for managing Primary Keys|
|Layout Options||Layout (Views) related Options|
|Query Options||Options when running a Query / Expression in AdapTable|
|Search Options||Search-related options (e.g. for managing Server searching)|
|State Options||Series of functions to allow you to manage AdapTable State|
|Team Sharing Options||Enables 'Team Sharing' of AdapTable objects among colleagues|
|User Interface Options||User Interface related functions (e.g. menus, toolbars)|
|User Functions||Implementations of User Functions which are referenced in Config|
|Custom Predicate Def||Custom predicates provided by devs (e.g. for filters, alerts etc.)|
These options are used by the AdapTable plugins (e.g. charting, finance)
|Chart Options||Chart-based options (used when using chart plugin)|
|ipushpull Plugin Options||Options used by the ipushpull Plugin|
|Glue42 Plugin Options||Options used by the Glue42 Plugin|
|OpenFin Plugin Options||Options used by the OpenFin Plugin|
|Finsemble Plugin Options||Options used by the Finsemble Plugin|
|Master Detail Plugin Options||Options used by the Master / Detail Plugin|