saveAnnotationCollection Method
In This Topic
Sends an asynchronous request to a server for saving the specified annotation collection in specified image.
Syntax
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.saveAnnotationCollection(image, successFunc, errorFunc);
function saveAnnotationCollection(
: WebImageJS,
: Function,
: 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. |
Example
// This JavaScript code shows how to save the specified annotation collection in specified image.
// get the image collection associated with annotation controller
var images = annotationController.get_Images();
// get the first image
var firstImage = images.getImage(0);
// Annotation collection is saved successfully.
function __success(data){
console.log("Annotation collection is saved successfully");
}
// Saving annotation collection failed.
function __error(data){
// show information about error.
alert(data.errorMessage);
}
// save annotation collection
annotationController.saveAnnotationCollection(firstImage, __success, __error);
Browser Compatibility
See Also
