An array of indexes of images in image viewer. All images in viewer will be rendered if array is empty.

Function that will be executed if images are rendered successfully.
Here is function prototype "function __success()".

Function that will be executed if images are NOT rendered successfully. Here is function prototype "function __error(message)".
The message parameter contains information about an exception occurred during rendering.

Function that will be executed everytime when image is rendered successfully.
Here is function prototype "function __progress(data)".
The data parameter has the following properties:

rendered (number): A number of rendered images.

total (number): Total number of images.

cancelRendering (boolean): A value indicating that rendering was interrupted.

Function that will be executed if rendering is canceled.
Here is function prototype "function __cancel()".

Collapse AllExpand All

In This Topic

renderImages Method

In This Topic

Sends a request for asynchronous rendering of tiles of the specified images.

Parameters

An array of indexes of images in image viewer. All images in viewer will be rendered if array is empty.

successFunc

Function that will be executed if images are rendered successfully.
Here is function prototype "function __success()".

errorFunc

Function that will be executed if images are NOT rendered successfully. Here is function prototype "function __error(message)".
The message parameter contains information about an exception occurred during rendering.

progressFunc

Function that will be executed everytime when image is rendered successfully.
Here is function prototype "function __progress(data)".
The data parameter has the following properties:

rendered (number): A number of rendered images.

total (number): Total number of images.

cancelRendering (boolean): A value indicating that rendering was interrupted.

cancelFunc

Function that will be executed if rendering is canceled.
Here is function prototype "function __cancel()".