GeometryRef

Class representing a GEOS geometry that exists in the Wasm memory.

Type Parameters

• P - The type of optional data assigned to a geometry instance. Similar to the type of GeoJSON Feature properties field.

Properties

type readonly

'Point' | 'LineString' | 'LinearRing' | 'Polygon' | 'MultiPoint' | 'MultiLineString' | 'MultiPolygon' | 'GeometryCollection' | 'CircularString' | 'CompoundCurve' | 'CurvePolygon' | 'MultiCurve' | 'MultiSurface'

Geometry type

const type1 = fromWKT('POINT (1 1)').type; // 'Point'
const type2 = fromWKT('LINESTRING (0 0, 1 1)').type; // 'LineString'
const type3 = fromWKT('CIRCULARSTRING (0 0, 1 1, 2 0)').type; // 'CircularString'

const type1 = fromWKT('POINT (1 1)').type; // 'Point' const type2 = fromWKT('LINESTRING (0 0, 1 1)').type; // 'LineString' const type3 = fromWKT('CIRCULARSTRING (0 0, 1 1, 2 0)').type; // 'CircularString'

id optional

number | string

Geometry identifier, either number or string.

Equivalent of GeoJSON feature id.

props

P

Geometry additional data.

Equivalent of GeoJSON feature properties or GEOS geometry user data.

detached optional

boolean

Geometry can become detached when passed to a function that consumes it, for example geometryCollection, or when manually freed. Although this Geometry object still exists, the GEOS object that it used to represent no longer exists.

const pt = point([ 0, 0 ]);
const before = pt.detached; // falsy (undefined)
pt.free(); // `pt` is no longer usable as a geometry
const after = pt.detached; // true

const pt = point([ 0, 0 ]); const before = pt.detached; // falsy (undefined) pt.free(); // `pt` is no longer usable as a geometry const after = pt.detached; // true

Methods

normalize

() -> this

Organizes the elements, rings, and coordinate order of geometries in a consistent way, so that geometries that represent the same object can be easily compared.

orientPolygons

(exterior: 'cw' | 'ccw') -> this

Enforces a ring orientation on all polygonal elements in the input geometry.

clone

() -> GeometryRef<P>

Creates a deep copy of this geometry object.

toJSON

() -> GeoJSON_Feature<GeoJSON_Geometry, P>

Converts the geometry to a GeoJSON Feature object.

free

() -> void

Frees the Wasm memory allocated for the GEOS geometry object.