finishProductDesign Method

Callable

• finishProductDesign(options?: object ) : Promise < IFinishDesignResult >

• Saves the current product state and returns links to the hi-res output. For details, see the Introducing the IFrame API topic.

  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;
          preflightProblems = result.violationWarningData;
          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);
      });

  Parameters

  • Optional options: object

    Specifies the file name of the resulting high-resolution output, maximum width and height of proof images, and the state file name.

    • Optional fileName: string

      The name of the resulting file. This name is only used when you allow end-users directly downloading hi-res files using the links returned by the finishProductDesign method. The file name is combined with a file extension of configured output format. For example, if you pass business_card as a value of the argument and configure Customer's Canvas to save results in PDF, the result file name will be business_card.pdf

    • Optional proofMaxHeight: number

      The maximum height of proof images, in pixels. This value is 500 by default.

    • Optional proofMaxWidth: number

      The maximum width of proof images, in pixels. This value is 500 by default.

    • Optional stateId: string

      Specifies a state file name without an extension, up to 36 symbols length. If such a file exists, it will be overwritten. You can pass this parameter for any user except master and default. If you omit this parameter, then a new file name is generated.

  Returns Promise < IFinishDesignResult >

  Returns a promise with the resulting product details: the bounding rectangle, links to the hi-res output, permanent links to proof images, a return-to-edit URL, user changes, userId, and stateId.