Class SetViewerSettings

A command that defines the canvas zoom. A command that defines the canvas zoom. For details, you can refer to ICanvasDefinitionSetViewerSettings.

{
  "type": "canvas",
  "name": "editor",
  "params": {
    "initial": { ... },
    "setViewerSettings": {
      "zoom": 0.1,
      "zoomMode": 'bestFit',
      "scrollPosition": {x: 0, y: 0}
    }
  }
}

For details, you can refer to IDesignEditorDefinitionSetViewerSettings.

{
  "type": "design-editor",
  "name": "editor",
  "params": {
    "initial": { ... },
    "setViewerSettings": {
      "zoom": 0.1,
      "zoomMode": 'bestFit',
      "scrollPosition": {x: 0, y: 0}
    }
  }
}

Package: ui-framework

Properties

Name

Declaration

static Name: "setViewerSettings" = "setViewerSettings"

Property Value

Type	Description
"setViewerSettings"

name

Declaration

string name

Property Value

Type	Description
string

Methods

execute(ICanvasDefinitionSetViewerSettings)

Executes this command.

Declaration

function execute(params: ICanvasDefinitionSetViewerSettings)

Parameters

Type	Name	Description
ICanvasDefinitionSetViewerSettings	params	Parameters for the command.

Returns

Type	Description
Promise<any>