Interface Editor.IViewerSettings

Parameters of displaying the product on the canvas.

Package: @aurigma/design-editor-iframe

Remarks

Editor.setViewerSettings() takes these options.

Examples

// Changing the zoom and scroll position.
editor.setViewerSettings({zoom: 0.1, zoomMode: 'bestFit', scrollPosition: {x: 0, y: 0}})
    .catch(error => {
        console.error("Changing the canvas settings failed with exception: ", error);
    });

Properties

clearSelectionOnDocumentClick

Clears the selection when the user clicks the browser window. The default value is false.

Declaration

clearSelectionOnDocumentClick?: boolean;

Property Value

Type	Description
boolean	Clears the selection when the user clicks the browser window. The default value is false.

clearSelectionOnViewerClick

Clears the selection when the user clicks the canvas. The default value is false.

Declaration

clearSelectionOnViewerClick?: boolean;

Property Value

Type	Description
boolean	Clears the selection when the user clicks the canvas. The default value is false.

contentAngle

Defines the rotation angle for the content of placeholders.

Declaration

contentAngle?: number;

Property Value

Type	Description
number	Defines the rotation angle for the content of placeholders.

scrollingPosition

Scrolls the canvas to the specified point.

Declaration

scrollingPosition?: PointF;

Property Value

Type	Description
PointF	Scrolls the canvas to the specified point.

zoom

The zoom value.

Declaration

zoom?: number;

Property Value

Type	Description
number	The zoom value.

zoomMode

Zoom modes for displaying images.

Declaration

zoomMode?: ZoomMode;

Property Value

Type	Description
ZoomMode	Zoom modes for displaying images.