# Wijmo_Xlsx

## Content

<div class="content__tsd">
						<div style="display:flex;justify-content:space-between;align-items:center">
							<h1>
								wijmo.xlsx Module
							</h1>
						</div>
						<section class="tsd-comment">
							<div class="tsd-comment">
								<div class="lead">
									<p>This module has a dependency on the <a href="https://stuk.github.io/jszip/" target="_blank">JSZip</a>
									library, which must be installed separately.</p>
									<ul>
										<li>In order to use asynchronous <a href="../classes/wijmo_xlsx.workbook.html#saveasync">Workbook.saveAsync</a> and <a href="../classes/wijmo_xlsx.workbook.html#loadasync">Workbook.loadAsync</a>
										methods, install JSZip version 3.*:<pre><code>npm install <span class="hljs-symbol">jszip@</span><span class="hljs-number">3</span> --save</code></pre></li>
										<li>In order to use synchronous <a href="../classes/wijmo_xlsx.workbook.html#save">Workbook.save</a> and <a href="../classes/wijmo_xlsx.workbook.html#load">Workbook.load</a>
											methods, install JSZip version 2.*:<pre><code>npm install <span class="hljs-symbol">jszip@</span><span class="hljs-number">2</span> --save</code></pre>If your application is not based on npm, and you load modules using <em>script</em> elements
											in <em>html</em>, you can load it from CDN with a markup like this:
											For JSZip 3<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"http://cdnjs.cloudflare.com/ajax/libs/jszip/3.1.3/jszip.min.js"</span> /&gt;</span></code></pre>
											For JSZip 2<pre><code class="language-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"http://cdnjs.cloudflare.com/ajax/libs/jszip/2.5.0/jszip.min.js"</span> /&gt;</span></code></pre>
										</li>
									</ul>
								</div>
							</div>
						</section>
						<section class="tsd-index-group">
							<section class="tsd-index-panel">
								<div class="tsd-index-content">
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Classes
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.definedname.html" class="tsd-kind-icon">Defined<wbr>Name</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.worksheet.html" class="tsd-kind-icon">Work<wbr>Sheet</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbook.html" class="tsd-kind-icon">Workbook</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookborder.html" class="tsd-kind-icon">Workbook<wbr>Border</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookbordersetting.html" class="tsd-kind-icon">Workbook<wbr>Border<wbr>Setting</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookcell.html" class="tsd-kind-icon">Workbook<wbr>Cell</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookcolumn.html" class="tsd-kind-icon">Workbook<wbr>Column</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookfill.html" class="tsd-kind-icon">Workbook<wbr>Fill</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookfont.html" class="tsd-kind-icon">Workbook<wbr>Font</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookfrozenpane.html" class="tsd-kind-icon">Workbook<wbr>Frozen<wbr>Pane</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooknote.html" class="tsd-kind-icon">Workbook<wbr>Note</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookrow.html" class="tsd-kind-icon">Workbook<wbr>Row</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbookstyle.html" class="tsd-kind-icon">Workbook<wbr>Style</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooktable.html" class="tsd-kind-icon">Workbook<wbr>Table</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooktablebandedstyle.html" class="tsd-kind-icon">Workbook<wbr>Table<wbr>Banded<wbr>Style</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooktableborder.html" class="tsd-kind-icon">Workbook<wbr>Table<wbr>Border</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooktablecolumn.html" class="tsd-kind-icon">Workbook<wbr>Table<wbr>Column</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooktablecommonstyle.html" class="tsd-kind-icon">Workbook<wbr>Table<wbr>Common<wbr>Style</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooktablestyle.html" class="tsd-kind-icon">Workbook<wbr>Table<wbr>Style</a></li>
											<li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/wijmo_xlsx.workbooktextrun.html" class="tsd-kind-icon">Workbook<wbr>Text<wbr>Run</a></li>
										</ul>
									</section>
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Interfaces
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.idefinedname.html" class="tsd-kind-icon">IDefined<wbr>Name</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.itableaddress.html" class="tsd-kind-icon">ITable<wbr>Address</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworksheet.html" class="tsd-kind-icon">IWork<wbr>Sheet</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbook.html" class="tsd-kind-icon">IWorkbook</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookborder.html" class="tsd-kind-icon">IWorkbook<wbr>Border</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookbordersetting.html" class="tsd-kind-icon">IWorkbook<wbr>Border<wbr>Setting</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookcell.html" class="tsd-kind-icon">IWorkbook<wbr>Cell</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookcolumn.html" class="tsd-kind-icon">IWorkbook<wbr>Column</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookfill.html" class="tsd-kind-icon">IWorkbook<wbr>Fill</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookfont.html" class="tsd-kind-icon">IWorkbook<wbr>Font</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookfrozenpane.html" class="tsd-kind-icon">IWorkbook<wbr>Frozen<wbr>Pane</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooknote.html" class="tsd-kind-icon">IWorkbook<wbr>Note</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookrow.html" class="tsd-kind-icon">IWorkbook<wbr>Row</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbookstyle.html" class="tsd-kind-icon">IWorkbook<wbr>Style</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooktable.html" class="tsd-kind-icon">IWorkbook<wbr>Table</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooktablebandedstyle.html" class="tsd-kind-icon">IWorkbook<wbr>Table<wbr>Banded<wbr>Style</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooktableborder.html" class="tsd-kind-icon">IWorkbook<wbr>Table<wbr>Border</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooktablecolumn.html" class="tsd-kind-icon">IWorkbook<wbr>Table<wbr>Column</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooktablecommonstyle.html" class="tsd-kind-icon">IWorkbook<wbr>Table<wbr>Common<wbr>Style</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooktablestyle.html" class="tsd-kind-icon">IWorkbook<wbr>Table<wbr>Style</a></li>
											<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/wijmo_xlsx.iworkbooktextrun.html" class="tsd-kind-icon">IWorkbook<wbr>Text<wbr>Run</a></li>
										</ul>
									</section>
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Enumerations
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/wijmo_xlsx.borderstyle.html" class="tsd-kind-icon">Border<wbr>Style</a></li>
											<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/wijmo_xlsx.halign.html" class="tsd-kind-icon">HAlign</a></li>
											<li class="tsd-kind-enum tsd-parent-kind-external-module"><a href="../enums/wijmo_xlsx.valign.html" class="tsd-kind-icon">VAlign</a></li>
										</ul>
									</section>
									<section class="tsd-index-section ">
										<div class="title">
											<div class="gc_api_tree-item_icon_img_wrapper">
												<div class="gc_api_tree-item_icon_img" data-expand="true">
												</div>
											</div>
											<h3>
												Functions
											</h3>
										</div>
										<ul class="tsd-index-list">
											<li class="tsd-kind-function tsd-parent-kind-external-module"><a href="wijmo_xlsx.html#usejszip" class="tsd-kind-icon">useJSZip</a></li>
										</ul>
									</section>
								</div>
							</section>
						</section>
						<section class="tsd-panel-group tsd-member-group ">
							<h2>Functions</h2>
							<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module">
								<a name="usejszip" class="tsd-anchor"></a>
								<h3>useJSZip</h3>
								<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module">
									<li class="tsd-signature tsd-kind-icon">useJSZip<span class="tsd-signature-symbol">(</span>jszip<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<aside class="tsd-sources">
										</aside>
										<div class="tsd-comment">
											<div class="lead">
												<p>NOTE: This function is OBSOLETE and retained for compatibility.
													It is no longer needed because wijmo.xlsx module loads
													jszip module automatically. You should only ensure that jszip module is installed in
												your application.</p>
											</div>
											<p>Defines a reference to JSZip module that will be used by the Wijmo xlsx export modules.</p>
											<p>This method should be used in npm modules based applications to provide wijmo.xlsx module
											with a reference to the JSZip module retrieved using the ES6 import statement. For example:</p>
											<pre>import * as JSZip from 'jszip';
import * as wjcXlsx from 'wijmo/wijmo.xlsx';
wjcXlsx.useJSZip(JSZip);
</pre>
										</div>
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>jszip: <span class="tsd-signature-type">any</span></h5>
												<div class="tsd-comment">
													<p>Reference to the JSZip constructor function.</p>
												</div>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
									</li>
								</ul>
							</section>
						</section>
					</div>