Interface: ZipOptions

Defined in: types.ts:219

Settings for producing a zipped bundle.

Extends

• WriteOptions.ProjectionOptions

Properties

dimensions?

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?

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

---

fileName?

optional fileName?: string;

Defined in: types.ts:226

Base name for the files inside the archive. Defaults to "shapefile".

Any directory and extension are stripped, and characters Windows reserves are replaced, since the archive is likely to be unzipped there.

---

level?

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

Defined in: types.ts:228

DEFLATE level, 0–9. Defaults to 6.

---

maxFieldLength?

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?

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?

optional wkt?: string;

Defined in: types.ts:215

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

Inherited from

ProjectionOptions.wkt