burnAnnotationCollection Method

In This Topic

Burns annotation collection on image.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.Annotation.WebAnnotationViewControllerJS(images);

var value; // Type: any

// Parameters
var image; // Type: WebImageJS
var changeSourceFile; // Type: boolean
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.burnAnnotationCollection(image, changeSourceFile, successFunc, errorFunc);

function burnAnnotationCollection(
   imageWebImageJS object.
 : WebImageJS, 
   changeSourceFileIndicates whether the changes must be saved in the source file. True - changes must be saved in the source file; False - changes must be saved in new file.
 : boolean, 
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  imageInfo (object): Information about image (image ID and page index).
 sourceImage (object): WebImageJS object, which represents source image.
 processedImage (object): WebImageJS object, which represents image with burned annotations.
 
 : Function, 
   errorFuncFunction that will be executed if request is failed.
 Here is function prototype "function __error(data)".
 The data parameter can be:
  An object with following properties:
  errorMessage (string): Error message.
 blocked (boolean): Indicates that the requested action is blocked by another request.
 sourceImage (object): WebImageJS object, which represents source image.
 
 if exception is catched inside web service. 
 Otherwise, jqXHR object.
 
 : Function
) : any;

Parameters

image

WebImageJS object.

changeSourceFile

Indicates whether the changes must be saved in the source file. True - changes must be saved in the source file; False - changes must be saved in new file.

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:

imageInfo (object): Information about image (image ID and page index).
sourceImage (object): WebImageJS object, which represents source image.
processedImage (object): WebImageJS object, which represents image with burned annotations.

errorFunc

Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:

An object with following properties:
- errorMessage (string): Error message.
- blocked (boolean): Indicates that the requested action is blocked by another request.
- sourceImage (object): WebImageJS object, which represents source image.
if exception is catched inside web service.
Otherwise, jqXHR object.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.
	Thrown if image collection does not contain the specified image.

Browser Compatibility

56+

45+

Reference

WebAnnotationViewControllerJS Class
WebAnnotationViewControllerJS Members

Send Feedback