IOutOfRegionItemData Interface

A structure containing details about objects that go out of the region.

example
// Completing product customization.
editor.finishProductDesign()
    // If product customization is completed successfully.
    .then(function (result) {
        // Get the promise properties.
        hiResOutputUrls = result.hiResOutputUrls;
        proofImageUrls = result.proofImageUrls;
        stateId = result.stateId;
        userId = result.userId;
        returnToEditUrl = result.returnToEditUrl;
        boundsData = result.boundsData;
        userChanges = result.userChanges;
        outOfRegionItems = result.outOfRegionItemData;
        console.log("User " + userId + " successfully saved state " + stateId);
    })
    // If there was an error thrown when completing product customization.
    .catch(function (error) {
        console.error("Completing product customization failed with exception: ", error);
    });

Properties

name

name: string

The name of the item that goes out of the region.

surfaceIndex

surfaceIndex: number

The index of the surface, which contains the out-of-region item.

surfaceName

surfaceName: string

The name of the surface, which contains the out-of-region item.

type

type: string

The type of the item that goes out of the region.