saveLayer Method

Summary

Saves an annotation layer to xml data.

Syntax

JavaScript Syntax

AnnCodecs.prototype.saveLayer = function(layer, format, xmlData)

TypeScript Syntax

saveLayer(layer: AnnLayer, format: AnnFormat, xmlData: string): string;

Parameters

layer

The AnnLayer to be saved. This value must not be null.

format

Must be AnnFormat.Annotations.

xmlData

Optional existing data. Can be null to create new annotations data; otherwise, must contain valid

data previously saved with this method.

Return Value

The xml string of the annotations that were saved.

Remarks

This method works the same way and produces the same annotation file format that AnnCodecs.Save produces, except it saves only the objects inside the individual layer specified instead of all the objects in the container.

Note that "load layer" functionality is not required by AnnCodecs. An AnnLayer cannot exist by itself without an annotation container, hence any of the load functions that accept a container parameter can be used to load the file saved by this function.

The SerializeOptions property can contain optional options and events to use during saving of annotations data.

For more information, refer to Annotation Files.

Example

For an example, refer to AnnCodecs

Requirements

Target Platforms