VintaSoft Twain .NET SDK 15.4: Documentation for Web developer
Vintasoft.Shared Namespace / WebImageJS type / renderTiles Property
Syntax Exceptions BrowserCompatibility SeeAlso
In This Topic
renderTiles Method
In This Topic
Sends an asynchronous request for rendering of all image tiles.
Syntax
var instance = new Vintasoft.Shared.WebImageJS(imageSource, pageIndex);

var value; // Type: object

// Parameters
var tilesRenderingSettings; // Type: object
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.renderTiles(tilesRenderingSettings, successFunc, errorFunc);

Parameters

tilesRenderingSettings
Settings for rendering of image tiles.
An object with following properties:
  • width (number): The width, in pixels, of scaled tile. Required parameter.
  • height (number): The height, in pixels, of scaled tile. Required parameter.
  • scale (object): The scale (horizontal and vertical) of image tile. Supported values: 0.1 - 10%, 1 - 100%, etc. Optional parameter, default value is {x:1,y:1}.
  • format (object): An instance of WebImageTypeEnumJS class that defines a format in which an image tile must be returned. Optional parameter, default value is WebImageTypeEnumJS.Url
  • renderingSettings (object): WebRenderingSettingsJS object. Optional parameter, default value is WebImageJS.get_RenderingSettings of image.
  • decodingSettings (object): WebDecodingSettingsJS object. Optional parameter, default value is WebImageJS.get_DecodingSettings of image.
successFunc
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
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.
Exceptions
ExceptionDescription
Thrown if arguments have wrong types.
Browser Compatibility
9
See Also