UI Framework ReferenceICanvasDefinitionChangeLayout

Interface: ICanvasDefinitionChangeLayout

Provides properties to replace design elements in the editor.

For details, you can refer to the ChangeLayout command.

{
  "type": "canvas",
  "name": "editor",
  "params": {
    "initial": { ... },
    "changeLayout": [{
      "discardChanges": false,
      "data": {
        "printAreas": [{
          "designFile": "{{'flyer/'+$['layout']._.props.design}}"
        }]
      }
    }]
  }
}

Hierarchy

Index

Properties

Properties

Optional after

after? : string | string[]

Inherited from ICanvasCommandDefinition.after

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:30

The next commands to be executed after this command completes.


data

data: any

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:202

A product definition.


Optional dimesions

dimesions? : SurfaceDimensionsValue

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:208

If the layout and the currently loaded product have different dimensions, you can enable the size of either config or canvas, correspondingly.


Optional discardChanges

discardChanges? : boolean

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:200

If true, a design always loaded from scratch. if false or omitted, merges placeholders and text elements.


removeBackground

removeBackground: boolean

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:206

If true, removes the background image.


Optional sourceSurfaceIndex

sourceSurfaceIndex? : number

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:198

Specifies what page to be used as a layout if data refers to a multipage template.


Optional surfaceIndex

surfaceIndex? : number

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:196

The index of a surface that should be modified (the current surface if omitted).


Optional viewerSettings

viewerSettings? : ICanvasDefinitionSetViewerSettings

Defined in src/widgets/au-widget-canvas/IAuWidgetCanvas.ts:204

Zoom properties.