AdaptableStateFunctionConfig

State Function Config object passed into all State Options functions

TypeScript

export interface

Properties

Property	Type	Description
actionName	`string`	Name of the action that triggered the state change.
adaptableApi	`AdaptableApi`	Adaptable API
adaptableContext	`any`	Custom application Context provided in `AdaptableOptions.adaptableContext`
adaptableId	`string`	Id of current Adaptable instance
adaptableStateKey	`string`	State Key being used
previousState	`AdaptableState`	Previous state before the action was applied. This is useful for comparing changes or reverting if necessary.
userName	`string`	current Adaptable user

Name of the action that triggered the state change.

TypeScript

actionName?: string;

string

Adaptable API

TypeScript

adaptableApi: AdaptableApi;

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript

adaptableContext: any;

any

Id of current Adaptable instance

TypeScript

adaptableId: string;

string

State Key being used

TypeScript

adaptableStateKey: string;

string

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

TypeScript

previousState?: AdaptableState;

current Adaptable user

TypeScript

userName: string;

string