This is the documentation of version 1.0.0-rc.0. Go to the latest version, 1.0.0-rc.5.

Type Alias HasBBox

HasBBox: BBox | GeoJSON | GeoJSON[]

A geographic bounding box, or an object the SDK can derive one from.

It takes these forms:

BBox - A GeoJSON bounding box array [west, south, east, north].
GeoJSON - Any GeoJSON object with a bbox property or whose bounds can be calculated.
GeoJSON[] - An array of GeoJSON objects, a convenience extension to standard GeoJSON.

Remarks

The format is [minLon, minLat, maxLon, maxLat], or [west, south, east, north].

Example

// Direct BBox array
const bbox1: HasBBox = [4.8, 52.3, 5.0, 52.4];

// Feature with bbox property
const bbox2: HasBBox = {
  type: 'Feature',
  bbox: [4.8, 52.3, 5.0, 52.4],
  geometry: { type: 'Polygon', coordinates: [...] },
  properties: {}
};

// Array of features to derive bounds from
const bbox3: HasBBox = [feature1, feature2, feature3];