Chevron DownAPI Reference

ShapefileLoader

From-v2.3

Shapefile loader

LoaderCharacteristic
File Extension.shp,
File TypeBinary, Multi-File
File FormatShapefile
Data FormatGeometry
Supported APIsload, parse, parseSync
Decoder TypeSynchronous
Worker Thread SupportYes, For Some Loaders

Usage

import {ShapefileLoader} from '@loaders.gl/shapefile';
import {load} from '@loaders.gl/core';

const data = await load(url, ShapefileLoader);

Options

N/A

Format Summary

ESRI Shapefiles are a popular file format for storing geospatial vector data. The format consists of a number of files that must be stored together and with the same file name. Files with extensions .shp, .shx, .dbf must exist; additional files with other extensions such as .prj and .cpg may exist.

FileTypeContents
.shpBinaryThe geometry, i.e. the geometry column in the resulting table.
.dbfBinaryThe attributes, i.e. the data columns in the resulting table.
.shxBinaryThe index (technically required, however it is sometimes possible to open shapefiles without the index)
.prjTextA small usually single line text file containing a WKT-CRS style projection. WGS84 is assumed if not present.
.cpgTextA small text file containing a text encoding name for the DBF text fields. latin1 is assumed if not present.