Config API

Contains multiple methods for managing - and primarily retrieving - User State

See Adaptable State Guide for full details of this topic.

Config API Methods

MethodDescription
configInit()Initialised Adaptable State (for internal use only)
copyAllStateToClipboard()Copies all Adaptable state to clipboard
copyUserStateToClipboard()Copies User State sections of Adaptable State to clipboard
getActionColumnState(returnJson)Returns ActionColumn section of Adaptable State
getAdaptableSearchState()Gets search-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 User and internal)
getAllUserState()Retrieves the PERSISTED state in Adaptable
getApplicationState(returnJson)Returns Application section of Adaptable State
getBulkUpdateState(returnJson)Returns Bulk Update section of Adaptable State
getCalculatedColumnState(returnJson)Returns Calculated Column section of Adaptable State
getCalendarState(returnJson)Returns Calendar section of Adaptable State
getCellSummaryState(returnJson)Returns Cell Summary section of Adaptable State
getCellValidationState(returnJson)Returns Cell Validation section of Adaptable State
getChartState(returnJson)Returns Chart section of Adaptable State
getConditionalStyleState(returnJson)Returns Conditional Style section of Adaptable State
getCustomSortState(returnJson)Returns Custom Sort section of Adaptable State
getDashboardState(returnJson)Returns Dashboard section of Adaptable State
getDataSourceState(returnJson)Returns Data Source section of Adaptable State
getEntitlementState(returnJson)Returns Entitlement section of Adaptable State
getExportState(returnJson)Returns Export section of Adaptable State
getFilterState(returnJson)Returns Filter section of Adaptable State
getFlashingCellState(returnJson)Returns Flashing Cell section of Adaptable State
getFormatColumnState(returnJson)Returns Formt Column section of Adaptable State
getFreeTextColumnState(returnJson)Returns FreeText Column section of Adaptable State
getGradientColumnState(returnJson)Returns Gradient Column section of Adaptable State
getLayoutState(returnJson)Returns Layout section of Adaptable State
getPercentBarState(returnJson)Returns Percent Bar section of Adaptable State
getPlusMinusState(returnJson)Returns Plus Minus section of Adaptable State
getPredefinedConfig()Returns current Predefined Config
getQueryState(returnJson)Returns Query 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
getSmartEditState(returnJson)Returns Smart Edit section of Adaptable State
getSparklineColumnState(returnJson)Returns Sparkline Column section of Adaptable State
getSystemStatusState(returnJson)Returns System Status section of Adaptable State
getThemeState(returnJson)Returns Theme section of Adaptable State
getToolPanelState(returnJson)Returns Tool Panel section of Adaptable State
getUpdatedRowState(returnJson)Returns Updated Row section of Adaptable State
getUserInterfaceState(returnJson)Returns User Interface section of Adaptable State
getUserStateByStateKey(stateKey, returnJson)Returns given section of Adaptable State (as JSON or object)
loadUserState(state)Loads supplied user state, replacing (not merging) existing User State.
reloadPredefinedConfig(newPredefinedConfig)Reloads either existing or supplied Predefined Config; deletes local storage and calls clearState function for remote storage removal
setAdaptableStateKey(adaptableStateKey, config)Changes the key used for persisting the Adaptablestate into localStorage

See API documentation for full details of all available functions with lists of parameters