@vertigis/arcgis-extensions 35.3.1 → 35.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/convert.js +1 -1
- package/docs/html/enums/data_convert.GeometryFormat.html +7 -7
- package/docs/html/interfaces/data_convert.FromCsvOptions.html +13 -13
- package/docs/html/interfaces/data_convert.FromShapefileOptions.html +9 -9
- package/docs/html/interfaces/data_convert.FromXLSXOptions.html +12 -12
- package/docs/html/interfaces/data_convert.ToCsvOptions.html +13 -13
- package/docs/html/interfaces/data_convert.ToShapefileOptions.html +8 -8
- package/docs/html/interfaces/data_convert.ToXLSXOptions.html +10 -10
- package/docs/html/modules/data_convert.html +6 -6
- package/docs/html/modules/version.html +1 -1
- package/package.json +2 -3
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -1,37 +1,37 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FromCsvOptions | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vertigis/arcgis-extensions</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></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="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/data_convert.html">data/convert</a></li><li><a href="data_convert.FromCsvOptions.html">FromCsvOptions</a></li></ul><h1>Interface FromCsvOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Conversion options from CSV.</p>
|
|
3
|
-
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">CsvBaseOptions</span><ul class="tsd-hierarchy"><li><span class="target">FromCsvOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#dateFormat" class="tsd-kind-icon">date<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#delimiter" class="tsd-kind-icon">delimiter</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#escapeFormulaChars" class="tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#generatePrimaryKey" class="tsd-kind-icon">generate<wbr/>Primary<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#geometryFormat" class="tsd-kind-icon">geometry<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromCsvOptions.html#inSpatialReference" class="tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#includeHeaderRow" class="tsd-kind-icon">include<wbr/>Header<wbr/>Row</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#numberFormat" class="tsd-kind-icon">number<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#outFields" class="tsd-kind-icon">out<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#outSpatialReference" class="tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromCsvOptions.html#primaryKeyField" class="tsd-kind-icon">primary<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#rowDelimiter" class="tsd-kind-icon">row<wbr/>Delimiter</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#useFormattedValues" class="tsd-kind-icon">use<wbr/>Formatted<wbr/>Values</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dateFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> date<wbr/>Format<a href="#dateFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">date<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.dateFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">CsvBaseOptions</span><ul class="tsd-hierarchy"><li><span class="target">FromCsvOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#dateFormat" class="tsd-kind-icon">date<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#delimiter" class="tsd-kind-icon">delimiter</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#escapeFormulaChars" class="tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#generatePrimaryKey" class="tsd-kind-icon">generate<wbr/>Primary<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#geometryFormat" class="tsd-kind-icon">geometry<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromCsvOptions.html#inSpatialReference" class="tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#includeHeaderRow" class="tsd-kind-icon">include<wbr/>Header<wbr/>Row</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#numberFormat" class="tsd-kind-icon">number<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#outFields" class="tsd-kind-icon">out<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#outSpatialReference" class="tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromCsvOptions.html#primaryKeyField" class="tsd-kind-icon">primary<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#rowDelimiter" class="tsd-kind-icon">row<wbr/>Delimiter</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromCsvOptions.html#useFormattedValues" class="tsd-kind-icon">use<wbr/>Formatted<wbr/>Values</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dateFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> date<wbr/>Format<a href="#dateFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">date<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.dateFormat</p><ul><li>Defined in src/data/convert.ts:284</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p>The format for dates. The default is DateFormat.ROUND_TRIP. This can be a
|
|
5
5
|
defined DateFormat string, the "timestamp" pseudo-format, or a custom
|
|
6
6
|
format string.</p>
|
|
7
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="delimiter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> delimiter<a href="#delimiter" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">delimiter<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.delimiter</p><ul><li>Defined in src/data/convert.ts:
|
|
7
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="delimiter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> delimiter<a href="#delimiter" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">delimiter<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.delimiter</p><ul><li>Defined in src/data/convert.ts:146</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
8
|
<p>The delimiter between fields. The default is ",".</p>
|
|
9
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="escapeFormulaChars" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> escape<wbr/>Formula<wbr/>Chars<a href="#escapeFormulaChars" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.escapeFormulaChars</p><ul><li>Defined in src/data/convert.ts:
|
|
9
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="escapeFormulaChars" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> escape<wbr/>Formula<wbr/>Chars<a href="#escapeFormulaChars" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.escapeFormulaChars</p><ul><li>Defined in src/data/convert.ts:295</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
10
|
<p>Whether to a prefix values that start with typical formula triggering
|
|
11
11
|
chars (=,-,+,@).</p>
|
|
12
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="generatePrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> generate<wbr/>Primary<wbr/>Key<a href="#generatePrimaryKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">generate<wbr/>Primary<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.generatePrimaryKey</p><ul><li>Defined in src/data/convert.ts:
|
|
12
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="generatePrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> generate<wbr/>Primary<wbr/>Key<a href="#generatePrimaryKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">generate<wbr/>Primary<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.generatePrimaryKey</p><ul><li>Defined in src/data/convert.ts:300</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
13
|
<p>Indicates if a primary key should be generated if not found, defaults to true.</p>
|
|
14
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="geometryFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> geometry<wbr/>Format<a href="#geometryFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">geometry<wbr/>Format<span class="tsd-signature-symbol">?:</span> <a href="../enums/data_convert.GeometryFormat.html" class="tsd-signature-type" data-tsd-kind="Enumeration">GeometryFormat</a></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.geometryFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
14
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="geometryFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> geometry<wbr/>Format<a href="#geometryFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">geometry<wbr/>Format<span class="tsd-signature-symbol">?:</span> <a href="../enums/data_convert.GeometryFormat.html" class="tsd-signature-type" data-tsd-kind="Enumeration">GeometryFormat</a></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.geometryFormat</p><ul><li>Defined in src/data/convert.ts:162</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
15
15
|
<p>The format for serializing the geometry. The default is WKT.</p>
|
|
16
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="inSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> in<wbr/>Spatial<wbr/>Reference<a href="#inSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:
|
|
16
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="inSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> in<wbr/>Spatial<wbr/>Reference<a href="#inSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:114</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
17
17
|
<p>When importing from CSV, this is the spatial reference of the geometry in the CSV.</p>
|
|
18
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="includeHeaderRow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> include<wbr/>Header<wbr/>Row<a href="#includeHeaderRow" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">include<wbr/>Header<wbr/>Row<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.includeHeaderRow</p><ul><li>Defined in src/data/convert.ts:
|
|
18
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="includeHeaderRow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> include<wbr/>Header<wbr/>Row<a href="#includeHeaderRow" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">include<wbr/>Header<wbr/>Row<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.includeHeaderRow</p><ul><li>Defined in src/data/convert.ts:157</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
19
19
|
<p>Whether to include a header row with field names. Default is true.</p>
|
|
20
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="numberFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>Format<a href="#numberFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.numberFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
20
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="numberFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>Format<a href="#numberFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.numberFormat</p><ul><li>Defined in src/data/convert.ts:289</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
21
|
<p>The format for numbers. The default is NumberFormat.ROUND_TRIP.</p>
|
|
22
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Fields<a href="#outFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.outFields</p><ul><li>Defined in src/data/convert.ts:
|
|
22
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Fields<a href="#outFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.outFields</p><ul><li>Defined in src/data/convert.ts:168</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
23
23
|
<p>A list of fields to include. Defaults to the FeatureSources PopupTemplate
|
|
24
24
|
outfields if available, otherwise "*" meaning all fields.</p>
|
|
25
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Spatial<wbr/>Reference<a href="#outSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.outSpatialReference</p><ul><li>Defined in src/data/convert.ts:
|
|
25
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Spatial<wbr/>Reference<a href="#outSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.outSpatialReference</p><ul><li>Defined in src/data/convert.ts:175</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
26
26
|
<p>When exporting to CSV, this is the spatial reference of the geometry in
|
|
27
27
|
the CSV. The default is WGS84. When importing from CSV, this is the
|
|
28
28
|
spatial reference of the geometry in the result.</p>
|
|
29
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="primaryKeyField" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> primary<wbr/>Key<wbr/>Field<a href="#primaryKeyField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">primary<wbr/>Key<wbr/>Field<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:
|
|
29
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="primaryKeyField" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> primary<wbr/>Key<wbr/>Field<a href="#primaryKeyField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">primary<wbr/>Key<wbr/>Field<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:119</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
30
30
|
<p>Optionally the primary key field, used for converting from CSV to features.</p>
|
|
31
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="rowDelimiter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> row<wbr/>Delimiter<a href="#rowDelimiter" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">row<wbr/>Delimiter<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.rowDelimiter</p><ul><li>Defined in src/data/convert.ts:
|
|
31
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="rowDelimiter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> row<wbr/>Delimiter<a href="#rowDelimiter" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">row<wbr/>Delimiter<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.rowDelimiter</p><ul><li>Defined in src/data/convert.ts:152</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
32
32
|
<p>The delimiter between rows. The default is the platform-specific line
|
|
33
33
|
ending (e.g. "\r\n" on Windows, "\n" on Unix or MacOS).</p>
|
|
34
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="useFormattedValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Formatted<wbr/>Values<a href="#useFormattedValues" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Formatted<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.useFormattedValues</p><ul><li>Defined in src/data/convert.ts:
|
|
34
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="useFormattedValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Formatted<wbr/>Values<a href="#useFormattedValues" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Formatted<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CsvBaseOptions.useFormattedValues</p><ul><li>Defined in src/data/convert.ts:277</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
35
35
|
<p>If true, the configured formatters will be run on the raw values in the
|
|
36
36
|
supplied data and these values will be output with type information if
|
|
37
37
|
possible. If false, the formatted or presentable values already present
|
|
@@ -1,28 +1,28 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FromShapefileOptions | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vertigis/arcgis-extensions</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></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="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/data_convert.html">data/convert</a></li><li><a href="data_convert.FromShapefileOptions.html">FromShapefileOptions</a></li></ul><h1>Interface FromShapefileOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Conversion options from Shapefile.</p>
|
|
3
|
-
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseShapefileOptions</span><ul class="tsd-hierarchy"><li><span class="target">FromShapefileOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#dateFormat" class="tsd-kind-icon">date<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#escapeFormulaChars" class="tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#fileName" class="tsd-kind-icon">file<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#generatePrimaryKey" class="tsd-kind-icon">generate<wbr/>Primary<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#numberFormat" class="tsd-kind-icon">number<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#outFields" class="tsd-kind-icon">out<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#outSpatialReference" class="tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromShapefileOptions.html#primaryKeyField" class="tsd-kind-icon">primary<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#useFormattedValues" class="tsd-kind-icon">use<wbr/>Formatted<wbr/>Values</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dateFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> date<wbr/>Format<a href="#dateFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">date<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.dateFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseShapefileOptions</span><ul class="tsd-hierarchy"><li><span class="target">FromShapefileOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#dateFormat" class="tsd-kind-icon">date<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#escapeFormulaChars" class="tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#fileName" class="tsd-kind-icon">file<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#generatePrimaryKey" class="tsd-kind-icon">generate<wbr/>Primary<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#numberFormat" class="tsd-kind-icon">number<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#outFields" class="tsd-kind-icon">out<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#outSpatialReference" class="tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromShapefileOptions.html#primaryKeyField" class="tsd-kind-icon">primary<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromShapefileOptions.html#useFormattedValues" class="tsd-kind-icon">use<wbr/>Formatted<wbr/>Values</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dateFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> date<wbr/>Format<a href="#dateFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">date<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.dateFormat</p><ul><li>Defined in src/data/convert.ts:284</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p>The format for dates. The default is DateFormat.ROUND_TRIP. This can be a
|
|
5
5
|
defined DateFormat string, the "timestamp" pseudo-format, or a custom
|
|
6
6
|
format string.</p>
|
|
7
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="escapeFormulaChars" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> escape<wbr/>Formula<wbr/>Chars<a href="#escapeFormulaChars" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.escapeFormulaChars</p><ul><li>Defined in src/data/convert.ts:
|
|
7
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="escapeFormulaChars" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> escape<wbr/>Formula<wbr/>Chars<a href="#escapeFormulaChars" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.escapeFormulaChars</p><ul><li>Defined in src/data/convert.ts:295</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
8
|
<p>Whether to a prefix values that start with typical formula triggering
|
|
9
9
|
chars (=,-,+,@).</p>
|
|
10
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> file<wbr/>Name<a href="#fileName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">file<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.fileName</p><ul><li>Defined in src/data/convert.ts:
|
|
10
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="fileName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> file<wbr/>Name<a href="#fileName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">file<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.fileName</p><ul><li>Defined in src/data/convert.ts:255</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
11
|
<p>When exporting to a shapefile, the file name to use.</p>
|
|
12
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="generatePrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> generate<wbr/>Primary<wbr/>Key<a href="#generatePrimaryKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">generate<wbr/>Primary<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.generatePrimaryKey</p><ul><li>Defined in src/data/convert.ts:
|
|
12
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="generatePrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> generate<wbr/>Primary<wbr/>Key<a href="#generatePrimaryKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">generate<wbr/>Primary<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.generatePrimaryKey</p><ul><li>Defined in src/data/convert.ts:300</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
13
|
<p>Indicates if a primary key should be generated if not found, defaults to true.</p>
|
|
14
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="numberFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>Format<a href="#numberFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.numberFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
14
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="numberFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>Format<a href="#numberFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.numberFormat</p><ul><li>Defined in src/data/convert.ts:289</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
15
15
|
<p>The format for numbers. The default is NumberFormat.ROUND_TRIP.</p>
|
|
16
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Fields<a href="#outFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.outFields</p><ul><li>Defined in src/data/convert.ts:
|
|
16
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Fields<a href="#outFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.outFields</p><ul><li>Defined in src/data/convert.ts:260</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
17
17
|
<p>A list of fields to include. Defaults to the FeatureSources PopupTemplate
|
|
18
18
|
outfields if available, otherwise "*" meaning all fields.</p>
|
|
19
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Spatial<wbr/>Reference<a href="#outSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.outSpatialReference</p><ul><li>Defined in src/data/convert.ts:
|
|
19
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Spatial<wbr/>Reference<a href="#outSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.outSpatialReference</p><ul><li>Defined in src/data/convert.ts:266</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
20
|
<p>When exporting to a shapefile, this is the spatial reference of the
|
|
21
21
|
geometry in the shapefile file. The default is WGS84. When importing from
|
|
22
22
|
shapefile, this is the spatial reference of the geometry in the result.</p>
|
|
23
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="primaryKeyField" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> primary<wbr/>Key<wbr/>Field<a href="#primaryKeyField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">primary<wbr/>Key<wbr/>Field<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:
|
|
23
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="primaryKeyField" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> primary<wbr/>Key<wbr/>Field<a href="#primaryKeyField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">primary<wbr/>Key<wbr/>Field<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:240</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
24
24
|
<p>Optionally the primary key field, used for converting from Shapefile to features.</p>
|
|
25
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="useFormattedValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Formatted<wbr/>Values<a href="#useFormattedValues" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Formatted<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.useFormattedValues</p><ul><li>Defined in src/data/convert.ts:
|
|
25
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="useFormattedValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Formatted<wbr/>Values<a href="#useFormattedValues" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Formatted<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseShapefileOptions.useFormattedValues</p><ul><li>Defined in src/data/convert.ts:277</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
26
26
|
<p>If true, the configured formatters will be run on the raw values in the
|
|
27
27
|
supplied data and these values will be output with type information if
|
|
28
28
|
possible. If false, the formatted or presentable values already present
|
|
@@ -1,36 +1,36 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FromXLSXOptions | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">@vertigis/arcgis-extensions</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></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="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/data_convert.html">data/convert</a></li><li><a href="data_convert.FromXLSXOptions.html">FromXLSXOptions</a></li></ul><h1>Interface FromXLSXOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Conversion options from XLSX.</p>
|
|
3
|
-
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseXLSXOptions</span><ul class="tsd-hierarchy"><li><span class="target">FromXLSXOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#dateFormat" class="tsd-kind-icon">date<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#escapeFormulaChars" class="tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#generatePrimaryKey" class="tsd-kind-icon">generate<wbr/>Primary<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#geometryFormat" class="tsd-kind-icon">geometry<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromXLSXOptions.html#inSpatialReference" class="tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#includeHeaderRow" class="tsd-kind-icon">include<wbr/>Header<wbr/>Row</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#numberFormat" class="tsd-kind-icon">number<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#outFields" class="tsd-kind-icon">out<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#outSpatialReference" class="tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromXLSXOptions.html#primaryKeyField" class="tsd-kind-icon">primary<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#sheetName" class="tsd-kind-icon">sheet<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#useFormattedValues" class="tsd-kind-icon">use<wbr/>Formatted<wbr/>Values</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dateFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> date<wbr/>Format<a href="#dateFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">date<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.dateFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
3
|
+
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseXLSXOptions</span><ul class="tsd-hierarchy"><li><span class="target">FromXLSXOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#dateFormat" class="tsd-kind-icon">date<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#escapeFormulaChars" class="tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#generatePrimaryKey" class="tsd-kind-icon">generate<wbr/>Primary<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#geometryFormat" class="tsd-kind-icon">geometry<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromXLSXOptions.html#inSpatialReference" class="tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#includeHeaderRow" class="tsd-kind-icon">include<wbr/>Header<wbr/>Row</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#numberFormat" class="tsd-kind-icon">number<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#outFields" class="tsd-kind-icon">out<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#outSpatialReference" class="tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="data_convert.FromXLSXOptions.html#primaryKeyField" class="tsd-kind-icon">primary<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#sheetName" class="tsd-kind-icon">sheet<wbr/>Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="data_convert.FromXLSXOptions.html#useFormattedValues" class="tsd-kind-icon">use<wbr/>Formatted<wbr/>Values</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dateFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> date<wbr/>Format<a href="#dateFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">date<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.dateFormat</p><ul><li>Defined in src/data/convert.ts:284</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p>The format for dates. The default is DateFormat.ROUND_TRIP. This can be a
|
|
5
5
|
defined DateFormat string, the "timestamp" pseudo-format, or a custom
|
|
6
6
|
format string.</p>
|
|
7
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="escapeFormulaChars" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> escape<wbr/>Formula<wbr/>Chars<a href="#escapeFormulaChars" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.escapeFormulaChars</p><ul><li>Defined in src/data/convert.ts:
|
|
7
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="escapeFormulaChars" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> escape<wbr/>Formula<wbr/>Chars<a href="#escapeFormulaChars" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">escape<wbr/>Formula<wbr/>Chars<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.escapeFormulaChars</p><ul><li>Defined in src/data/convert.ts:295</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
8
|
<p>Whether to a prefix values that start with typical formula triggering
|
|
9
9
|
chars (=,-,+,@).</p>
|
|
10
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="generatePrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> generate<wbr/>Primary<wbr/>Key<a href="#generatePrimaryKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">generate<wbr/>Primary<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.generatePrimaryKey</p><ul><li>Defined in src/data/convert.ts:
|
|
10
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="generatePrimaryKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> generate<wbr/>Primary<wbr/>Key<a href="#generatePrimaryKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">generate<wbr/>Primary<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.generatePrimaryKey</p><ul><li>Defined in src/data/convert.ts:300</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
11
|
<p>Indicates if a primary key should be generated if not found, defaults to true.</p>
|
|
12
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="geometryFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> geometry<wbr/>Format<a href="#geometryFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">geometry<wbr/>Format<span class="tsd-signature-symbol">?:</span> <a href="../enums/data_convert.GeometryFormat.html" class="tsd-signature-type" data-tsd-kind="Enumeration">GeometryFormat</a></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.geometryFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
12
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="geometryFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> geometry<wbr/>Format<a href="#geometryFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">geometry<wbr/>Format<span class="tsd-signature-symbol">?:</span> <a href="../enums/data_convert.GeometryFormat.html" class="tsd-signature-type" data-tsd-kind="Enumeration">GeometryFormat</a></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.geometryFormat</p><ul><li>Defined in src/data/convert.ts:211</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
13
|
<p>The format for serializing the geometry. The default is WKT.</p>
|
|
14
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="inSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> in<wbr/>Spatial<wbr/>Reference<a href="#inSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:
|
|
14
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="inSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> in<wbr/>Spatial<wbr/>Reference<a href="#inSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">in<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:186</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
15
15
|
<p>When importing from XLSX, this is the spatial reference of the geometry
|
|
16
16
|
in the XLSX file.</p>
|
|
17
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="includeHeaderRow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> include<wbr/>Header<wbr/>Row<a href="#includeHeaderRow" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">include<wbr/>Header<wbr/>Row<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.includeHeaderRow</p><ul><li>Defined in src/data/convert.ts:
|
|
17
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="includeHeaderRow" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> include<wbr/>Header<wbr/>Row<a href="#includeHeaderRow" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">include<wbr/>Header<wbr/>Row<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.includeHeaderRow</p><ul><li>Defined in src/data/convert.ts:206</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
18
18
|
<p>Whether to include a header row with field names. Default is true.</p>
|
|
19
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="numberFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>Format<a href="#numberFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.numberFormat</p><ul><li>Defined in src/data/convert.ts:
|
|
19
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="numberFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> number<wbr/>Format<a href="#numberFormat" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">number<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.numberFormat</p><ul><li>Defined in src/data/convert.ts:289</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
20
|
<p>The format for numbers. The default is NumberFormat.ROUND_TRIP.</p>
|
|
21
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Fields<a href="#outFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.outFields</p><ul><li>Defined in src/data/convert.ts:
|
|
21
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Fields<a href="#outFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.outFields</p><ul><li>Defined in src/data/convert.ts:217</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
22
22
|
<p>A list of fields to include. Defaults to the FeatureSources PopupTemplate
|
|
23
23
|
outfields if available, otherwise "*" meaning all fields.</p>
|
|
24
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Spatial<wbr/>Reference<a href="#outSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.outSpatialReference</p><ul><li>Defined in src/data/convert.ts:
|
|
24
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="outSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> out<wbr/>Spatial<wbr/>Reference<a href="#outSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">out<wbr/>Spatial<wbr/>Reference<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.outSpatialReference</p><ul><li>Defined in src/data/convert.ts:230</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
25
25
|
<p>When exporting to XLSX, this is the spatial reference of the geometry in
|
|
26
26
|
the XLSX file. The default is WGS84. When importing from XLSX, this is
|
|
27
27
|
the spatial reference of the geometry in the result.</p>
|
|
28
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="primaryKeyField" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> primary<wbr/>Key<wbr/>Field<a href="#primaryKeyField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">primary<wbr/>Key<wbr/>Field<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:
|
|
28
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="primaryKeyField" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> primary<wbr/>Key<wbr/>Field<a href="#primaryKeyField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">primary<wbr/>Key<wbr/>Field<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/data/convert.ts:191</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
29
29
|
<p>Optionally the primary key field, used for converting from XLSX to features.</p>
|
|
30
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="sheetName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sheet<wbr/>Name<a href="#sheetName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">sheet<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.sheetName</p><ul><li>Defined in src/data/convert.ts:
|
|
30
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="sheetName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sheet<wbr/>Name<a href="#sheetName" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">sheet<wbr/>Name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.sheetName</p><ul><li>Defined in src/data/convert.ts:223</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
31
31
|
<p>When exporting to XLSX, the name of the resulting work sheet. The default
|
|
32
32
|
is "sheet1".</p>
|
|
33
|
-
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="useFormattedValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Formatted<wbr/>Values<a href="#useFormattedValues" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Formatted<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.useFormattedValues</p><ul><li>Defined in src/data/convert.ts:
|
|
33
|
+
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="useFormattedValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr/>Formatted<wbr/>Values<a href="#useFormattedValues" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">use<wbr/>Formatted<wbr/>Values<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from BaseXLSXOptions.useFormattedValues</p><ul><li>Defined in src/data/convert.ts:277</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
34
34
|
<p>If true, the configured formatters will be run on the raw values in the
|
|
35
35
|
supplied data and these values will be output with type information if
|
|
36
36
|
possible. If false, the formatted or presentable values already present
|