Skip to main content

au-widget-design-editor/Commands/swap-surfaces-command

Classes​

SwapSurfacesCommand​

Swaps two surfaces (pages) in the product.

Here, we swap the first page of the loaded product with the second page.

{
  "type": "design-editor",
  "name": "editor",
  "params": {
    "initial": { ... },
    "swapSurfaces": `[{
        "lhsSurfaceIndex": 0,
        "rhsSurfaceIndex": 1,
    }]`
  }
}

Extends​

Methods​

execute()​
execute(params): Promise<void>;

Executes this command.

Parameters​
ParameterTypeDescription
params| ISwapSurfacesCommandDefinition | ISwapSurfacesCommandDefinition[]Parameters for the command.
Returns​

Promise<void>

Overrides​

DesignEditorWidgetCommand.execute

Interfaces​

ISwapSurfacesCommandDefinition​

Provides properties for swapping surfaces through the swapSurfaces command.

Extends​

Properties​

after?​
optional after?: string | string[];

The next commands to be executed after this command completes.

Inherited from​

IDesignEditorCommandDefinition.after

autoCompile?​
optional autoCompile?: boolean;

If false, action will never execute automatically.

Inherited from​

IDesignEditorCommandDefinition.autoCompile

executeOnce?​
optional executeOnce?: boolean;

If true, this command will be executed only once. You can use it for initial command. For example, we need to change surface depending on the option value. We write for initial and for updateSurfaces the same productDefinition with $['option]._ And set executeOnce = true for initial. And initial will be executed only once.

Inherited from​

IDesignEditorCommandDefinition.executeOnce

executeOnlyAfter?​
optional executeOnlyAfter?: string[];

Current command will be executed in a next update only after all commands executed in this param. The same example from executeOnce param. We need to execute updateSurface on all next updates, exclude the first one. And we set executeOnlyAfter = ['initial'] for updateSurface command.

Inherited from​

IDesignEditorCommandDefinition.executeOnlyAfter

lhsSurfaceIndex​
lhsSurfaceIndex: number;

Index of the first surface (page) to swap.

lock?​
optional lock?: string[];

Name of widgets that show preloader when command executed.

Inherited from​

IDesignEditorCommandDefinition.lock

message?​
optional message?: string | string[];

The message for preloader.

Inherited from​

IDesignEditorCommandDefinition.message

onExecuted?​
optional onExecuted?: Function | Function[];

Functions that executed after command

Inherited from​

IDesignEditorCommandDefinition.onExecuted

rhsSurfaceIndex​
rhsSurfaceIndex: number;

Index of the second surface (page) to swap.

showPreloader?​
optional showPreloader?: boolean;

If true, displays the preloader while executing this command.

Inherited from​

IDesignEditorCommandDefinition.showPreloader

timeout?​
optional timeout?: number;

The timeout for switching preloader messages.

Inherited from​

IDesignEditorCommandDefinition.timeout

Was this page helpful?