VintaSoft Imaging .NET SDK v8.5
getThumbnail Method
Vintasoft.Shared Namespace > WebUrlImageSourceJS type : getThumbnail Method
Zero-based index of image in image source.
Thumbnail width in pixels.
Thumbnail height in pixels.
Indicates that rendered thumbnail must be saved in cache on server.
Optional parameter that represents the rendering settings of image.
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    • errorMessage: Error message.
    • blocked: Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
Sends an asynchronous request for rendering of image thumbnail.
Syntax
var instance = new Vintasoft.Shared.WebUrlImageSourceJS(fileUrl, imageService, annotationService);
var value; // Type: any

// Parameters
var index; // Type:  number
var w; // Type:  number
var h; // Type:  number
var useCache; // Type:  boolean
var renderingSettings; // Type:  object
var successFunc; // Type:  object
var errorFunc; // Type:  object

value = instance.getThumbnail(index, w, h, useCache, renderingSettings, successFunc, errorFunc);
function getThumbnail( 
   index : number,
   w : number,
   h : number,
   useCache : boolean,
   renderingSettings : object,
   successFunc : object,
   errorFunc : object
) : any;

Parameters

index
Zero-based index of image in image source.
w
Thumbnail width in pixels.
h
Thumbnail height in pixels.
useCache
Indicates that rendered thumbnail must be saved in cache on server.
renderingSettings
Optional parameter that represents the rendering settings of image.
successFunc
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
  • url: URL to an image file, which is stored on server.
  • imageParam: An object with information about image:
    • imageSize: An object that contains image width and height.
    • imageResolution: An object that contains image resolution.
    • pixelFormat: The image pixel format.
    • isVector: Indicates that the image has vector decoder.
errorFunc
Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    • errorMessage: Error message.
    • blocked: Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
Browser Compatibility
9
5
11
5
See Also

Reference

WebUrlImageSourceJS type