implemented generator.getDocumentPixmap

lib/generator.js

@@ -986,6 +986,55 @@
         return overallDeferred.promise;
     };
 
+    /**
+     * Get a pixmap representing the pixels of a document.
+     * Optionally pass settings with the same available params as getPixmap method.
+     *
+     * @param {!number} documentId Document ID
+     * @param {?Object} settings getPixmap settings
+     */
+    Generator.prototype.getDocumentPixmap = function (documentId, settings) {
+        if (documentId === undefined) {
+            return Q.reject("Document ID is required");
+        } else {
+            return this.getDocumentInfo(documentId, {
+                compInfo: false,
+                imageInfo: false,
+                layerInfo: true,
+                expandSmartObjects: false,
+                getTextStyles: false,
+                getFullTextStyles: false,
+                selectedLayers: false,
+                getCompLayerSettings: true,
+                getDefaultLayerFX: false
+            }).then(function (document) {
+                var layerSpec = {
+                    firstLayerIndex: 0,
+                    lastLayerIndex: document.layers[0].index,
+                    hidden: this._computeHiddenLayers(document)
+                };
+                return this.getPixmap(documentId, layerSpec, settings);
+            }.bind(this));
+        }
+    };
+
+    // recursively walks layers and returns hidden ones
+    // if parent is hidden, pass flag to hide all children regardless their visibility
+    Generator.prototype._computeHiddenLayers = function (parent, hideAll) {
+        var layer, isHidden, hiddenLayers = [];
+        for (var i = 0, ii = parent.layers.length; i < ii; i++) {
+            layer = parent.layers[i];
+            isHidden = hideAll || !layer.visible;
+            if (isHidden) {
+                hiddenLayers.push(layer.index);
+            }
+            if (layer.type === "layerSection" && layer.layers && layer.layers.length) {
+                hiddenLayers = hiddenLayers.concat(this._computeHiddenLayers(layer, isHidden));
+            }
+        }
+        return hiddenLayers;
+    };
+
     /**
      * Returns a promise that resolves to an object detailing the path
      * present on the specified layer. If there is no path present,