VintaSoft Imaging .NET SDK v8.6
Vintasoft.Imaging.Annotation Namespace / WebAnnotationViewControllerJS type / deserializeAnnotationCollection Method
WebImageJS object.
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
    deserializeAnnotationCollection Method
    In This Topic
    Function that sends an asynchronous request to a server for deserializing an annotation collection, of specified image, from server.
    Syntax
    var instance = new Vintasoft.Imaging.Annotation.WebAnnotationViewControllerJS(images);
    var value; // Type: any
    
    // Parameters
    var image; // Type:  object
    var successFunc; // Type:  object
    var errorFunc; // Type:  object
    
    value = instance.deserializeAnnotationCollection(image, successFunc, errorFunc);
    function deserializeAnnotationCollection( 
       image : object,
       successFunc : object,
       errorFunc : object
    ) : 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): An instance of WebAnnotationViewCollectionJS class, which is associated with specified WebImageJS object.
      Parameter will have "undefined" 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:
    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.
    Example
    // 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 != undefined) {
            // for each image in image collection
            for (var i = 0; i < imageCollection.get_Count(); i++)
                // deserialize annotations of image
                annotationController.deserializeAnnotationCollection(imageCollection.get_Image(i));
        }
    }
    Browser Compatibility
    9
    5
    11
    5
    See Also