Skip to main content

Interface: IFinishDesignResult

A structure used by (Editor:class).finishProductDesign to store a return value.

Example​

let renderingResult = await editor
  .finishProductDesign()
  // If an error occurred while completing product customization.
  .catch((error) =>
    console.error(
      "Completing product customization failed with exception: ",
      error,
    ),
  );

// When product customization has been completed successfully, get the promise properties.
let stateId = renderingResult.stateId;
let userId = renderingResult.userId;
let userChanges = renderingResult.userChanges;
console.log("Text user changes: ", userChanges.texts);

Properties​

proofImageUrls​

proofImageUrls: string[][]

An array of permanent links to proof images.

hiResOutputUrls​

hiResOutputUrls: string[]

An array of links to the hi-res output.

returnToEditUrl​

returnToEditUrl: string

A return-to-edit URL. This property is provided for backward compatibility only; it utilizes the old API based on a query string.

stateId​

stateId: string

A product state identifier.

userId​

userId: string

The identifier of the user who currently works with the editor. Note that you can not use custom file names for saving states, working under the default user or the master user.

userChanges​

userChanges: IUserChanges

Returns an object containing all changes made by the user when personalizing the product.

boundsData​

boundsData: object

Coordinates of the rectangle bounding all items on the current surface, in points. For details, see the Calculating a print area topic.

currentSurface​

currentSurface: object

Width, height, and upper-left corner coordinates of the bounding rectangle of all items in the current surface, in points.

currentSurface.Left​

Left: number

X-coordinate of the upper-left corner of bounding rectangle (relative to the print area).

currentSurface.Top​

Top: number

Y-coordinate of the upper-left corner of bounding rectangle (relative to the print area).

currentSurface.Width​

Width: number

Width of the bounding rectangle.

currentSurface.Height​

Height: number

Height of the bounding rectangle.

violationWarningData​

violationWarningData: IViolationWarningData[]

For items having preflight problems, it provides the item name, item type, corresponding surface name and index, and states of violation warnings. This array allows for detecting products that have violations of the image resolution, safety lines, regions, and text clipping.

Was this page helpful?