deserializeAnnotationCollection Method

In This Topic

Sends an asynchronous request to a server for deserializing 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.deserializeAnnotationCollection(image, successFunc, errorFunc);

function deserializeAnnotationCollection(
   imageWebImageJS object.
 : WebImageJS, 
   successFuncFunction that will be executed if request is executed successfully.
 Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  annotationCollection (object): WebAnnotationViewCollectionJS object, which is associated with specified WebImageJS object.
 Parameter will have "null" value if WebImageJS object does not exist in image collection of annotation controller.
 
 : 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)".
The data parameter has the following properties:

annotationCollection (object): WebAnnotationViewCollectionJS object, which is associated with specified WebImageJS object.
Parameter will have "null" value if WebImageJS object does not exist in image collection of annotation controller.

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.

Example

JavaScript

// This function shows how to deserialize annotations without previewing images in image viewer.
function deserializeAnnotationWithoutImagePreview(imageViewer) {
    // get image collection of image viewer
    var imageCollection = imageViewer.get_Images();
    // get annotation controller of image viewer
    var annotationController = imageViewer.get_AnnotationController();
    // if annotation controller exists
    if (annotationController != null) {
        // for each image in image collection
        for (var i = 0; i < imageCollection.get_Count(); i++)
            // deserialize annotations of image
            annotationController.deserializeAnnotationCollection(imageCollection.getImage(i));
    }
}

Browser Compatibility

56+

45+

Reference

WebAnnotationViewControllerJS Class
WebAnnotationViewControllerJS Members

Send Feedback