AdapTable Version:

Framework:

StateApi

Range of functions to access Initial and Full Adaptable State

TypeScript

export interface

Methods

Method	Description
copyAllStateToClipboard()	Copies all Adaptable state to clipboard
copyUserStateToClipboard()	Copies User State sections of Adaptable State to clipboard
dispatchStateReadyAction(module)	Sent by each Module when it is Ready
getAdaptableFilterState()	Gets filter-related sections of Adaptable State
getAdaptableSortState()	Gets sort-related sections of Adaptable State
getAlertState(returnJson)	Returns Alert section of Adaptable State
getAllState()	Retrieves ALL state which is currently stored by Adaptable (both persistent and transient/internal)
getApplicationState(returnJson)	Returns Application section of Adaptable State
getCalculatedColumnState(returnJson)	Returns Calculated Column section of Adaptable State
getChartingState(returnJson)	Returns Charting section of Adaptable State
getCustomSortState(returnJson)	Returns Custom Sort section of Adaptable State
getDashboardState(returnJson)	Returns Dashboard section of Adaptable State
getDescriptionForModule(adaptableModule)	Retrieves a brief description of an AdapTable Module
getExportState(returnJson)	Returns Export section of Adaptable State
getFlashingCellState(returnJson)	Returns Flashing Cell section of Adaptable State
getFormatColumnState(returnJson)	Returns Format Column section of Adaptable State
getFreeTextColumnState(returnJson)	Returns FreeText Column section of Adaptable State
getHelpPageForModule(adaptableModule)	Retrieves the help page for an AdapTable Module
getInitialState()	Returns the Initial Adaptable State
getLayoutState(returnJson)	Returns Layout section of Adaptable State
getNamedQueryState(returnJson)	Returns Query section of Adaptable State
getNoteState(returnJson)	Returns Note section of Adaptable State
getPersistentState()	Retrieves the persistent state in Adaptable, i.e. state that is passed to the `StateOptions.persistState()` function.
getPlusMinusState(returnJson)	Returns Plus Minus section of Adaptable State
getQuickSearchState(returnJson)	Returns Quick Search section of Adaptable State
getScheduleState(returnJson)	Returns Schedule section of Adaptable State
getShortcutState(returnJson)	Returns Shortcut section of Adaptable State
getStatusBarState(returnJson)	Returns StatusBar section of Adaptable State
getStyledColumnState(returnJson)	Returns StyledColumn section of Adaptable State
getThemeState(returnJson)	Returns Theme section of Adaptable State
getToolPanelState(returnJson)	Returns Tool Panel section of Adaptable State
getUserStateByStateKey(stateKey, returnJson)	Returns given section of Adaptable State (as JSON or object)
incrementUserStateRevision(stateKey)	Adds '1' to current revision number of State element
loadUserState(state)	Loads supplied user state, replacing (NOT merging) existing User(persisted) State.
persistAdaptableState()	Persists the current Adaptable State to storage.
reloadInitialState(newInitialState)	Reloads existing (or supplied) Initial State; clears persistent state by calling `StateOptions.clearState`
setAdaptableStateKey(adaptableStateKey, config)	Changes key used for persisting AdaptableState into localStorage; optionally provides an initialState to load

Method Details

copyAllStateToClipboard

Copies all Adaptable state to clipboard

TypeScript

copyAllStateToClipboard(): void;

Returns

void

copyUserStateToClipboard

Copies User State sections of Adaptable State to clipboard

TypeScript

copyUserStateToClipboard(): void;

Returns

void

dispatchStateReadyAction

Sent by each Module when it is Ready

TypeScript

dispatchStateReadyAction(module: AdaptableModule): void;

Parameters

Parameter	Type	Description
module	`AdaptableModule`	Module which is Ready

Returns

void

getAdaptableFilterState

Gets filter-related sections of Adaptable State

TypeScript

getAdaptableFilterState(): AdaptableFilterState;

Returns

AdaptableFilterState

getAdaptableSortState

Gets sort-related sections of Adaptable State

TypeScript

getAdaptableSortState(): AdaptableSortState;

Returns

AdaptableSortState

getAlertState

Returns Alert section of Adaptable State

TypeScript

getAlertState(returnJson?: boolean): AlertState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

AlertState

getAllState

Retrieves ALL state which is currently stored by Adaptable (both persistent and transient/internal)

TypeScript

getAllState(): AdaptableState;

Returns

AdaptableState

getApplicationState

Returns Application section of Adaptable State

TypeScript

getApplicationState(returnJson?: boolean): ApplicationState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

ApplicationState

getCalculatedColumnState

Returns Calculated Column section of Adaptable State

TypeScript

getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

CalculatedColumnState

getChartingState

Returns Charting section of Adaptable State

TypeScript

getChartingState(returnJson?: boolean): ChartingState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

ChartingState

getCustomSortState

Returns Custom Sort section of Adaptable State

TypeScript

getCustomSortState(returnJson?: boolean): CustomSortState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

CustomSortState

getDashboardState

Returns Dashboard section of Adaptable State

TypeScript

getDashboardState(returnJson?: boolean): DashboardState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

DashboardState

getDescriptionForModule

Retrieves a brief description of an AdapTable Module

TypeScript

getDescriptionForModule(adaptableModule: AdaptableModule): string;

Parameters

Parameter	Type	Description
adaptableModule	`AdaptableModule`	Adaptable Module to get description for

Returns

string

getExportState

Returns Export section of Adaptable State

TypeScript

getExportState(returnJson?: boolean): ExportState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

ExportState

getFlashingCellState

Returns Flashing Cell section of Adaptable State

TypeScript

getFlashingCellState(returnJson?: boolean): FlashingCellState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

FlashingCellState

getFormatColumnState

Returns Format Column section of Adaptable State

TypeScript

getFormatColumnState(returnJson?: boolean): FormatColumnState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

FormatColumnState

getFreeTextColumnState

Returns FreeText Column section of Adaptable State

TypeScript

getFreeTextColumnState(returnJson?: boolean): FreeTextColumnState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

FreeTextColumnState

getHelpPageForModule

Retrieves the help page for an AdapTable Module

TypeScript

getHelpPageForModule(adaptableModule: AdaptableModule): string;

Parameters

Parameter	Type	Description
adaptableModule	`AdaptableModule`	Adaptable Module to get help page for

Returns

string

getInitialState

Returns the Initial Adaptable State

TypeScript

getInitialState(): InitialState | any;

Returns

InitialState | any

getLayoutState

Returns Layout section of Adaptable State

TypeScript

getLayoutState(returnJson?: boolean): LayoutState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

LayoutState

getNamedQueryState

Returns Query section of Adaptable State

TypeScript

getNamedQueryState(returnJson?: boolean): NamedQueryState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

NamedQueryState

getNoteState

Returns Note section of Adaptable State

TypeScript

getNoteState(returnJson?: boolean): NoteState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

NoteState

getPersistentState

Retrieves the persistent state in Adaptable, i.e. state that is passed to the StateOptions.persistState() function.

TypeScript

getPersistentState(): AdaptablePersistentState;

Returns

AdaptablePersistentState

getPlusMinusState

Returns Plus Minus section of Adaptable State

TypeScript

getPlusMinusState(returnJson?: boolean): PlusMinusState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

PlusMinusState

getQuickSearchState

Returns Quick Search section of Adaptable State

TypeScript

getQuickSearchState(returnJson?: boolean): QuickSearchState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

QuickSearchState

getScheduleState

Returns Schedule section of Adaptable State

TypeScript

getScheduleState(returnJson?: boolean): ScheduleState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

ScheduleState

getShortcutState

Returns Shortcut section of Adaptable State

TypeScript

getShortcutState(returnJson?: boolean): ShortcutState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

ShortcutState

getStatusBarState

Returns StatusBar section of Adaptable State

TypeScript

getStatusBarState(returnJson?: boolean): StatusBarState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

StatusBarState

getStyledColumnState

Returns StyledColumn section of Adaptable State

TypeScript

getStyledColumnState(returnJson?: boolean): StyledColumnState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

StyledColumnState

getThemeState

Returns Theme section of Adaptable State

TypeScript

getThemeState(returnJson?: boolean): ThemeState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

ThemeState

getToolPanelState

Returns Tool Panel section of Adaptable State

TypeScript

getToolPanelState(returnJson?: boolean): ToolPanelState;

Parameters

Parameter	Type	Description
returnJson	`boolean`	return as JSON rather than object

Returns

ToolPanelState

getUserStateByStateKey

Returns given section of Adaptable State (as JSON or object)

TypeScript

getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): BaseState | string;

Parameters

Parameter	Type	Description
stateKey	`AdaptableStateKey`	section of State to return
returnJson	`boolean`	whether to return section as JSON or object

Returns

BaseState | string

incrementUserStateRevision

Adds '1' to current revision number of State element

TypeScript

incrementUserStateRevision(stateKey: AdaptableStateKey): void;

Parameters

Parameter	Type	Description
stateKey	`AdaptableStateKey`	Adaptable State Key to update

Returns

void

loadUserState

Loads supplied user state, replacing (NOT merging) existing User(persisted) State.

TypeScript

loadUserState(state: InitialState): void;

Parameters

Parameter	Type	Description
state	`InitialState`

Returns

void

persistAdaptableState

Persists the current Adaptable State to storage.

This method first calls StateOption.saveState() to prepare the state and then StateOptions.persistState() to save it to the configured storage.

TypeScript

persistAdaptableState(): Promise<AdaptableState>;

Returns

Promise<AdaptableState>

reloadInitialState

Reloads existing (or supplied) Initial State; clears persistent state by calling StateOptions.clearState

TypeScript

reloadInitialState(newInitialState?: InitialState): void;

Parameters

Parameter	Type	Description
newInitialState	`InitialState`	optional new InitialState to load

Returns

void

setAdaptableStateKey

Changes key used for persisting AdaptableState into localStorage; optionally provides an initialState to load

TypeScript

setAdaptableStateKey(adaptableStateKey: string, config?: {
        initialState?: InitialState;
        flushCurrentState?: boolean;
        progressIndicatorLabel?: string;
    }): Promise<void>;

Parameters

Parameter	Type	Description
adaptableStateKey	`string`	key for persisting the AdaptableState into localStorage
config	`\{ initialState?:InitialState; flushCurrentState?: boolean; progressIndicatorLabel?: string; \}`

Returns

Promise<void>

PreviousSpecialColumnSettings NextStateOptions