AnnCodecs Object

Provides support for loading and saving objects to annotation files.

Object Model

Syntax

JavaScript

function Leadtools.Annotations.Core.AnnCodecs()

Remarks

This class supports loading and saving annotation objects from/to an XML string as well as getting information about previously saved annotations data.

This class also supports saving and loading multi-page annotation data where each page contains a full Annotation Container.

Use the Save and SaveAll methods to save an annotation container as XML data. You can then use the browser capabilities to save this XML data to disk or use a Web Service to store it on a server. Use the SerializeOptions property to set save options and monitor the objects being saved.

Use the Load and LoadAll methods to load an annotation container from XML data. The XML data must have been previously loaded from disk using the browser capabilities or obtained from a server using a Web Service. The DeserializeOptions property can be used to set loading options, monitor the objects being loaded and handle errors.

Use the GetInfo or GetInfoFromXmlDocument to determine whether an XML data contains valid annotations data such as the format and number of pages.

LEADTOOLS supports saving multiple annotations to the same dataset. This can be used to save the annotations of a multi-page document in the same data.

Use SaveLayer to save individual annotation layers.

Example

This example creates a container, and then adds a line and rectangle objects to it. Then it saves it, obtains its information and loads it back.

JavaScript

example: function SiteLibrary_DefaultPage$example() {
   // Create a new annotation container, 8.5 by 11 inches
   var container = new lt.Annotations.Core.AnnContainer();
   // Size must be in annotation units (1/720 of an inch)
   container.set_size(lt.LeadSizeD.create(8.5 * 720, 11 * 720));

   var inch = 720.0;
   // Add a red line object, from 1in 1in to 2in 2in
   var lineObj = new lt.Annotations.Core.AnnPolylineObject();
   lineObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch));
   lineObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch));
   lineObj.set_stroke(lt.Annotations.Core.AnnStroke.create(lt.Annotations.Core.AnnSolidColorBrush.create("red"), lt.LeadLengthD.create(1)));
   container.get_children().add(lineObj);

   // Add a blue on yellow rectangle from 3in 3in to 4in 4in
   var rectObj = new lt.Annotations.Core.AnnRectangleObject();
   rectObj.set_rect(lt.LeadRectD.create(3 * inch, 3 * inch, 1 * inch, 1 * inch));
   rectObj.set_stroke(lt.Annotations.Core.AnnStroke.create(lt.Annotations.Core.AnnSolidColorBrush.create("blue"), lt.LeadLengthD.create(1)));
   rectObj.set_fill(lt.Annotations.Core.AnnSolidColorBrush.create("yellow"));
   container.get_children().add(rectObj);

   // Show the container
   this.showContainer("Before save", container);

   // Create the codecs object to save and load annotations
   var codecs = new lt.Annotations.Core.AnnCodecs();

   // Save the container
   var xmlData = codecs.save(container, lt.Annotations.Core.AnnFormat.annotations, null, 1);

   // delete the container
   container = null;

   // Show information about the data we just saved
   var info = codecs.getInfo(xmlData);
   var message;
   if (info.get_format() == lt.Annotations.Core.AnnFormat.annotations) {
      message = "Version: ";
      message += info.get_version();
      message += " No. of pages: ";
      message += info.get_pages().length;
      message += " page nos: ";
      for (var i = 0; i < info.get_pages().length; i++) {
         message += info.get_pages()[i] + " ";
      }
   }
   else {
      message = "Invalid annotations data";
   }

   alert(message);

   // Load the container we just saved
   container = codecs.load(xmlData, 1);

   // Show it
   this.showContainer("After load", container);
},

showContainer: function SiteLibrary_DefaultPage$showContainer(message, container) {
   var str = message + "\nContainer size: ";

   // Add the size
   var inch = 720;
   var width = container.get_size().get_width() / inch;
   var height = container.get_size().get_height() / inch;
   str += width + " by " + height + " inches" + "\n";

   // Add the objects
   str += "Contains " + container.get_children().get_count() + " objects(s)\n";
   for (var i = 0; i < container.get_children().get_count(); i++) {
      var annObj = container.get_children().get_item(i);

      str += "Object: " + annObj.get_friendlyName() + " at ";
      for (var j = 0; j < annObj.get_points().get_count(); j++) {
         var pt = annObj.get_points().get_item(j);
         var x = pt.get_x() / inch;
         var y = pt.get_y() / inch;
         str += "(" + x + ", " + y + ") ";
      }

      str += "\n";
   }

   alert(str);
},

AnnCodecs Object

Reference