AdaptableObject
Base interface which all other Adaptable State-related objects extend
TypeScript
export interface AdaptableObject extendsExtends
Properties
| Property | Description |
|---|---|
| AdaptableVersion | Current AdapTable version |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| Metadata | Optional metadata associated with the object; can be used to store additional information or configuration |
| Source | Source of state object: 'InitialState' if provided via AdaptableOptions.initialState, 'User' or undefined for runtime state |
| Tags | List of Tags associated with the Object; often used for extending Layouts |
Property Details
AdaptableVersion
Current AdapTable version
TypeScript
AdaptableVersion?: AdaptableVersion;Property Value
IsReadOnly
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
TypeScript
IsReadOnly?: boolean;Property Value
boolean
Metadata
Optional metadata associated with the object; can be used to store additional information or configuration
TypeScript
Metadata?: any;Property Value
any
Source
Source of state object: 'InitialState' if provided via AdaptableOptions.initialState, 'User' or undefined for runtime state
TypeScript
Source?: 'InitialState' | 'User';Property Value
'InitialState' | 'User'
Tags
List of Tags associated with the Object; often used for extending Layouts
TypeScript
Tags?: AdaptableObjectTag[];