AdaptableObject

View as Markdown

Fields shared by objects stored in Adaptable State.

Uuid identifies the object. Source is 'InitialState' when the object came from Initial State, and 'User' when it was created at runtime. IsReadOnly blocks edits even when the module entitlement is Full. IsSuspended, on objects that have it, turns the object off without deleting it.

TypeScript
export interface AdaptableObject extends
Extends

Identifiable

Properties

PropertyTypeDescription
AdaptableVersionAdaptableVersionCurrent AdapTable version
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
MetadataanyOptional metadata associated with the object; can be used to store additional information or configuration
Source'InitialState' | 'User'Source of state object: 'InitialState' if provided via AdaptableOptions.initialState, 'User' or undefined for runtime state
TagsAdaptableObjectTag[]List of Tags associated with the Object

Property Details

AdaptableVersion

Current AdapTable version

TypeScript
AdaptableVersion?: AdaptableVersion;
Property Value

AdaptableVersion

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

TypeScript
Tags?: AdaptableObjectTag[];
Property Value

AdaptableObjectTag[]