VintaSoft Twain .NET SDK v10.2
getTile Method
Vintasoft.Shared Namespace > WebStorageImageSourceJS type : getTile Method
Zero-based index of image in image source.
X coordinate of tile on source image (X coordinate without scale).
Y coordinate of tile on source image (Y coordinate without scale).
The width, in pixels, of scaled tile.
The height, in pixels, of scaled tile.
The scale (horizontal and vertical) of image tile. Supported values: 0.1 - 10%, 1 - 100%, etc.
Indicates that rendered image tile 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 tile.
Syntax
var instance = new Vintasoft.Shared.WebStorageImageSourceJS(imageId, imageService, annotationService);
var value; // Type: object

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

value = instance.getTile(index, x, y, w, h, scale, useCache, renderingSettings, successFunc, errorFunc);
function getTile( 
   index : number,
   x : number,
   y : number,
   w : number,
   h : number,
   scale : object,
   useCache : boolean,
   renderingSettings : object,
   successFunc : object,
   errorFunc : object
) : object;

Parameters

index
Zero-based index of image in image source.
x
X coordinate of tile on source image (X coordinate without scale).
y
Y coordinate of tile on source image (Y coordinate without scale).
w
The width, in pixels, of scaled tile.
h
The height, in pixels, of scaled tile.
scale
The scale (horizontal and vertical) of image tile. Supported values: 0.1 - 10%, 1 - 100%, etc.
useCache
Indicates that rendered image tile 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.
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.

Return Value

Request object.
Browser Compatibility
9
5
11
5
See Also

Reference

WebStorageImageSourceJS type