fromGeoJSON

Creates a Geometry from GeoJSON representation.

This function has 2 overloads, when called with:

• GeoJSON Geometry or GeoJSON Feature it returns a single geometry,
• GeoJSON FeatureCollection it returns an array of geometries.

In addition to the 7 standard GeoJSON geometries, this reader also supports JSON representation of other geometries supported by GEOS like JSON_CircularString, JSON_CompoundCurve or JSON_CurvePolygon.

Reader expects that all positions in an input geometry have the same number of elements. The geometry coordinate dimension is determined from the first encountered position.

Type Parameters

• P - The type of geometry/feature properties

Parameters

Name	Type	Default	Description
geojson	GeoJSON_Geometry | GeoJSON_Feature<GeoJSON_Geometry, P> | GeoJSON_FeatureCollection<GeoJSON_Geometry, P> | JSON_Geometry | JSON_Feature<JSON_Geometry, P> | JSON_FeatureCollection<JSON_Geometry, P>		GeoJSON Geometry, Feature or FeatureCollection
options?	object		Optional GeoJSON input configuration
options.layout?	'XY' | 'XYZ' | 'XYZM' | 'XYM'	'XYZM'	Coordinate layout for interpreting GeoJSON coordinates. Defines how to interpret the coordinates of input geometries. This does not force the dimension of the resulting geometries - the actual geometry dimension will be determined from the parsed data. Use this to: Trim unwanted Z or M ordinates from the input. Treat the third ordinate as M instead of Z.

Returns

Geometry<P> | Geometry<P>[]

A new geometry object or an array of new geometry objects

Throws

• InvalidGeoJSONError on GeoJSON feature without geometry
• InvalidGeoJSONError on invalid GeoJSON geometry

See also

• point shortcut to create Point geometry
• lineString shortcut to create LineString geometry
• polygon shortcut to create Polygon geometry
• multiPoint shortcut to create MultiPoint geometry
• multiLineString shortcut to create MultiLineString geometry
• multiPolygon shortcut to create MultiPolygon geometry
• circularString shortcut to create CircularString geometry

Examples

const a = fromGeoJSON({
    type: 'Point',
    coordinates: [ 0, 0 ],
});
const b = fromGeoJSON({
    type: 'Feature',
    geometry: { type: 'Point', coordinates: [ 1, 0, 10 ] },
    properties: { name: 'B' },
});
const [ c ] = fromGeoJSON({
    type: 'FeatureCollection',
    features: [ {
        type: 'Feature',
        geometry: { type: 'Point', coordinates: [ 2, 0 ] },
        properties: { name: 'C' },
    } ],
});

const c_properties = a.props; // undefined
const b_properties = b.props; // { name: 'B' }
const a_properties = c.props; // { name: 'C' }

const a = fromGeoJSON({ type: 'Point', coordinates: [ 0, 0 ], }); const b = fromGeoJSON({ type: 'Feature', geometry: { type: 'Point', coordinates: [ 1, 0, 10 ] }, properties: { name: 'B' }, }); const [ c ] = fromGeoJSON({ type: 'FeatureCollection', features: [ { type: 'Feature', geometry: { type: 'Point', coordinates: [ 2, 0 ] }, properties: { name: 'C' }, } ], }); const c_properties = a.props; // undefined const b_properties = b.props; // { name: 'B' } const a_properties = c.props; // { name: 'C' }

'layout' option

const json = { type: 'Point', coordinates: [ 1, 2, 3, 4 ] };

const xyzm = toWKT(fromGeoJSON(json, { layout: 'XYZM' })); // 'POINT ZM (1 2 3 4)'
const xyz = toWKT(fromGeoJSON(json, { layout: 'XYZ' })); // 'POINT Z (1 2 3)'
const xym = toWKT(fromGeoJSON(json, { layout: 'XYM' })); // 'POINT M (1 2 3)'
const xy = toWKT(fromGeoJSON(json, { layout: 'XY' })); // 'POINT (1 2)'

// 'layout' can only map or reduce the dimension it cannot increase it
const xyNOTxyz = toWKT(fromGeoJSON(
    { type: 'Point', coordinates: [ 1, 2 ] },
    { layout: 'XYZ' },
)); // 'POINT (1 2)'

const json = { type: 'Point', coordinates: [ 1, 2, 3, 4 ] }; const xyzm = toWKT(fromGeoJSON(json, { layout: 'XYZM' })); // 'POINT ZM (1 2 3 4)' const xyz = toWKT(fromGeoJSON(json, { layout: 'XYZ' })); // 'POINT Z (1 2 3)' const xym = toWKT(fromGeoJSON(json, { layout: 'XYM' })); // 'POINT M (1 2 3)' const xy = toWKT(fromGeoJSON(json, { layout: 'XY' })); // 'POINT (1 2)' // 'layout' can only map or reduce the dimension it cannot increase it const xyNOTxyz = toWKT(fromGeoJSON( { type: 'Point', coordinates: [ 1, 2 ] }, { layout: 'XYZ' }, )); // 'POINT (1 2)'