renderImages Method

In This Topic

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

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.UI.WebImageViewerJS(controlId);

var value; // Type: any

// Parameters
var indexes; // Type: number[]
var successFunc; // Type: function
var errorFunc; // Type: function
var progressFunc; // Type: function
var cancelFunc; // Type: function

value = instance.renderImages(indexes, successFunc, errorFunc, progressFunc, cancelFunc);

function renderImages(
   indexesAn array of indexes of images in image viewer. All images in viewer will be rendered if array is empty.
 : number[], 
   successFuncFunction that will be executed if images are rendered successfully.
 Here is function prototype "function __success()".
 : Function, 
   errorFuncFunction 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, 
   progressFuncFunction 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): Indicates that rendering was interrupted.
 
 : Function, 
   cancelFuncFunction that will be executed if rendering is canceled.
 Here is function prototype "function __cancel()".
 : Function
) : any;

Parameters

indexes

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): Indicates that rendering was interrupted.

cancelFunc

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

Exceptions

Exception	Description
	Thrown if arguments have wrong types.
	Thrown if method was called when the initialization occurred.

Browser Compatibility

56+

45+

Reference

WebImageViewerJS Class
WebImageViewerJS Members

Send Feedback