UI Framework ReferenceModifyItemsCommand

Class: ModifyItemsCommand

A command that changes properties of design elements in the editor. A command that changes properties of design elements in the editor.

For details, you can refer to the ICanvasDefinitionModifyItems.

{
  "type": "canvas",
  "name": "editor",
  "params": {
    "initial": { ... },
    "modifyItems": {
      "items": {
        "Name": {
          "value": "Neo"
        },
        "Company": {
          "value": "Matrix"
        }
      }
    }
  }
}
{
  "type": "design-editor",
  "name": "editor",
  "params": {
    "initial": { ... },
    "modifyItems": {
      "items": {
        "Name": {
          "value": "Neo"
        },
        "Company": {
          "value": "Matrix"
        }
      }
    }
  }
}

Hierarchy

Index

Methods

Methods

execute

execute(params: ICanvasDefinitionModifyItems, oldParams: ICanvasDefinitionModifyItems): Promise‹any›

Overrides CanvasWidgetCommand.execute

Defined in src/widgets/au-widget-canvas/Commands/modify-items-command.ts:37

Executes this command.

Parameters:

Name Type Description
params ICanvasDefinitionModifyItems Parameters for the command.
oldParams ICanvasDefinitionModifyItems The previous parameters for the command.

Returns:Promise‹any›