@adaptabletools/adaptable
Version:
Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
71 lines (70 loc) • 4.2 kB
TypeScript
import { ThemeState } from '../../AdaptableState/ThemeState';
import { ShortcutState } from '../../AdaptableState/ShortcutState';
import { QuickSearchState } from '../../AdaptableState/QuickSearchState';
import { PlusMinusState } from '../../AdaptableState/PlusMinusState';
import { LayoutState } from '../../AdaptableState/LayoutState';
import { FormatColumnState } from '../../AdaptableState/FormatColumnState';
import { ExportState } from '../../AdaptableState/ExportState';
import { DashboardState } from '../../AdaptableState/DashboardState';
import { CustomSortState } from '../../AdaptableState/CustomSortState';
import { CalculatedColumnState } from '../../AdaptableState/CalculatedColumnState';
import { AlertState } from '../../AdaptableState/AlertState';
import { BaseState } from '../../AdaptableState/BaseState';
import { AdaptablePersistentState, AdaptableState } from '../../AdaptableState/AdaptableState';
import { ApiBase } from './ApiBase';
import { ApplicationState } from '../../AdaptableState/ApplicationState';
import { FreeTextColumnState } from '../../AdaptableState/FreeTextColumnState';
import { ToolPanelState } from '../../AdaptableState/ToolPanelState';
import { StateApi } from '../StateApi';
import { AdaptableModule, AdaptableStateKey } from '../../AdaptableState/Common/Types';
import { AdaptableFilterState, AdaptableSortState, FlashingCellState, InitialState, NamedQueryState, StatusBarState, StyledColumnState } from '../../types';
import { ChartingState } from '../../AdaptableState/ChartingState';
import { NoteState } from '../../AdaptableState/NoteState';
import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
import { StateInternalApi } from '../Internal/StateInternalApi';
export declare class StateApiImpl extends ApiBase implements StateApi {
internalApi: StateInternalApi;
constructor(_adaptable: IAdaptable);
configInit(): void;
copyAllStateToClipboard(): void;
copyUserStateToClipboard(): void;
getInitialState(): InitialState | any;
reloadInitialState(newInitialState?: InitialState): Promise<void>;
getAllState(): AdaptableState;
getPersistentState(): AdaptablePersistentState;
getAllUserState(): BaseState[];
loadUserState(state: InitialState): void;
getAdaptableFilterState(): AdaptableFilterState;
getAdaptableSortState(): AdaptableSortState;
setAdaptableStateKey(adaptableStateKey: string, config?: {
initialState?: InitialState;
flushCurrentState?: boolean;
progressIndicatorLabel?: string;
}): Promise<void>;
persistAdaptableState(): Promise<AdaptableState>;
getDescriptionForModule(module: AdaptableModule): string;
getHelpPageForModule(module: AdaptableModule): string;
getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): BaseState | string;
incrementUserStateRevision(stateKey: AdaptableStateKey): void;
getAlertState(returnJson?: boolean): AlertState;
getApplicationState(returnJson?: boolean): ApplicationState;
getCalculatedColumnState(returnJson?: boolean): CalculatedColumnState;
getChartingState(returnJson?: boolean): ChartingState;
getNoteState(returnJson?: boolean): NoteState;
getCustomSortState(returnJson?: boolean): CustomSortState;
getDashboardState(returnJson?: boolean): DashboardState;
getExportState(returnJson?: boolean): ExportState;
getFreeTextColumnState(returnJson?: boolean): FreeTextColumnState;
getFormatColumnState(returnJson?: boolean): FormatColumnState;
getFlashingCellState(returnJson?: boolean): FlashingCellState;
getLayoutState(returnJson?: boolean): LayoutState;
getPlusMinusState(returnJson?: boolean): PlusMinusState;
getNamedQueryState(returnJson?: boolean): NamedQueryState;
getQuickSearchState(returnJson?: boolean): QuickSearchState;
getShortcutState(returnJson?: boolean): ShortcutState;
getStatusBarState(returnJson?: boolean): StatusBarState;
getStyledColumnState(returnJson?: boolean): StyledColumnState;
getThemeState(returnJson?: boolean): ThemeState;
getToolPanelState(returnJson?: boolean): ToolPanelState;
dispatchStateReadyAction(module: AdaptableModule): void;
}