Interface Editor.IFinishDesignResult

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

Package: @aurigma/design-editor-iframe

Examples

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

boundsData

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

Declaration

boundsData: {
            currentSurface: {
                Left: number;
                Top: number;
                Width: number;
                Height: number;
            };
        };

Property Value

Type	Description
{ currentSurface: { Left: number; Top: number; Width: number; Height: number; }; }	Coordinates of the rectangle bounding all items on the current surface, in points. For details, see the Calculating a print area topic.

hiResOutputUrls

An array of links to the hi-res output.

Declaration

hiResOutputUrls: string[];

Property Value

Type	Description
string[]	An array of links to the hi-res output.

proofImageUrls

An array of permanent links to proof images.

Declaration

proofImageUrls: string[][];

Property Value

Type	Description
string[][]	An array of permanent links to proof images.

returnToEditUrl

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

Declaration

returnToEditUrl: string;

Property Value

Type	Description
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

A product state identifier.

Declaration

stateId: string;

Property Value

Type	Description
string	A product state identifier.

userChanges

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

Declaration

userChanges: IUserChanges;

Property Value

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

userId

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.

Declaration

userId: string;

Property Value

Type	Description
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.

violationWarningData

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.

Declaration

violationWarningData: IViolationWarningData[];

Property Value

Type	Description
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.