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 underlying Vendor Grid, Predefined Config and other information required to ensure a full, rich user experience.
AdapTable Options contains behaviour and functionality that will never change at run-time.
Predefined Config contains objects that users can amend and delete through the AdapTable UI.
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.
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).
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||Most important options e.g. Predefined Config, AdaptableId & Vendor Grid|
|Alert Options||Options relating to Alerts|
|Container Options||Properties that set where divs and components are located|
|Dashboard Options||Options for managing the Dashboard in AdapTable|
|Edit Options||Editing (and server-editing) related options|
|Entitlements Options||Manages Module Entitlements in AdapTable|
|Export Options||Exporting and Report related Options|
|General Options||General set of Options (e.g. for managing Primary Keys|
|Layout Options||Layout (Views) related Options|
|Menu Options||Options for managing Adaptable Column and Context Menus|
|Search Options||Search, Filter & Query related options (e.g. for managing Server searching)|
|State Options||Series of functions to allow you to manage AdapTable State|
|System Status Options||Properties for displaying System Status Messages|
|Team Sharing Options||Enables 'Team Sharing' of AdapTable objects among colleagues|
|ToolPanel Options||Manage the AdapTable ToolPanel Component (that appears on right of grid)|
|User Interface Options||User Interface related functions (e.g. tool panels, toolbars)|
|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 plugin|
|ipushpull Plugin Options||ipushpull plugin|
|Glue42 Plugin Options||Glue42 plugin|
|OpenFin Plugin Options||OpenFin plugin|
|Finsemble Plugin Options||Finsemble plugin|
|Master Detail Plugin Options||Master Detail plugin|
Adaptable Options includes an Entitlements section, allowing developers to stipulate which AdapTable Modules users are allowed to access.
Entitlements can be set to 'Full', 'Hidden' or 'ReadOnly' and a default Entitlement can be provided.
Adaptable Options is where Team Sharing is configured and managed, that allows objects to be shared between colleagues.