VintaSoft Twain .NET SDK v10.2
Vintasoft.Shared Namespace / WebImageJS type / getTile Method
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.
Value indicating whether rendered image tile must be saved.
A format in which an image tile must be returned.
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 (string): Error message.
    • blocked (boolean): Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
In This Topic
    getTile Method
    In This Topic
    Sends an asynchronous request for rendering of image tile.
    Syntax
    var instance = new Vintasoft.Shared.WebImageJS(imageSource, pageIndex);
    var value; // Type: object
    
    // Parameters
    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 format; // Type:  object
    var successFunc; // Type:  object
    var errorFunc; // Type:  object
    
    value = instance.getTile(x, y, w, h, scale, useCache, format, successFunc, errorFunc);
    function getTile( 
       x : number,
       y : number,
       w : number,
       h : number,
       scale : object,
       useCache : boolean,
       format : object,
       successFunc : object,
       errorFunc : object
    ) : object;

    Parameters

    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
    Value indicating whether rendered image tile must be saved.
    format
    A format in which an image tile must be returned.
    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:
    • fileId (string): Image file identifier.
    • pos (object): Tile position on source image.
    • size (object): Tile size.
    • useCache (boolean): Indicates that the rendered image tile is saved on server.
    • scale (object): The scale (horizontal and vertical) of image tile.
    • image (object): An instance of Shared.WebImageJS class that represents the source image.
    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 (string): Error message.
      • blocked (boolean): 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

    WebImageJS type