0.1.2 - Fixed/added some type definitions

Author: TeamworkGuy2

CHANGELOG.md

@@ -4,7 +4,13 @@ This project does its best to adhere to [Semantic Versioning](http://semver.org/
 
 
 --------
-### [0.1.1](N/A) - 2016-05-31
+### [0.1.2](N/A) - 2016-06-01
+#### Changed
+* Corrected/added some type definitions
+
+
+--------
+### [0.1.1](https://github.com/TeamworkGuy2/excel-builder-ts/commit/c0d76ebed850b73aeb7eed4c52830f27e1df7bae) - 2016-05-31
 #### Changed
 * Switched all applicable strings from single to double quotes
 * Added some missing and best guess data types

Drawings.js

@@ -26,14 +26,14 @@ var Drawings = (function () {
         var drawingsElem = doc.documentElement;
         //drawings.setAttribute('xmlns:xdr', util.schemas.spreadsheetDrawing);
         drawingsElem.setAttribute("xmlns:a", Util.schemas.drawing);
-        var existingRelationships = {};
         for (var i = 0, l = this.drawings.length; i < l; i++) {
-            var rId = this.relations.getRelationshipId(this.drawings[i].getMediaData());
+            var drwI = this.drawings[i];
+            var rId = this.relations.getRelationshipId(drwI.getMediaData());
             if (!rId) {
-                rId = this.relations.addRelation(this.drawings[i].getMediaData(), this.drawings[i].getMediaType()); //chart
+                rId = this.relations.addRelation(drwI.getMediaData(), drwI.getMediaType()); //chart
             }
-            this.drawings[i].setRelationshipId(rId);
-            drawingsElem.appendChild(this.drawings[i].toXML(doc));
+            drwI.setRelationshipId(rId);
+            drawingsElem.appendChild(drwI.toXML(doc));
         }
         return doc;
     };

Drawings.ts

@@ -39,16 +39,14 @@ class Drawings {
         //drawings.setAttribute('xmlns:xdr', util.schemas.spreadsheetDrawing);
         drawingsElem.setAttribute("xmlns:a", Util.schemas.drawing);
 
-        var existingRelationships = {};
-
         for (var i = 0, l = this.drawings.length; i < l; i++) {
-
-            var rId = this.relations.getRelationshipId(this.drawings[i].getMediaData());
+            var drwI = this.drawings[i];
+            var rId = this.relations.getRelationshipId(drwI.getMediaData());
             if (!rId) {
-                rId = this.relations.addRelation(this.drawings[i].getMediaData(), this.drawings[i].getMediaType()); //chart
+                rId = this.relations.addRelation(drwI.getMediaData(), drwI.getMediaType()); //chart
             }
-            this.drawings[i].setRelationshipId(rId);
-            drawingsElem.appendChild(this.drawings[i].toXML(doc));
+            drwI.setRelationshipId(rId);
+            drawingsElem.appendChild(drwI.toXML(doc));
         }
         return doc;
     }
@@ -58,10 +56,10 @@ class Drawings {
 module Drawings {
 
     export interface Drawing {
-        getMediaData();
-        getMediaType();
+        getMediaData(): { id: string; schema?: string; };
+        getMediaType(): string;
         setRelationshipId(rId: string): void;
-        toXML(doc: XmlDom);
+        toXML(doc: XmlDom): XmlDom.NodeBase;
     }
 
 }

XmlDom.ts

@@ -41,14 +41,14 @@ module XmlDom {
 
 
     export interface NodeConfig {
-        type: "XML" | "TEXT";
         nodeValue?: string;
+        type: "XML" | "TEXT";
     }
 
 
     export interface NodeBase {
         nodeValue?: string;
-        toJSON(): NodeConfig;
+        toJSON?(): NodeConfig;
     }
 
 

drawings/AbsoluteAnchor.ts

@@ -1,4 +1,5 @@
 import Util = require("../Util");
+import XmlDom = require("../XmlDom");
 
 class AbsoluteAnchor {
     x: number;
@@ -49,7 +50,7 @@ class AbsoluteAnchor {
     }
 
 
-    public toXML(xmlDoc: XMLDocument, content: Node) {
+    public toXML(xmlDoc: XmlDom, content: XmlDom.NodeBase) {
         var root = Util.createElement(xmlDoc, "xdr:absoluteAnchor");
         var pos = Util.createElement(xmlDoc, "xdr:pos");
         pos.setAttribute("x", <any>this.x);

drawings/Drawing.ts

@@ -1,18 +1,16 @@
 import Util = require("../Util");
+import XmlDom = require("../XmlDom");
+import Drawings = require("../Drawings");
 import AbsoluteAnchor = require("./AbsoluteAnchor");
 import OneCellAnchor = require("./OneCellAnchor");
 import TwoCellAnchor = require("./TwoCellAnchor");
 
-
-type AnchorLike = AbsoluteAnchor | OneCellAnchor | TwoCellAnchor;
-
-
 /** This is mostly a global spot where all of the relationship managers can get and set
  * path information from/to. 
  * @module Excel/Drawing
  */
-class Drawing {
-    anchor: AnchorLike;
+abstract class Drawing implements Drawings.Drawing {
+    anchor: Drawing.AnchorLike;
     id: string;
 
 
@@ -46,6 +44,21 @@ class Drawing {
         return this.anchor;
     }
 
+
+    public abstract setRelationshipId(rId: string): void;
+
+    public abstract toXML(xmlDoc: XmlDom): XmlDom.NodeBase;
+
+    public abstract getMediaData(): { id: string; schema?: string; };
+
+    public abstract getMediaType(): string;
+
+}
+
+module Drawing {
+
+    export type AnchorLike = AbsoluteAnchor | OneCellAnchor | TwoCellAnchor;
+
 }
 
 export = Drawing;

drawings/OneCellAnchor.ts

@@ -1,4 +1,5 @@
 import Util = require("../Util");
+import XmlDom = require("../XmlDom");
 
 class OneCellAnchor {
     x: number;
@@ -49,7 +50,7 @@ class OneCellAnchor {
     }
 
 
-    public toXML(xmlDoc: XMLDocument, content: Node) {
+    public toXML(xmlDoc: XmlDom, content: XmlDom.NodeBase) {
         var root = Util.createElement(xmlDoc, "xdr:oneCellAnchor");
         var from = Util.createElement(xmlDoc, "xdr:from");
         var fromCol = Util.createElement(xmlDoc, "xdr:col");

drawings/Picture.ts

@@ -1,19 +1,21 @@
 import Util = require("../Util");
+import XmlDom = require("../XmlDom");
 import Drawing = require("./Drawing");
+import Drawings = require("../Drawings");
 
 class Picture {
     static Cctor = (function () {
         var thisProto = Picture.prototype;
-        Picture.prototype = <any>new Drawing();
+        Picture.prototype = new (<any>Drawing)();
         Object.assign(Picture.prototype, thisProto);
     } ());
 
-    anchor: any;
+    anchor: Drawing.AnchorLike;
     description: string;
     fill: any;
     id: string;
     media: any;
-    mediaData: { rId: string; fileName: string; };
+    mediaData: { rId?: string; id: string; fileName: string; };
     pictureId: number;
 
 
@@ -26,7 +28,7 @@ class Picture {
     }
 
 
-    public setMedia(mediaRef: { rId: string; fileName: string; [id: string]: any }) {
+    public setMedia(mediaRef: { rId?: string; id: string; fileName: string; [id: string]: any }) {
         this.mediaData = mediaRef;
     }
 
@@ -51,7 +53,7 @@ class Picture {
     }
 
 
-    public getMediaData() {
+    public getMediaData(): { id: string; schema?: string; } {
         return this.mediaData;
     }
 
@@ -61,7 +63,7 @@ class Picture {
     }
 
 
-    public toXML(xmlDoc: XMLDocument) {
+    public toXML(xmlDoc: XmlDom): XmlDom.NodeBase {
         var pictureNode = Util.createElement(xmlDoc, "xdr:pic");
 
         var nonVisibleProperties = Util.createElement(xmlDoc, "xdr:nvPicPr");
@@ -128,4 +130,5 @@ class Picture {
 
 }
 
-export = <{ new (): Picture & Drawing }><any>Picture;
+interface PictureDrawing extends Picture, Drawing, Drawings.Drawing { }
+export = <{ new (): PictureDrawing }><any>Picture;

drawings/TwoCellAnchor.ts

@@ -1,4 +1,5 @@
 import Util = require("../Util");
+import XmlDom = require("../XmlDom");
 
 class TwoCellAnchor {
     from: Util.OffsetConfig;
@@ -39,7 +40,7 @@ class TwoCellAnchor {
     }
 
 
-    public toXML(xmlDoc: XMLDocument, content: Node) {
+    public toXML(xmlDoc: XmlDom, content: XmlDom.NodeBase) {
         var root = Util.createElement(xmlDoc, "xdr:twoCellAnchor");
 
         var from = Util.createElement(xmlDoc, "xdr:from");

package.json

@@ -1,6 +1,6 @@
 {
   "name": "excel-builder-ts",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "TypeScript Port of the excel-builder.js Library - 'A way to build excel files with javascript'",
   "dependencies": {
   },