Class: HtmlToPdf

.tool. HtmlToPdf


new HtmlToPdf()

Methods


<static> enableDebugMode( [enable])

Força que seja realizado log de todas as execuções.

Parameters:
Name Type Argument Description
enable Boolean <optional>

Se true habilita log.


addPage(inputFile)

Adiciona uma página ao conjunto de impressão.

Parameters:
Name Type Description
inputFile String

Caminho do arquivo Html.


listPages()

Lista as página do conjunto de impressão.

Returns:

Páginas a serem impressas em ordem.

Type
Array

print(outputFile [, generateLog])

Imprime os objetos Html no arquivo especificado. Pode ser encontrado o log da última execução em tools/HtmlToPdf/htmlToPdf.log.

Parameters:
Name Type Argument Default Description
outputFile String

Caminho do arquivo PDF de saída.

generateLog Boolean <optional>
false

Se true gera arquivo de log.

Returns:

Código de saída da execução do HtmlToPdf

Type
Number

setCopies(copies)

Configurar o número de copias das páginas a serem impressas no documento. Default: 1.

Parameters:
Name Type Description
copies Number

Número de cópias.


setExtraArguments(params)

Adiciona parâmetros de customização ao documento impresso. Caso parâmetros já tenham sido definidos, estes serão sobrescritos. Os parâmetros são definidos de acordo com a documentação do wkhtmltopdf na seção Global Options.

Parameters:
Name Type Description
params String

Parâmetros de customização.


setGrayScale(grayScale)

Configura se deve imprimir em escala de cinza. Default: false.

Parameters:
Name Type Description
grayScale Boolean

True para imprimir em escala de cinza.


setOrientation(orientation)

Configura a orientação da impressão em retrato ou paisagem. Valores: Landscape ou Portrait. Default: Portrait.

Parameters:
Name Type Description
orientation String

Modo da orientação.


setPageExtraArguments(index, params)

Adiciona parâmetros de customização à página a ser impressa. Caso parâmetros já tenham sido definidos, estes serão sobrescritos. Os parâmetros são definidos de acordo com a documentação do wkhtmltopdf na seção Page Options.

Parameters:
Name Type Description
index Number

Índice da página ao quals os parâmetros se referem.

params String

Parâmetros de customização.


setPageSize(pageSize)

Configura o tamanho da página. Lista completa de i Valores.: A4, A5, B3, Letter, Legal, etc. Lista completa em: http://doc.trolltech.com/qprinter.html#PaperSize-enum Default: A4.

Parameters:
Name Type Description
pageSize String

Tamanho da página.


setTitle(title)

Configura título do PDF. Se vazio, a tag da primeira página é utilizada como título.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>title</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>Texto do título.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt> <dd class="tag-default"> <ul class="dummy"> <li>''</li> </ul> </dd> </dl> </dd> <hr> <dt> <h4 class="name" id="tryExecute_"><span class="type-signature"></span>tryExecute_(command [, logFile])</h4> </dt> <dd> <div class="description"> <p>Imprime os objetos Html no arquivo especificado. Pode ser encontrado o log da última execução em tools/HtmlToPdf/htmlToPdf.log.</p> </div> <h5>Parameters:</h5> <table class="params table table-striped"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Argument</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>command</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>Caminho do arquivo PDF de saída.</p></td> </tr> <tr> <td class="name"><code>logFile</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Se true gera arquivo de log.</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Código de saída da execução do HtmlToPdf</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">number</span> </dd> </dl> </dd> </dl> </article> </section> </div> </div> <div class="clearfix"></div> <div class="col-md-3"> <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div> </div> </div> </div> <div class="modal fade" id="searchResults"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <h4 class="modal-title">Search results</h4> </div> <div class="modal-body"></div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> </div> </div><!-- /.modal-content --> </div><!-- /.modal-dialog --> </div> <footer> <span class="copyright"> <span style="color:gray">© <a href="http://www.salutis.com.br">Salutis</a> e <a href="http://www.innovaro.com.br">Innovaro</a>. Todos os direitos reservados.<br>A plataforma nginstack utiliza <a href="https://nginstack.com/pt/credits">softwares de código aberto</a>.<style>span.jsdoc-message { display: none }</style></span> </span> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. </span> </footer> <script src="scripts/docstrap.lib.js"></script> <script src="scripts/toc.js"></script> <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script> <script> $( function () { $( "[id*='$']" ).each( function () { var $this = $( this ); $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } ); $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () { var $this = $( this ); var example = $this.find( "code" ); exampleText = example.html(); var lang = /{@lang (.*?)}/.exec( exampleText ); if ( lang && lang[1] ) { exampleText = exampleText.replace( lang[0], "" ); example.html( exampleText ); lang = lang[1]; } else { var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/); lang = langClassMatch ? langClassMatch[1] : "javascript"; } if ( lang ) { $this .addClass( "sunlight-highlight-" + lang ) .addClass( "linenums" ) .html( example.html() ); } } ); Sunlight.highlightAll( { lineNumbers : false, showMenu : true, enableDoclinks : true } ); $.catchAnchorLinks( { navbarOffset: 10 } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { return $( heading ).attr( "id" ) || ( prefix + i ); }, selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", showAndHide : false, smoothScrolling: true } ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); $( '.dropdown-toggle' ).dropdown(); $( "table" ).each( function () { var $this = $( this ); $this.addClass('table'); } ); } ); </script> <!--Navigation and Symbol Display--> <!--Google Analytics--> <script type="text/javascript"> $(document).ready(function() { SearcherDisplay.init(); }); </script> </body> </html>