@smartmaps/area • Docs

---

@smartmaps/area / Area

Class: Area

Constructors

new Area()

new Area(apiKey, channel?): Area

Parameters

• apiKey: string

• channel?: string

Returns

Area

Methods

osmid()

osmid(params): Promise\<BoundariesResponsePropertiesFeatureCollection>

Parameters

• params: AreaOsmIdRequestParams

Returns

Promise\<BoundariesResponsePropertiesFeatureCollection>

---

osmids()

osmids(request): Promise\<BoundariesResponsePropertiesFeatureCollection>

Parameters

• request: OsmIdRequest

Returns

Promise\<BoundariesResponsePropertiesFeatureCollection>

---

point()

point(params): Promise\<BoundariesResponsePropertiesFeatureCollection>

Parameters

• params: AreaPointRequestParams

Returns

Promise\<BoundariesResponsePropertiesFeatureCollection>

---

points()

points(request): Promise\<BoundariesResponsePropertiesFeatureCollection>

Parameters

• request: AreaPointRequest

Returns

Promise\<BoundariesResponsePropertiesFeatureCollection>

---

rectangle()

rectangle(request): Promise\<BoundariesResponsePropertiesFeatureCollection>

Parameters

• request: AreaRectangleRequest

Returns

Promise\<BoundariesResponsePropertiesFeatureCollection>