VintaSoft Imaging .NET SDK v8.6
Vintasoft.Imaging.Svg Namespace / WebImageViewerJS type / renderImages Method
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:
Function that will be executed if rendering is canceled.
Here is function prototype "function __cancel()".
In This Topic
    renderImages Method
    In This Topic
    Sends a request for asynchronous rendering of tiles of the specified images.
    Syntax
    var instance = new Vintasoft.Imaging.Svg.WebImageViewerJS(controlId);
    var value; // Type: any
    
    // Parameters
    var indexes; // Type:  object
    var successFunc; // Type:  object
    var errorFunc; // Type:  object
    var progressFunc; // Type:  object
    var cancelFunc; // Type:  object
    
    value = instance.renderImages(indexes, successFunc, errorFunc, progressFunc, cancelFunc);
    function renderImages( 
       indexes : object,
       successFunc : object,
       errorFunc : object,
       progressFunc : object,
       cancelFunc : object
    ) : 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): A value indicating that rendering was interrupted.
    cancelFunc
    Function that will be executed if rendering is canceled.
    Here is function prototype "function __cancel()".
    Browser Compatibility
    9
    5
    11
    5
    See Also