getProofImages Method

Callable

• getProofImages(options?: object ) : Promise < IProofResult >

• Renders proof images with the optional maximum width and height. For details, see the Introducing the IFrame API topic.

  example

  // Getting links to proof images.
  editor.getProofImages({maxHeight: 720, maxWidth: 720})
      // If the links to proof images were generated successfully.
      .then(function (result) {
          // Get the links from the promise properties.
          proofImageUrls = result.proofImageUrls;
      })
      // If there was an error thrown while getting links to proof images.
      .catch(function (error) {
          console.error("Getting proof images failed with exception: ", error);
      });

  Parameters

  • Optional options: object

    The maximum width and height of proof images, in pixels. For example, if the maximum width and height are both set to 640 pixels, then a 1280 x 960 px image will be resized to 640 x 480 px. When using mockups, specify the size of proof images more than or equal to the preview mockup size to avoid loss of the image quality.

    • Optional maxHeight: number

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

    • Optional maxWidth: number

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

  Returns Promise < IProofResult >

  Returns an array of temporary links to proof images.