AdapTable Types Reference

AdaptableStateFunctionConfig

State Function Config object passed into all State Options functions

TypeScript
export interface

Properties

PropertyDescription
actionNameName of the action that triggered the state change.
adaptableApiAdaptable API
adaptableContextCustom application Context provided in AdaptableOptions.adaptableContext
adaptableIdId of current Adaptable instance
adaptableStateKeyState Key being used
previousStatePrevious state before the action was applied. This is useful for comparing changes or reverting if necessary.
userNamecurrent Adaptable user

Property Details

actionName

Name of the action that triggered the state change.

TypeScript
actionName?: string;
Property Value

string

adaptableApi

Adaptable API

TypeScript
adaptableApi: AdaptableApi;
Property Value

AdaptableApi

adaptableContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript
adaptableContext: any;
Property Value

any

adaptableId

Id of current Adaptable instance

TypeScript
adaptableId: string;
Property Value

string

adaptableStateKey

State Key being used

TypeScript
adaptableStateKey: string;
Property Value

string

previousState

Previous state before the action was applied. This is useful for comparing changes or reverting if necessary.

TypeScript
previousState?: AdaptableState;
Property Value

AdaptableState

userName

current Adaptable user

TypeScript
userName: string;
Property Value

string

PreviousAdaptableStateChangedInfoNextAdaptableStateReloadedInfo