Base Options

These properties are in the root of Adaptable Options and include the most important settings for AdapTable.

Contents

OptionDetails
adaptableIdA unique Id for this instance of AdapTable
adaptableStateKeyA localStorage key for storing of AdaptableState
predefinedConfigUser State shipped with AdapTable instance for first use
primaryKeyName of a column guaranteed to contain unique contents (mandatory)
userNameThe current AdapTable user (useful for Audit purposes)
vendorGridUnderlying vendor grid instance, e.g.GridOptions for ag-Grid (mandatory in Core)

adaptableId

This is the identifier for the current instance of AdapTable

tip

This property is particularly useful if Audit Log is turned on, you are saving state remotely, or you are using multiple grids

If no value is supplied then the value will default to 'adaptable_id'

caution

The value for this property should not contain a '.' (as this value is used to name styles which raises issues if it contains a full stop).

note

The value provided here is also that used in the Dashboard Header if no value is supplied for HomeToolbarTitle in Dashboard State

adaptableStateKey

This is the identifier to be used as the localStorage persistence key for the AdaptableState.

note

If no value is provided for this property then the adaptableId property value (see above) is used

predefinedConfig

Predefined Config is User State configured and provided at design-time and shipped with AdapTable for first use.

It contains a mixture of objects and properties.

important

The supplied value can be either a PredefinedConfig object or a url to the file which contains the config.

primaryKey

The name of a column in AdapTable guaranteed to contain unique values.

warning

This is a mandatory property

A Primary Key is required for cell identification purpose when using cell summary and editing functions and is also used by Audit Log to identify which cells have been edited.

caution

The column does not need to be visible but it does need to exist in the grid's data source.

tip

If the ​​​showMissingPrimaryKeyWarning ​​property is true in General Options (the default value), AdapTable will warn at start-up if there is no column in the grid which matches the provided value.

note

Cell Validation and Alert Functions both contain a PrimaryKeyDuplicate Predicate which will trigger when an already existing value is entered in the Primary Key column.

userName

The name of the current AdapTable user.

tip

Set this if using remote storage (via Server Options) to identify the current user

The property is also used in Audit Log to identify the user who has made edits or changed state.

vendorGrid

The underlying vendor grid or grid object which AdapTable will interact with.

important

If using ag-Grid this is the GridOoptions object

The object should contain all the column definitions and data sources required.

warning

This is a mandatory property

caution

If using the React or Angular Wrapper, there is no need to populate this property (as gridOptions is a separate propery and AdapTable will wire up everything internally).