Interface AsukaStateApi

State import/export helpers exposed through AsukaDesigner.util.

interface AsukaStateApi {
    clearStorage: ((options?: {
        key?: string;
    }) => void);
    exportFull: (() => AsukaExportedState);
    exportPart: ((part: AsukaStatePart) => AsukaExportedState);
    extractRuntimeLayoutAsConfig: ((layoutState?: any) => LayoutConfig);
    importFull: ((state: AsukaExportedState, options?: AsukaImportOptions) => void);
    importPart: ((part: AsukaStatePart, state: AsukaExportedState, options?: AsukaImportOptions) => void);
    loadFromStorage: ((options?: {
        key?: string;
    }) => null | AsukaExportedState);
    normalizeLayoutConfigToRuntimeState: ((config: LayoutConfig, fallbackState?: any) => any);
    rebuildActiveViewFromDocument: ((targetViewId?: null | string) => void);
    replaceProduct: ((state: AsukaExportedState, options?: {
        recreate?: boolean;
    }) => AsukaDesigner);
    saveToStorage: ((state: AsukaExportedState, options?: {
        key?: string;
    }) => void);
}

Properties

clearStorage exportFull exportPart extractRuntimeLayoutAsConfig importFull importPart loadFromStorage normalizeLayoutConfigToRuntimeState rebuildActiveViewFromDocument replaceProduct saveToStorage

Properties

clearStorage

clearStorage: ((options?: {
    key?: string;
}) => void)

Clear a previously persisted state payload from local storage.

exportFull

exportFull: (() => AsukaExportedState)

Export the complete serializable app state.

exportPart

exportPart: ((part: AsukaStatePart) => AsukaExportedState)

Export one named part such as template, theme, document, or pricing.

extractRuntimeLayoutAsConfig

extractRuntimeLayoutAsConfig: ((layoutState?: any) => LayoutConfig)

Convert runtime layout state back into init-time layout config.

importFull

importFull: ((state: AsukaExportedState, options?: AsukaImportOptions) => void)

Import a complete serializable app state.

importPart

importPart: ((part: AsukaStatePart, state: AsukaExportedState, options?: AsukaImportOptions) => void)

Import only one named part from a part export or a complete state payload.

loadFromStorage

loadFromStorage: ((options?: {
    key?: string;
}) => null | AsukaExportedState)

Load a canonical state payload from local storage.

normalizeLayoutConfigToRuntimeState

normalizeLayoutConfigToRuntimeState: ((config: LayoutConfig, fallbackState?: any) => any)

Convert init-time layout config into runtime layout state.

rebuildActiveViewFromDocument

rebuildActiveViewFromDocument: ((targetViewId?: null | string) => void)

Rebuild the active Fabric view from the current document store.

replaceProduct

replaceProduct: ((state: AsukaExportedState, options?: {
    recreate?: boolean;
}) => AsukaDesigner)

Replace the current product/session with a complete state payload.

saveToStorage

saveToStorage: ((state: AsukaExportedState, options?: {
    key?: string;
}) => void)

Save a canonical state payload to local storage.

Settings

Member Visibility

On This Page

Properties