You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IExternalResizeArgs Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure defining the Resize command parameters.

example

const args = {
    // Resize the canvas size to the A4 paper size.
    targetType: "product",
    targetIds: [],
    width: 595,
    height: 842,
    // Apply the Original mode to all containers.
    defaultOptions: {
        resize: 3
    }
};
// Run the resize command.
editor.commandManager.execute("resize", args);

Properties

Optional containerOptions

containerOptions: object

Resize options to be applied to a specific container.

containerOptions declaration

[key: string ]: IContainerResizeOptions

A dictionary holding the resize options. The key is the container name.

Optional defaultOptions

defaultOptions: IContainerResizeOptions

The default resize options to be applied to all containers.

height

height: number | string

The target height, in either points or percent relative to the print area. For example, 600 or "30%".

targetIds

targetIds: string []

An array of item identifiers.

targetType

targetType: "product" | "surfaces" | "items" | "printArea"

An object to be resized.

width

width: number | string

The target width, in either points or percent relative to the print area. For example, 600 or "30%".