changeset 1247:032dfc2515e9

more doc.
author robcast
date Thu, 16 Jan 2014 15:10:17 +0100
parents 778c099c6b4c
children 56f0dfaf10cd
files webapp/src/main/webapp/jquery/jquery.digilib.vector.js
diffstat 1 files changed, 7 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/webapp/src/main/webapp/jquery/jquery.digilib.vector.js	Thu Jan 16 14:19:46 2014 +0100
+++ b/webapp/src/main/webapp/jquery/jquery.digilib.vector.js	Thu Jan 16 15:10:17 2014 +0100
@@ -79,7 +79,11 @@
         },
 	
         /**
-         * add vector object (shape) or create by clicking.
+         * add vector object (shape) or create one by clicking.
+         * 
+         * For interactive use shape has to be initialized with a shape object with
+         * type but no coordinates, e.g {'geometry':{'type':'Line'}}. The onComplete
+         * function will be called with data and the new shape object as parameters.
          * 
          * @param data
          * @param shape
@@ -232,8 +236,8 @@
         }
     };
 
-    /** define a shape by click and drag
-     * 
+    /** 
+     * define a shape by click and drag.
      */
     var defineShape = function(data, shape, onComplete) {
     	var shapeType = shape.geometry.type;