Files
docx-js/docs/index.html

530 lines
27 KiB
HTML
Raw Normal View History

2017-04-16 00:07:16 +01:00
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>docx</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">docx</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> docx</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<p align="center">
<img alt="clippy the assistant" src="http://i60.tinypic.com/339pvtt.png">
</p>
<p align="center">
Generate .docx files with JS/TS very easily, written in TS.
</p>
<hr>
<p><a href="https://npmjs.org/package/docx"><img src="https://badge.fury.io/js/docx.svg" alt="NPM version"></a> <a href="https://travis-ci.org/dolanmiu/docx"><img src="https://travis-ci.org/dolanmiu/docx.svg?branch=master" alt="Build Status"></a> <a href="https://gemnasium.com/github.com/dolanmiu/docx"><img src="https://gemnasium.com/badges/github.com/dolanmiu/docx.svg" alt="Dependency Status"></a> <a href="https://snyk.io/test/github/dolanmiu/docx"><img src="https://snyk.io/test/github/dolanmiu/docx/badge.svg" alt="Known Vulnerabilities"></a> <a href="https://gitter.im/docx-lib/Lobby"><img src="https://badges.gitter.im/dolanmiu/docx.svg" alt="Chat on Gitter"></a></p>
<p><a href="https://nodei.co/npm/docx/"><img src="https://nodei.co/npm/docx.png?downloads=true&amp;downloadRank=true&amp;stars=true" alt="NPM"></a></p>
<h1 id="docx">docx</h1>
<h2 id="install">Install</h2>
<pre><code class="lang-sh">$ npm install --save docx
</code></pre>
<h2 id="demo">Demo</h2>
<pre><code class="lang-sh">$ npm run demo
</code></pre>
<p>will run the demo app in the <code>demo</code> folder, which creates a file called &quot;My Document.docx&quot; in the root of the project</p>
<h2 id="guide">Guide</h2>
<p>Please refer to <a href="https://github.com/dolanmiu/docx/wiki">the Wiki</a> for details on how to use this library, examples and much more!</p>
<h2 id="simple-usage">Simple Usage</h2>
<pre><code class="lang-js"><span class="hljs-comment">// Used to create docx files</span>
<span class="hljs-keyword">var</span> docx = <span class="hljs-built_in">require</span>(<span class="hljs-string">'docx'</span>);
<span class="hljs-comment">// Create document</span>
<span class="hljs-keyword">var</span> doc = <span class="hljs-keyword">new</span> docx.Document();
<span class="hljs-comment">// Add some content in the document</span>
<span class="hljs-keyword">var</span> paragraph = <span class="hljs-keyword">new</span> docx.Paragraph(<span class="hljs-string">"Some cool text here."</span>);
<span class="hljs-comment">// Add more text into the paragraph if you wish</span>
paragraph.addRun(<span class="hljs-keyword">new</span> docx.TextRun(<span class="hljs-string">'Lorem Ipsum Foo Bar'</span>));
doc.addParagraph(paragraph);
<span class="hljs-comment">// Used to export the file into a .docx file</span>
<span class="hljs-keyword">var</span> exporter = <span class="hljs-keyword">new</span> docx.LocalPacker(doc);
<span class="hljs-comment">// Or use the express packer to make the file downloadable.</span>
<span class="hljs-comment">// res is express' Response object</span>
<span class="hljs-keyword">var</span> exporter = <span class="hljs-keyword">new</span> docx.ExpressPacker(doc, res);
exporter.pack(<span class="hljs-string">'My First Document'</span>);
<span class="hljs-comment">// done! A file called 'My First Document.docx'</span>
<span class="hljs-comment">// will be in your file system if you used LocalPacker</span>
<span class="hljs-comment">// Or it will start downloading if you are using Express</span>
</code></pre>
<h2 id="examples">Examples</h2>
<p>Check <a href="https://github.com/dolanmiu/docx/wiki/Examples">the Wiki</a> for examples.</p>
<hr>
<p>Made with 💖</p>
<p>Huge thanks to <a href="https://github.com/felipeochoa">@felipeochoa</a> for awesome contributions to this project</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_body_columns_.html">"docx/document/body/columns"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_body_doc_grid_.html">"docx/document/body/doc-<wbr>grid"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_body_index_.html">"docx/document/body/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_body_page_margin_.html">"docx/document/body/page-<wbr>margin"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_body_page_size_.html">"docx/document/body/page-<wbr>size"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_body_section_properties_.html">"docx/document/body/section-<wbr>properties"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_document_attributes_.html">"docx/document/document-<wbr>attributes"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_document_index_.html">"docx/document/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_index_.html">"docx/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_alignment_.html">"docx/paragraph/alignment"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_border_.html">"docx/paragraph/border"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_formatting_.html">"docx/paragraph/formatting"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_indent_.html">"docx/paragraph/indent"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_index_.html">"docx/paragraph/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_keep_.html">"docx/paragraph/keep"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_page_break_.html">"docx/paragraph/page-<wbr>break"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_properties_.html">"docx/paragraph/properties"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_spacing_.html">"docx/paragraph/spacing"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_style_.html">"docx/paragraph/style"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_tab_stop_.html">"docx/paragraph/tab-<wbr>stop"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_paragraph_unordered_list_.html">"docx/paragraph/unordered-<wbr>list"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_row_.html">"docx/row"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_break_.html">"docx/run/break"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_caps_.html">"docx/run/caps"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_formatting_.html">"docx/run/formatting"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_index_.html">"docx/run/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_picture_run_.html">"docx/run/picture-<wbr>run"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_properties_.html">"docx/run/properties"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_index_.html">"docx/run/run-<wbr>components/drawing/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_graphic_graphic_data_index_.html">"docx/run/run-<wbr>components/drawing/inline/graphic/graphic-<wbr>data/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_graphic_graphic_data_pic_blip_blip_.html">"docx/run/run-<wbr>components/drawing/inline/graphic/graphic-<wbr>data/pic/blip/blip"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_graphic_graphic_data_pic_blip_blip_fill_.html">"docx/run/run-<wbr>components/drawing/inline/graphic/graphic-<wbr>data/pic/blip/blip-<wbr>fill"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_graphic_graphic_data_pic_blip_source_rectangle_.html">"docx/run/run-<wbr>components/drawing/inline/graphic/graphic-<wbr>data/pic/blip/source-<wbr>rectangle"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_graphic_graphic_data_pic_blip_stretch_.html">"docx/run/run-<wbr>components/drawing/inline/graphic/graphic-<wbr>data/pic/blip/stretch"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_graphic_graphic_data_pic_index_.html">"docx/run/run-<wbr>components/drawing/inline/graphic/graphic-<wbr>data/pic/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_graphic_index_.html">"docx/run/run-<wbr>components/drawing/inline/graphic/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_drawing_inline_index_.html">"docx/run/run-<wbr>components/drawing/inline/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_components_text_.html">"docx/run/run-<wbr>components/text"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_run_fonts_.html">"docx/run/run-<wbr>fonts"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_script_.html">"docx/run/script"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_style_.html">"docx/run/style"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_tab_.html">"docx/run/tab"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_text_run_.html">"docx/run/text-<wbr>run"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_run_underline_.html">"docx/run/underline"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_table_grid_.html">"docx/table/grid"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_table_index_.html">"docx/table/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_table_properties_.html">"docx/table/properties"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_xml_components_attributes_.html">"docx/xml-<wbr>components/attributes"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_xml_components_base_.html">"docx/xml-<wbr>components/base"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_xml_components_default_attributes_.html">"docx/xml-<wbr>components/default-<wbr>attributes"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_docx_xml_components_index_.html">"docx/xml-<wbr>components/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_export_formatter_.html">"export/formatter"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_export_index_.html">"export/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_export_packer_express_.html">"export/packer/express"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_export_packer_local_.html">"export/packer/local"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_export_packer_packer_.html">"export/packer/packer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_media_data_.html">"media/data"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_media_index_.html">"media/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_numbering_abstract_numbering_.html">"numbering/abstract-<wbr>numbering"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_numbering_index_.html">"numbering/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_numbering_level_.html">"numbering/level"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_numbering_multi_level_type_.html">"numbering/multi-<wbr>level-<wbr>type"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_numbering_num_.html">"numbering/num"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_properties_components_.html">"properties/components"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_properties_index_.html">"properties/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_relationships_attributes_.html">"relationships/attributes"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_relationships_index_.html">"relationships/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_relationships_relationship_.html">"relationships/relationship"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_defaults_index_.html">"styles/defaults/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_defaults_paragraph_properties_.html">"styles/defaults/paragraph-<wbr>properties"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_defaults_run_properties_.html">"styles/defaults/run-<wbr>properties"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_factory_.html">"styles/factory"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_index_.html">"styles/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_latent_styles_exceptions_.html">"styles/latent-<wbr>styles/exceptions"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_latent_styles_index_.html">"styles/latent-<wbr>styles/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_sample_index_.html">"styles/sample/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_style_components_.html">"styles/style/components"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_styles_style_index_.html">"styles/style/index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests__testtemplate_.html">"tests/_<wbr>test<wbr>Template"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_document_bodytest_.html">"tests/docx/document/body<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_document_documenttest_.html">"tests/docx/document/document<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_paragraph_bordertest_.html">"tests/docx/paragraph/border<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_paragraph_pagebreaktests_.html">"tests/docx/paragraph/page<wbr>Break<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_paragraph_paragraphstyletest_.html">"tests/docx/paragraph/paragraph<wbr>Style<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_paragraph_paragraphtests_.html">"tests/docx/paragraph/paragraph<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_paragraph_spacingtest_.html">"tests/docx/paragraph/spacing<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_paragraph_tabstoptests_.html">"tests/docx/paragraph/tab<wbr>Stop<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_paragraph_unorderedlisttests_.html">"tests/docx/paragraph/unordered<wbr>List<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_breaktests_.html">"tests/docx/run/break<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_fonttests_.html">"tests/docx/run/font<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_run_components_drawingtests_.html">"tests/docx/run/run-<wbr>components/drawing<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_run_components_text_.html">"tests/docx/run/run-<wbr>components/text"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_runtest_.html">"tests/docx/run/run<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_scripttests_.html">"tests/docx/run/script<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_striketests_.html">"tests/docx/run/strike<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_tabtests_.html">"tests/docx/run/tab<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_textruntests_.html">"tests/docx/run/text<wbr>Run<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_run_underlinetests_.html">"tests/docx/run/underline<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_table_testgrid_.html">"tests/docx/table/test<wbr>Grid"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_table_testproperties_.html">"tests/docx/table/test<wbr>Properties"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_table_testtable_.html">"tests/docx/table/test<wbr>Table"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_xml_components_attributetest_.html">"tests/docx/xml-<wbr>components/attribute<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_docx_xml_components_xmlcomponenttests_.html">"tests/docx/xml-<wbr>components/xml<wbr>Component<wbr>Tests"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_export_formattertest_.html">"tests/export/formatter<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_export_localpackertest_.html">"tests/export/local<wbr>Packer<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_numberingtest_.html">"tests/numbering<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_propertiestest_.html">"tests/properties<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_stylestest_.html">"tests/styles<wbr>Test"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_tests_utility_.html">"tests/utility"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>