Skip to main content

au-widget-design-editor/Commands/update-items

Classes​

UpdateItems​

Represents a DesignEditor action.

Extends​

Methods​

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

Executes a command.

Parameters​
ParameterTypeDescription
paramsIUpdateItemsCommandDefinitionParameters for the command.
Returns​

Promise<void>

Overrides​

DesignEditorWidgetCommand.execute

Interfaces​

IUpdateItemsCommandDefinition​

Provides the after property to support a queue of commands.

The following example illustrates how you can run the setViewerSettings command after setPrintArea completes.

{
  "widgets": [{
    "type": "design-editor",
    "name": "editor",
    "params": {
      "inital": { ... },
      "setViewerSettings": "{{vars.zoomSettings[$['flyer-size']._.title]}}",
      "setPrintArea": {
        "data": {
          "designFile": "{{$['flyer-gallery']._.name}}"
        },
        "after": [
          "setViewerSettings"
        ]
      }
    }
  }]
}

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

items​
items: object;
Index Signature​
[itemName: string]: object
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

selectorQueryOptions?​
optional selectorQueryOptions?: object;
flatGroupItems?​
optional flatGroupItems?: boolean;
includeMockups?​
optional includeMockups?: boolean;
includePlaceholderContents?​
optional includePlaceholderContents?: boolean;
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

useSelectors​
useSelectors: boolean;
Was this page helpful?