render_when_ready

Control exactly when your image gets rendered.

The render_when_ready parameter allows you total control over when the API generates the image for you.

Set the parameter to true and the API will wait to generate the screenshot until it sees an element on the page with the ID HCTIReadyNow.

For images generated with HTML/CSS, you can call the helper function ScreenshotReady(). This helper does not work for URL to Image.

Once ScreenshotReady() is called, an element with HCTIReadyNow will be added to the page. This will trigger the API to generate the image.

<div>Hello, world.</div>

<script>
  setTimeout(function(){ ScreenshotReady() }, 2000);
</script>

This will call ScreenshotReady() after 2 seconds. Delaying the API from generating the image.

When using URL to Image, you can trigger the rendering of the image by placing an element on the page with the ID HCTIReadyNow.

The JavaScript helper is not available for URL to Image, since we do not have full control over the page.

This parameter is most useful for images with complex JavaScript and you need the image generated at a specific time.

For most images, this will not be needed and the API will automatically take the image once all of the HTML is done loading.

Alternatively, the ms_delay parameter could be useful to you. It allows you to set a specific amount of time before the image is generated.