Skip to content

Interface: WriteLayersOptions ​

Defined in: layers.ts:57

Settings for writeLayersZip.

Extends ​

Properties ​

dimensions? ​

ts
optional dimensions?: Dimensions;

Defined in: types.ts:147

Force the dimensionality.

By default a third ordinate is read as Z and a fourth as a measure; pass 'xym' to treat the third as a measure instead.

Inherited from ​

WriteOptions.dimensions


epsg? ​

ts
optional epsg?: number;

Defined in: types.ts:213

EPSG code for the .prj.

Resolved against the built-in codes, anything registered via registerProjections, and — loaded on demand — the bundled table of 116 definitions. An unresolvable code throws rather than silently omitting the .prj.

Inherited from ​

ProjectionOptions.epsg


folder? ​

ts
optional folder?: string;

Defined in: layers.ts:64

Wrap everything in a top-level folder — handy for a dated or job-numbered export. Applied in every layout.


layout? ​

ts
optional layout?: ArchiveLayout;

Defined in: layers.ts:59

How to arrange the layers. Defaults to 'flat'.


level? ​

ts
optional level?: 0 | 2 | 1 | 4 | 3 | 5 | 6 | 7 | 8 | 9;

Defined in: layers.ts:66

DEFLATE level, 0-9. Defaults to 6.


maxFieldLength? ​

ts
optional maxFieldLength?: number;

Defined in: types.ts:154

Cap on .dbf character column width, 1–254. Defaults to 254.

Columns are otherwise sized to the longest value present. Lowering this shrinks the file at the cost of truncating long text.

Inherited from ​

WriteOptions.maxFieldLength


shapeType? ​

ts
optional shapeType?: ShapeFamily;

Defined in: types.ts:140

Force a geometry family instead of inferring it from the data.

Useful when a batch happens to contain only Point features but downstream consumers expect Multipoint.

Inherited from ​

WriteOptions.shapeType


wkt? ​

ts
optional wkt?: string;

Defined in: types.ts:215

Raw ESRI WKT for the .prj. Takes precedence over epsg.

Inherited from ​

ProjectionOptions.wkt

Released under the MIT License.