removeAnnotationCollection Method

In This Topic

Sends an asynchronous request to a server for removing an annotation collection, of specified image, from server.

Syntax

Javascript (Usage)
Javascript (Specification)

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

var value; // Type: any

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

value = instance.removeAnnotationCollection(image, successFunc, errorFunc);

function removeAnnotationCollection(
   imageWebImageJS object.
 : WebImageJS, 
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)".
 : 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.
 
 if exception is catched inside web service. 
 Otherwise, jqXHR object.
 
 : Function
) : any;

Parameters

image

WebImageJS object.

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:

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.
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