Products
Map Api
Reference
Map JS API v1.4

December 17, 2024

Map JS API v1.4

Map JS API Reference v1.4

BaseGeometry class
BasePolygon class
Circle class
Data class
GeometryCollection class
LineString class
LinearRing class
MultiLineString class
MultiPoint class
MultiPolygon class
Point class
Polygon class
DatasetsOverlay class
DatasetsService class
DirectionsRenderer class
DirectionsService class
DistanceService class
Drawing class
ImageMapType class
InfoWindow class
LatLng class
LatLngBounds class
LocalitiesService class
MVCArray class
MVCObject class
Map class
Marker class
OverlayView class
Point class
Polygon class
Polyline class
Rectangle class
Size class
StoresOverlay class
StoresService class
TransitRenderer class
TransitService class
Feature class
APIError class
BadRequestError class
ForbiddenError class
InternalServerError class
NotFoundError class
TooManyRequestsError class
UnauthorizedError class
Field class
Query class
AutocompleteMatchedSubstring Interface
CircleOptions Interface
ControlPositionType Interface
Coordinates Interface
Geometry Interface
DatasetsFeature Interface
DatasetsFeatureSummary Interface
DatasetsPagination Interface
DatasetsPaginationRequest Interface
DatasetsSearchRequest Interface
DatasetsSearchResponse Interface
DatasetsSearchWithGeometryRequest Interface
DatasetsSearchWithInputGeometryRequest Interface
DatasetsSearchWithPolygonGeometryRequest Interface
DirectionLeg Interface
DirectionRequest Interface
DirectionResult Interface
DirectionRoute Interface
DirectionStep Interface
DirectionStepInstructions Interface
DirectionsBounds Interface
DirectionsOverviewPolyline Interface
DirectionsRendererOptions Interface
DirectionsWayPoint Interface
Distance Interface
Duration Interface
FeatureData Interface
FlyToOptions Interface
GeoJSONFeature Interface
GeoJSONFeatureCollection Interface
GeoJSONGeometry Interface
GeoJSONGeometryCollection Interface
GeoJSONLineString Interface
GeoJSONMultiLineString Interface
GeoJSONMultiPoint Interface
GeoJSONMultiPolygon Interface
GeoJSONPoint Interface
GeoJSONPolygon Interface
GeoJSONPosition Interface
GeoJSONRawGeometry Interface
GeometryArray Interface
GeometryClasses Interface
GeometryCollectionElement Interface
GeometryData Interface
GeometryOptions Interface
GeometryType Interface
GestureHandlingMode Interface
Icon Interface
IconSequence Interface
ImageMapTypeOptions Interface
InfoWindowOptions Interface
LatLngBoundsLiteral Interface
LatLngLiteral Interface
MapEventListener Interface
MapOptions Interface
MapPanes Interface
MapStyleSpec Interface
MapStyler Interface
MapType Interface
MarkerAnimateOptions Interface
MarkerLabel Interface
MarkerLabelOptions Interface
MarkerOptions Interface
MatchedSubstring Interface
Padding Interface
Pagination Interface
PointLiteral Interface
PolygonFillOptions Interface
PolygonOptions Interface
PolylineOptions Interface
Projection Interface
RectangleOptions Interface
SizeLiteral Interface
Style Interface
StyleFunction Interface
StyleOptions Interface
StyleRule Interface
SymbolIcon Interface
TransitRendererOptions Interface
TypedStyleRule Interface
DistanceIsochroneRequest Interface
DistanceIsochroneResponse Interface
DistanceIsoline Interface
DistanceMatrixElement Interface
DistanceMatrixRequest Interface
DistanceMatrixResponse Interface
DistanceMatrixResponseRow Interface
AddressComponents Interface
LocalitiesAutocompleteRequest Interface
LocalitiesAutocompleteResponse Interface
LocalitiesBounds Interface
LocalitiesComponentRestrictions Interface
LocalitiesDetailsAccuracy Interface
LocalitiesDetailsGeometry Interface
LocalitiesDetailsRequest Interface
LocalitiesDetailsResponse Interface
LocalitiesDetailsResult Interface
LocalitiesDetailsSummary Interface
LocalitiesGeocodeGeometry Interface
LocalitiesGeocodeLocationType Interface
LocalitiesGeocodeRequest Interface
LocalitiesGeocodeResponse Interface
LocalitiesGeocodeResult Interface
LocalitiesGeocodeTypes Interface
LocalitiesNearbyGeometry Interface
LocalitiesNearbyPagination Interface
LocalitiesNearbyRequest Interface
LocalitiesNearbyResponse Interface
LocalitiesNearbyResult Interface
LocalitiesNearbyTypes Interface
LocalitiesPredictions Interface
LocalitiesRelated Interface
LocalitiesRelatedPostalCode Interface
LocalitiesRequestData Interface
LocalitiesTypes Interface
Store Interface
StoreAddress Interface
StoreContact Interface
StoreOpen Interface
StoreOpenNextOpening Interface
StoreOpeningHours Interface
StoreOpeningHoursPeriod Interface
StoreOpeningHoursUsual Interface
StorePrediction Interface
StoreResponse Interface
StoreWeeklyOpening Interface
StoreWeeklyOpeningHoursPeriod Interface
StoresAutocompleteRequest Interface
StoresAutocompleteResponse Interface
StoresBoundsRequest Interface
StoresBoundsResponse Interface
StoresSearchRequest Interface
StoresSearchResponse Interface
TransitAttribution Interface
TransitLeg Interface
TransitPlace Interface
TransitRoute Interface
TransitRouteRequest Interface
TransitRouteResponse Interface
TransitTransport Interface
DirectionStatus Enum
TravelMode Enum
UnitSystem Enum
DistanceServiceStatus Enum
BoolOperators Enum
Operators Enum
woosmap.map.event Namespace
woosmap.map.geometry Namespace
woosmap.map.query Namespace

BaseGeometry class

woosmap.map.BaseGeometry

This class extends woosmap.map.MVCObject.

Constructor
`BaseGeometry`	`BaseGeometry(options)` Parameters: `options`: `GeometryOptions`

Methods
`getDraggable`	`getDraggable()` Parameters: None Return Type: `boolean` Returns whether the geometry is draggable or not.
`getEditable`	`getEditable()` Parameters: None Return Type: `boolean` Returns whether the geometry is editable or not.
`getMap`	`getMap()` Parameters: None Return Type: `(Map \| null)` Returns the current parent Map.
`getVisible`	`getVisible()` Parameters: None Return Type: `boolean` Returns whether the geometry is visible or not.
`setDraggable`	`setDraggable(draggable)` Parameters: `draggable`: `boolean` Return Type: `void` Sets the geometry draggable.
`setEditable`	`setEditable(editable)` Parameters: `editable`: `boolean` Return Type: `void` Sets the geometry editable.
`setMap`	`setMap(map)` Parameters: `map`: `Map \| null` Return Type: `void` Sets the map object to display on. if `map` is null, the geometry will be removed from the current `map`.
`setVisible`	`setVisible(visible)` Parameters: `visible`: `boolean` Return Type: `void` Sets the visibility of the geometry.

BasePolygon class

woosmap.map.BasePolygon

This class extends BaseGeometry.

Constructor
`BasePolygon`	`BasePolygon(options)` Parameters: `options`: `GeometryOptions`

Circle class

woosmap.map.Circle

This class extends BasePolygon.

Constructor
`Circle`	`Circle(options)` Parameters: `options`: `CircleOptions` Constructs a Circle.

Methods
`getBounds`	`getBounds()` Parameters: None Return Type: `LatLngBounds` Returns the bounds for the circle geometry.
`getCenter`	`getCenter()` Parameters: None Return Type: `LatLng` Returns the center for the circle geometry.
`getRadius`	`getRadius()` Parameters: None Return Type: `number` Returns the radius for the circle geometry.
`setCenter`	`setCenter(center)` Parameters: `center`: `LatLng \| LatLngLiteral` Return Type: `void` Sets the center for the circle.
`setRadius`	`setRadius(radius)` Parameters: `radius`: `number` Return Type: `void` Sets the radius for the circle.
`setOptions`	`setOptions(options)` Parameters: `options`: `CircleOptions` Return Type: `void` Sets the options for the circle.

Data class

woosmap.map.Data

This class extends woosmap.map.MVCObject.

A layer for displaying geospatial data. Points can be displayed.

Constructor
`Data`	`Data()` Parameters: None Creates an empty collection.

Methods
`add`	`add(feature)` Parameters: `feature`: `Feature \| FeatureData` Return Type: `void` Adds the feature passed as parameter.
`remove`	`remove(feature)` Parameters: `feature`: `Feature` Return Type: `void` Remove the feature passed as parameter.
`addGeoJson`	`addGeoJson(geojson, options?)` Parameters: `geojson`: `GeoJSONFeatureCollection \| GeoJSONFeature` `options`: `{idPropertyName: string}` Return Type: `void` Adds GeoJSON features to the collection. Give this method a parsed JSON. The imported features are returned. Throws an exception if the GeoJSON could not be imported.
`toGeoJson`	`toGeoJson(callback)` Parameters: `callback`: `(geojson: GeoJSONFeatureCollection) => void` Return Type: `void` Exports the features in the collection to a GeoJSON object.
`contains`	`contains(feature)` Parameters: `feature`: `Feature` Return Type: `boolean` Checks whether the given feature is in the collection.
`forEach`	`forEach(callback)` Parameters: `callback`: `(feature: Feature) => void` Return Type: `void` Repeatedly invokes the given function, passing a feature in the collection to the function on each invocation. The order of iteration through the features is undefined.
`getFeatureById`	`getFeatureById(id)` Parameters: `id`: `string` Return Type: `(Feature \| null)` Returns the feature matching the id.
`getMap`	`getMap()` Parameters: None Return Type: `(Map \| null)` Returns the map on which the features are displayed.
`setMap`	`setMap(map)` Parameters: `map`: `Map \| null` Return Type: `void` Renders the features on the specified map. If map is set to null, the features will be removed from the map.
`setStyle`	`setStyle(style)` Parameters: `style`: `StyleFunction \| StyleOptions` Return Type: `void` Sets the style for all features in the collection. Styles specified on a per-feature basis via `overrideStyle()` continue to apply. Pass either an object with the desired style options, or a function that computes the style for each feature. The function will be called every time a feature’s properties are updated.
`getStyle`	`getStyle()` Parameters: None Return Type: `StyleFunction \| StyleOptions` Gets the style for all features in the collection.
`overrideStyle`	`overrideStyle(feature, style)` Parameters: `feature`: `Feature` `style`: `StyleOptions` Return Type: `void` Changes the style of a feature. These changes are applied on top of the style specified by `setStyle()`. Style properties set to null revert to the value specified via `setStyle()`.
`revertStyle`	`revertStyle(feature?)` Parameters: `feature`: `(Feature \| null)` Return Type: `void` Removes the effect of previous `overrideStyle()` calls. The style of the given feature reverts to the style specified by `setStyle()`. If no feature is given, all features have their style reverted.
`loadGeoJson`	`loadGeoJson(url, options?, callback?)` Parameters: `url`: `string` `options`: `{idPropertyName: string}` `callback`: `(data: Feature[]) => void` Return Type: `void` Loads GeoJSON features to the collection from an url. If a callback is provided it will be called with the imported features.

Events
`removefeature`	This event is triggered when a feature was removed.
`addfeature`	This event is triggered when a feature was added.
`click`	This event is triggered when a feature is clicked.
`contextmenu`	This event is triggered when a feature is right-clicked.
`dblclick`	This event is triggered when a feature is double clicked.
`mousedown`
`mouseup`
`mouseout`	This event is triggered when the mouse moves out of a feature.
`mouseover`	This event is triggered when a feature was hovered
`mouseenter`	This event is triggered when a feature is hovered.

GeometryCollection class

woosmap.map.Data.GeometryCollection

This class implements Geometry<"GeometryCollection", any>.

Constructor
`GeometryCollection`	`GeometryCollection(elements)` Parameters: `elements`: `GeometryArray \| GeoJSONGeometry[]` Constructs a geometry collection from an array of geometries.

Methods
`getAt`	`getAt(n)` Parameters: `n`: `number` Return Type: `GeometryCollectionElement` Returns the n-th Geometry of the GeometryCollection.
`getArray`	`getArray()` Parameters: None Return Type: `GeometryArray`
`getLength`	`getLength()` Parameters: None Return Type: `number`
`forEachLatLng`	`forEachLatLng(callback)` Parameters: `callback`: `(point: LatLng) => void` Return Type: `void`
`getType`	`getType()` Parameters: None Return Type: `"GeometryCollection"` Returns `"GeometryCollection"`.

LineString class

woosmap.map.Data.LineString

This class implements Geometry<"LineString", Coordinates[]>.

Constructor
`LineString`	`LineString(points)` Parameters: `points`: `LatLng[] \| Coordinates[] \| LatLngLiteral[]`

Methods
`getAt`	`getAt(n)` Parameters: `n`: `number` Return Type: `LatLng` Returns the n-th Point (as LatLng) of the LineString.
`getArray`	`getArray()` Parameters: None Return Type: `LatLng[]` Returns the points of the linestring as an array of LatLng.
`getLength`	`getLength()` Parameters: None Return Type: `number` Returns the count of points in the linestring.
`forEachLatLng`	`forEachLatLng(callback)` Parameters: `callback`: `(point: LatLng) => void` Return Type: `void`
`getType`	`getType()` Parameters: None Return Type: `"LineString"`

LinearRing class

woosmap.map.Data.LinearRing

This class extends LineString.

Constructor
`LinearRing`	`LinearRing(points)` Parameters: `points`: `LatLng[] \| Coordinates[] \| LatLngLiteral[]` Constructs a linear ring.

MultiLineString class

woosmap.map.Data.MultiLineString

This class implements Geometry<"MultiLineString", Coordinates[][]>.

Constructor
`MultiLineString`	`MultiLineString(linestrings)` Parameters: `linestrings`: `LineString[] \| LatLng[][] \| LatLngLiteral[][]` Constructs a MultiLineString. A MultiLineString is a collection of LineString.

Methods
`getAt`	`getAt(n)` Parameters: `n`: `number` Return Type: `LineString` Returns the n-th LineString of the MultiLineString.
`getArray`	`getArray()` Parameters: None Return Type: `LineString[]`
`forEachLatLng`	`forEachLatLng(callback)` Parameters: `callback`: `(point: LatLng) => void` Return Type: `void`
`getType`	`getType()` Parameters: None Return Type: `"MultiLineString"` Returns `"MultiLineString"`.

MultiPoint class

woosmap.map.Data.MultiPoint

This class implements Geometry<"MultiPoint", Coordinates[]>.

Constructor
`MultiPoint`	`MultiPoint(points)` Parameters: `points`: `LatLng[] \| Coordinates[] \| LatLngLiteral[]` Constructs a Multipoint geometry.

Methods
`getAt`	`getAt(n)` Parameters: `n`: `number` Return Type: `LatLng` Returns n-th Point of the MultiPoint.
`getArray`	`getArray()` Parameters: None Return Type: `LatLng[]` Return the array of points
`getLength`	`getLength()` Parameters: None Return Type: `number` Returns the length of the multipoint.
`forEachLatLng`	`forEachLatLng(callback)` Parameters: `callback`: `(point: LatLng) => void` Return Type: `void` For each point calls the callback.
`getType`	`getType()` Parameters: None Return Type: `"MultiPoint"` Returns `"MultiPoint"`.

MultiPolygon class

woosmap.map.Data.MultiPolygon

This class implements Geometry<"MultiPolygon", Coordinates[][][]>.

Constructor
`MultiPolygon`	`MultiPolygon(elements)` Parameters: `elements`: `Polygon[] \| LinearRing[][] \| LatLng[][][] \| LatLngLiteral[][][]` Constructs a MultiPolygon geometry. A MultiPolygon is a set of Polygons.

Methods
`getAt`	`getAt(n)` Parameters: `n`: `number` Return Type: `Polygon` Returns the n-th polygon of the MultiPolygon.
`getArray`	`getArray()` Parameters: None Return Type: `Polygon[]` Returns the array of Polygons that makes the MultiPolygon.
`getLength`	`getLength()` Parameters: None Return Type: `number` Return the count of Polygon in the MultiPolygon.
`forEachLatLng`	`forEachLatLng(callback)` Parameters: `callback`: `(point: LatLng) => void` Return Type: `void`
`getType`	`getType()` Parameters: None Return Type: `"MultiPolygon"` Returns `"MultiPolygon"`.

Point class

woosmap.map.Data.Point

This class implements Geometry<"Point", Coordinates>.

Constructor
`Point`	`Point(point)` Parameters: `point`: `LatLng \| Coordinates \| LatLngLiteral` the geometry Constructs a Point geometry

Methods
`get`	`get()` Parameters: None Return Type: `LatLng` Returns the point geometry
`forEachLatLng`	`forEachLatLng(callback)` Parameters: `callback`: `(point: LatLng) => void` Return Type: `void`
`getType`	`getType()` Parameters: None Return Type: `"Point"` Returns `"Point"`.

Polygon class

woosmap.map.Data.Polygon

This class implements Geometry<"Polygon", Coordinates[][]>.

Constructor
`Polygon`	`Polygon(elements)` Parameters: `elements`: `LinearRing[] \| LatLng[][] \| LatLngLiteral[][] \| Coordinates[][]` Constructs a Polygon, using a set of linear ring.

Methods
`getAt`	`getAt(n)` Parameters: `n`: `number` Return Type: `LinearRing` Returns the n-th LinearRing of the Polygon.
`getArray`	`getArray()` Parameters: None Return Type: `LinearRing[]` Returns the array of LinearRing that composes the Polygon.
`getLength`	`getLength()` Parameters: None Return Type: `number` Returns the count of LinearRings that composes the Polygon.
`forEachLatLng`	`forEachLatLng(callback)` Parameters: `callback`: `(point: LatLng) => void` Return Type: `void` For each LinearRing call `callback`.
`getType`	`getType()` Parameters: None Return Type: `"Polygon"` Returns `"Polygon"`.

DatasetsOverlay class

woosmap.map.DatasetsOverlay

Constructor
`DatasetsOverlay`	`DatasetsOverlay(datasetId)` Parameters: `datasetId`: `string`

Methods
`setMap`	`setMap(map)` Parameters: `map`: `Map \| null` Return Type: `void` Adds or remove the overlay from the map.

DatasetsService class

woosmap.map.DatasetsService

Constructor
`DatasetsService`	`DatasetsService(datasetId)` Parameters: `datasetId`: `string`

Methods
`intersects`	`intersects(request, pagination?)` Parameters: `request`: `DatasetsSearchWithInputGeometryRequest` The geometry to intersect with. `pagination`: `DatasetsPaginationRequest` Return Type: `Promise<DatasetsSearchResponse>` Returns features intersecting with the geometry, buffer is applied if defined.
`within`	`within(request, pagination?)` Parameters: `request`: `DatasetsSearchWithPolygonGeometryRequest` The geometry to intersect with. Within operation only supports Polygons. `pagination`: `DatasetsPaginationRequest` Return Type: `Promise<DatasetsSearchResponse>` Returns features within by the geometry, buffer is applied if defined.
`contains`	`contains(request, pagination?)` Parameters: `request`: `DatasetsSearchWithInputGeometryRequest` `pagination`: `DatasetsPaginationRequest` Return Type: `Promise<DatasetsSearchResponse>` Returns feature containing the geometry.
`search`	`search(request, pagination?)` Parameters: `request`: `DatasetsSearchRequest` `pagination`: `DatasetsPaginationRequest` Return Type: `Promise<DatasetsSearchResponse>` Searches for features matching the query.
`getFeature`	`getFeature(featureId)` Parameters: `featureId`: `string` Return Type: `Promise<DatasetsFeature>` Get the full feature, with its geometry.

DirectionsRenderer class

woosmap.map.DirectionsRenderer

This class extends MVCObject.

Constructor
`DirectionsRenderer`	`DirectionsRenderer(options)` Parameters: `options`: `DirectionsRendererOptions`

Methods
`setMap`	`setMap(map)` Parameters: `map`: `Map \| null` Return Type: `void` Sets the map where to render the directions.
`setDirections`	`setDirections(directions)` Parameters: `directions`: `DirectionResult` Return Type: `void` Sets the directions result to render.
`setRouteIndex`	`setRouteIndex(routeIndex)` Parameters: `routeIndex`: `number` Return Type: `void` Sets the route index in the DirectionResult object to render. By default the first route (0) will be rendered.

Events
`routeIndex_changed`	This event is triggered when the routeIndex changes.

DirectionsService class

woosmap.map.DirectionsService

Constructor
`DirectionsService`	`DirectionsService()` Parameters: None

Methods
`route`	`route(request, callback)` Parameters: `request`: `DirectionRequest` `callback`: `(result: DirectionResult, status: string) => any` The callback to call Return Type: `void` Issue a directions search request.

DistanceService class

woosmap.map.DistanceService

A service for computing distances and durations between multiple origins and destinations and retrieving isochrone destinations.

Constructor
`DistanceService`	`DistanceService()` Parameters: None A service for computing distances and durations between multiple origins and destinations and retrieving isochrone destinations.

Methods
`getDistanceMatrix`	`getDistanceMatrix(request)` Parameters: `request`: `DistanceMatrixRequest` The distance matrix request. Return Type: `Promise<DistanceMatrixResponse>` Retrieves distances and durations for the supplied matrix request.
`getDistanceIsochrone`	`getDistanceIsochrone(request)` Parameters: `request`: `DistanceIsochroneRequest` The distance isochrone request. Return Type: `Promise<DistanceIsochroneResponse>` Find all destinations that can be reached in a specific amount of time or a maximum travel distance based on the supplied isochrone request.

Drawing class

woosmap.map.Drawing

This class extends MapboxDraw.

Add drawing capabilities to Woosmap Map. You can call methods of a Drawing instance and add custom modes as you would with a MapboxDraw instance. This Drawing library is not loaded by default when you load the Map JS API but must be explicitly specified through use of a libraries parameter in SDK URL.

Add the Drawing Lib

        <script async
    src="https://sdk.woosmap.com/map/map.js?key=YOUR_API_KEY&libraries=drawing&callback=initMap">
</script>

Create a Draw control and add it to the map

        var draw = new woosmap.map.Drawing(drawOptions);
draw.addControl(map);

Constructor
`Drawing`	`Drawing(options?)` Parameters: `options`: `MapboxDraw.MapboxDrawOptions`

Methods
`addControl`	`addControl(map, position?)` Parameters: `map`: `Map` The map object to add control to. `position`: `ControlPositionType` Position on the map to which the control will be added. Defaults to ‘top-right’. Return Type: `void` Adds Drawing Control to a Map.
`removeControl`	`removeControl()` Parameters: None Return Type: `void` Removes Drawing Control to its attached Map.
`addListener`	`addListener(event, handler)` Parameters: `event`: `MapboxDraw.DrawEventType` `handler`: `Function` The function to call when event is triggered Return Type: `void` Register Drawing Events

ImageMapType class

woosmap.map.ImageMapType

This class implements MapType.

ImageMapType defines tiled image layer that can be added to the map. It supports both xyz and tms tile schemes.

Adds a tileLayer with .5 opacity.

        const tiledLayer = new woosmap.map.ImageMapType({
 url: "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
 scheme: "xyz",
 maxZoom: 22,
 minZoom: 0,
 opacity: 0.5,
});
map.overlayMapTypes.insertAt(0, tiledLayer);

Constructor
`ImageMapType`	`ImageMapType(opts)` Parameters: `opts`: `ImageMapTypeOptions` ImageMapType defines tiled image layer that can be added to the map. It supports both `xyz` and `tms` tile schemes.

Properties
`maxZoom`	Type: `number`
`minZoom`	Type: `number`

Methods
`getTile`	`getTile(tileCoord, zoom, ownerDocument)` Parameters: `tileCoord`: `Point` `zoom`: `number` `ownerDocument`: `null` Return Type: `(Element \| null)`
`releaseTile`	`releaseTile(tile)` Parameters: `tile`: `Element` Return Type: `void`

InfoWindow class

woosmap.map.InfoWindow

This class extends woosmap.map.MVCObject.

Constructor
`InfoWindow`	`InfoWindow(options)` Parameters: `options`: `InfoWindowOptions`

Methods
`open`	`open(map, anchor)` Parameters: `map`: `Map` `anchor`: `Marker \| LatLng \| LatLngLiteral` Return Type: `void` Opens the info window.
`close`	`close()` Parameters: None Return Type: `void` Closes this InfoWindow by removing it from the DOM structure.
`setContent`	`setContent(content)` Parameters: `content`: `string` Return Type: `void` Sets the info window content
`setPosition`	`setPosition(positionOrMarker)` Parameters: `positionOrMarker`: `Marker \| LatLng \| LatLngLiteral` Return Type: `void` Sets the anchor
`setOffset`	`setOffset(offset)` Parameters: `offset`: `Point` Return Type: `void` Sets the offset
`setMarker`	`setMarker(marker?)` Parameters: `marker`: `(Marker \| null)` Return Type: `void` Sets the marker
`setMap`	`setMap(map)` Parameters: `map`: `Map \| null` Return Type: `void` Sets the info window map.
`getMap`	`getMap()` Parameters: None Return Type: `(Map \| null)` Gets the current map bound to the

LatLng class

woosmap.map.LatLng

Constructor

Constructor
`LatLng`	`LatLng(lat, lng?)` Parameters: `lat`: `LatLng \| LatLngLiteral \| number \| (() => number)` `lng`: `number \| (() => number)` Creates a `LatLng` object representing a geographic point. Latitude is specified in degrees within the range [-90, 90]. Longitude is specified in degrees within the range [-180, 180]. Set `noWrap` to `true` to enable values outside of this range. Note the ordering of latitude and longitude.


LatLng

LatLng(lat, lng?)

Parameters:

lat: LatLng | LatLngLiteral | number | (() => number)
lng: number | (() => number)

Creates a LatLng object representing a geographic point. Latitude is specified in degrees within the range [-90, 90]. Longitude is specified in degrees within the range [-180, 180]. Set noWrap to true to enable values outside of this range. Note the ordering of latitude and longitude.

Properties
`lat`	Type: `() => number` Returns the latitude in degrees.
`lng`	Type: `() => number` Returns the longitude in degrees.

Methods
`equals`	`equals(other)` Parameters: `other`: `LatLng` Return Type: `boolean` Comparison function.
`toJSON`	`toJSON()` Parameters: None Return Type: `LatLngLiteral` Converts to JSON representation. This function is intended to be used via `JSON.stringify`.
`toString`	`toString()` Parameters: None Return Type: `string`

LatLngBounds class

woosmap.map.LatLngBounds

Constructor
`LatLngBounds`	`LatLngBounds(northEast?, southWest?)` Parameters: `northEast`: `(LatLng \| LatLngLiteral \| null)` The north east coordinate. `southWest`: `(LatLng \| LatLngLiteral \| null)` The south west coordinate. Creates a LatLngBounds object

Methods
`extend`	`extend(latlng)` Parameters: `latlng`: `LatLng \| LatLngLiteral` Return Type: `void` Extends the current bounds with point.
`contains`	`contains(latlng)` Parameters: `latlng`: `LatLng \| LatLngLiteral` Return Type: `boolean` Checks if current bounds contain latlng.
`intersects`	`intersects(other)` Parameters: `other`: `LatLngBounds` Return Type: `boolean` Checks if bounds are intersecting with other.
`union`	`union(other)` Parameters: `other`: `LatLngBounds` Return Type: `void` Computes the union of this bounds and other.
`getNorthEast`	`getNorthEast()` Parameters: None Return Type: `LatLng` Returns the north-east corner of this bounds.
`getSouthWest`	`getSouthWest()` Parameters: None Return Type: `LatLng` Returns the south-west corner of this bounds.
`getCenter`	`getCenter()` Parameters: None Return Type: `LatLng` Computes the center of the latlng bounds.
`isEmpty`	`isEmpty()` Parameters: None Return Type: `boolean` Checks if the current bounds are empty.

LocalitiesService class

woosmap.map.LocalitiesService

Contains methods related to retrieving autocomplete predictions, geocoding for localities and retrieving details

Constructor
`LocalitiesService`	`LocalitiesService()` Parameters: None Contains methods related to retrieving autocomplete predictions, geocoding for localities and retrieving details

Methods
`autocomplete`	`autocomplete(request)` Parameters: `request`: `LocalitiesAutocompleteRequest` The localities autocompletion request. Return Type: `Promise<LocalitiesAutocompleteResponse>` Retrieves localities autocomplete predictions based on the supplied autocomplete request.
`geocode`	`geocode(request)` Parameters: `request`: `LocalitiesGeocodeRequest` The localities geocode request. Return Type: `Promise<LocalitiesGeocodeResponse>` Retrieves localities results based on the supplied geocode request.
`getDetails`	`getDetails(request)` Parameters: `request`: `LocalitiesDetailsRequest` The localities details request. Return Type: `Promise<LocalitiesDetailsResponse>` Retrieves details about the locality identified by the given `public_id`
`nearby`	`nearby(request)` Parameters: `request`: `LocalitiesNearbyRequest` The localities nearby request. Return Type: `Promise<LocalitiesNearbyResponse>` Retrieves localities results based on the nearby request.

MVCArray class

woosmap.map.MVCArray

This class extends woosmap.map.MVCObject.

Constructor
`MVCArray`	`MVCArray(array?)` Parameters: `array`: `T[]`

Methods
`clear`	`clear()` Parameters: None Return Type: `void` Removes all elements from the array.
`forEach`	`forEach(callback)` Parameters: `callback`: `(element: T, index: number) => void` Return Type: `void` Iterate over each element, calling the provided callback. The callback is called for each element like: callback(element, index).
`getArray`	`getArray()` Parameters: None Return Type: `T[]`
`getAt`	`getAt(i)` Parameters: `i`: `number` index Return Type: `T` Get the element at the specified index.
`getLength`	`getLength()` Parameters: None Return Type: `number` Get the number of elements in this array.
`insertAt`	`insertAt(i, elem)` Parameters: `i`: `number` `elem`: `T` Return Type: `void` Inserts an element at the specified index.
`pop`	`pop()` Parameters: None Return Type: `T` Removes the last element of the array and returns that element.
`push`	`push(elem)` Parameters: `elem`: `T` Return Type: `number` Adds one element to the end of the array and returns the new length of the array.
`removeAt`	`removeAt(i)` Parameters: `i`: `number` Return Type: `T` Removes an element from the specified index.
`setAt`	`setAt(i, elem)` Parameters: `i`: `number` `elem`: `T` Return Type: `void` Sets an element at the specified index.
`indexOf`	`indexOf(elem)` Parameters: `elem`: `T` Return Type: `number` Returns the index of a given element.

MVCObject class

woosmap.map.MVCObject

Constructor for MVCObject.

Constructor
`MVCObject`	`MVCObject()` Parameters: None Constructor for MVCObject.

Methods
`bindTo`	`bindTo(key, target, targetKey?, notify?)` Parameters: `key`: `string` the property to be bound `target`: `object` the object to bind to `targetKey`: `string` optional the name of the property on the target, if different from the name of the property on the observer `notify`: `boolean` optional do not call _changed callback upon binding Return Type: `void` Binds the property identified by ‘key’ to the specified target.
`isPropertyBound`	`isPropertyBound(key)` Parameters: `key`: `string` the property to set Return Type: `boolean` Is this property a complex object - is it bound as either observer or target
`get`	`get(key)` Parameters: `key`: `string` the property to fetch Return Type: `mixed` Returns the value of the property specified by `key`
`set`	`set(key, value, forceCallback?)` Parameters: `key`: `string` the name of the property to set `value`: `mixed` the new value of the property identified by `key` `forceCallback`: `boolean` optional call callbacks, regardless of whether the value has changed or not. Return Type: `void` Sets `value` to `key` on `this`.
`setOptions`	`setOptions(keyValuePairs)` Parameters: `keyValuePairs`: `object` an object containing `key` => `value` of properties to change Return Type: `void` Set all the values of the properties contained in `keyValuePairs`
`unbind`	`unbind(key)` Parameters: `key`: `string` Return Type: `void` Un-bind the property identified by `key` from its current target
`unbindAll`	`unbindAll()` Parameters: None Return Type: `void` Unbind all bound properties on this object
`addListener`	`addListener(eventName, handler)` Parameters: `eventName`: `String` `handler`: `Function` Return Type: `MapEventListener` Adds a listener for eventName.

Map class

woosmap.map.Map

This class extends woosmap.map.MVCObject.

Constructor
`Map`	`Map(mapDiv, options?)` Parameters: `mapDiv`: `HTMLElement \| string` HTMLElement \| string `options`: `MapOptions` MapOptions Creates a new map inside the given HTML container, which is typically a `DIV` element.

Properties
`data`	Type: `Data` An instance of `Data`, bound to the map. Add features to this `Data` object to conveniently display them on this map.
`overlayMapTypes`	Type: `MVCArray<MapType>` Additional map types to overlay.

Methods
`fitBounds`	`fitBounds(bounds, padding?, animate?)` Parameters: `bounds`: `LatLngBounds \| LatLngBoundsLiteral` `padding`: `Padding` `animate`: `boolean` Return Type: `void` Sets the viewport to contain the given bounds.
`getBounds`	`getBounds(padding?)` Parameters: `padding`: `Padding` Return Type: `LatLngBounds` Returns the lat/lng bounds of the current viewport. Optionally takes a padding parameter.
`getCenter`	`getCenter()` Parameters: None Return Type: `LatLng` Returns the position displayed at the center of the map.
`getDiv`	`getDiv()` Parameters: None Return Type: `HTMLElement`
`getHeading`	`getHeading()` Parameters: None Return Type: `number` Returns the compass heading. The heading value is measured in degrees (clockwise) from cardinal direction North.
`getTilt`	`getTilt()` Parameters: None Return Type: `number` Returns the current angle of incidence of the map, in degrees from the viewport plane to the map plane
`getZoom`	`getZoom()` Parameters: None Return Type: `number` Returns the current angle of incidence of the map, in degrees from the viewport plane to the map plane.
`panBy`	`panBy(x, y)` Parameters: `x`: `number` Number of pixels to move the map in the x direction. `y`: `number` Number of pixels to move the map in the y direction. Return Type: `void` Changes the center of the map by the given distance in pixels
`panTo`	`panTo(latLng, padding?)` Parameters: `latLng`: `LatLng \| LatLngLiteral` `padding`: `Padding` Return Type: `void` Changes the center of the map to the given LatLng.
`flyTo`	`flyTo(options)` Parameters: `options`: `FlyToOptions` Return Type: `void` Changes any combination of center, zoom, bearing, and pitch, animating the transition along a curve that evokes flight.
`panToBounds`	`panToBounds(latLngBounds, padding)` Parameters: `latLngBounds`: `LatLngBounds \| LatLngBoundsLiteral` `padding`: `number \| Padding` Return Type: `void` Pans the map by the minimum amount necessary to contain the given LatLngBounds. It makes no guarantee where on the map the bounds will be, except that the map will be panned to show as much of the bounds as possible inside `{currentMapSizeInPx} - {padding}.`
`setCenter`	`setCenter(center, padding?)` Parameters: `center`: `LatLng \| LatLngLiteral` `padding`: `Padding` Return Type: `void` Sets the map center
`setHeading`	`setHeading(heading)` Parameters: `heading`: `number` Return Type: `void` Sets the compass heading for map measured in degrees from cardinal direction North.
`setTilt`	`setTilt(tilt)` Parameters: `tilt`: `number` Return Type: `void`
`setZoom`	`setZoom(zoom)` Parameters: `zoom`: `number` Return Type: `void`

Events
`bounds_changed`	This event is fired when the viewport bounds have changed.
`center_changed`	This event is fired when the map center property changes.
`click`	This event is fired when the user clicks on the map.
`dblclick`	This event is fired when the user double-clicks on the map.
`drag`	This event is repeatedly fired while the user drags the map.
`dragend`	This event is fired when the user stops dragging the map.
`dragstart`	This event is fired when the user starts dragging the map.
`idle`	This event is fired when the map becomes idle after panning or zooming.
`mousemove`	This event is fired whenever the user’s mouse moves over the map container.
`mouseout`	This event is fired when the user’s mouse exits the map container.
`mouseover`	This event is fired when the user’s mouse enters the map container.
`rightclick`	This event is fired when the DOM contextmenu event is fired on the map container.
`zoom_changed`	This event is fired when the map zoom property changes.

Marker class

woosmap.map.Marker

This class extends woosmap.map.MVCObject.

Constructor
`Marker`	`Marker(options?)` Parameters: `options`: `MarkerOptions` Constructs a Marker

Properties
`cursor`	Type: `string`
`map`	Type: `Map \| null`
`position`	Type: `LatLng`

Methods
`setIcon`	`setIcon(icon)` Parameters: `icon`: `Icon \| string` Return Type: `void`
`setMap`	`setMap(map?)` Parameters: `map`: `(Map \| null)` Return Type: `void`
`setOpacity`	`setOpacity(opacity)` Parameters: `opacity`: `number` Return Type: `void` Sets the marker opacity.
`getOpacity`	`getOpacity()` Parameters: None Return Type: `number` Gets the marker opacity.
`getPosition`	`getPosition()` Parameters: None Return Type: `LatLng` Get the marker’s geographical location.The longitude of the result may differ by a multiple of 360 degrees from the longitude previously set by `setLngLat` because `Marker` wraps the anchor longitude across copies of the world to keep the marker on screen.
`setPosition`	`setPosition(position, animate?, options?)` Parameters: `position`: `LatLng \| LatLngLiteral` `animate`: `boolean` Specifies whether to apply smooth transition between two positions. Animation is disabled by default. `options`: `MarkerAnimateOptions` The animation options to apply. Return Type: `void` Sets the position of the marker
`getOffset`	`getOffset()` Parameters: None Return Type: `Point` Get the marker’s offset.
`setOffset`	`setOffset(offset)` Parameters: `offset`: `Point` The offset in pixels as a {@link PointLike} object to apply relative to the element’s center. Negatives indicate left and up. Return Type: `Marker` Sets the offset of the marker
`setDraggable`	`setDraggable(shouldBeDraggable)` Parameters: `shouldBeDraggable`: `boolean` Turns drag functionality on/off Return Type: `Marker` Sets the `draggable` property and functionality of the marker
`getDraggable`	`getDraggable()` Parameters: None Return Type: `boolean` Returns true if the marker can be dragged
`setRotation`	`setRotation(rotation)` Parameters: `rotation`: `number` The rotation angle of the marker (clockwise, in degrees), relative to its respective {@link Marker#rotationAlignment} setting. Return Type: `Marker` Sets the `rotation` property of the marker.
`getRotation`	`getRotation()` Parameters: None Return Type: `number` Returns the current rotation angle of the marker (in degrees).
`setRotationAlignment`	`setRotationAlignment(alignment)` Parameters: `alignment`: `string` Sets the `rotationAlignment` property of the marker. Return Type: `Marker` Sets the `rotationAlignment` property of the marker.
`getRotationAlignment`	`getRotationAlignment()` Parameters: None Return Type: `string` Returns the current `rotationAlignment` property of the marker.
`setPitchAlignment`	`setPitchAlignment(alignment?)` Parameters: `alignment`: `string` Sets the `pitchAlignment` property of the marker. If alignment is ‘auto’, it will automatically match `rotationAlignment`. Return Type: `Marker` Sets the `pitchAlignment` property of the marker.
`getPitchAlignment`	`getPitchAlignment()` Parameters: None Return Type: `string` Returns the current `pitchAlignment` property of the marker.

Events
`click`	This event is fired when the marker was clicked.
`mouseover`	This event is fired when the mouse enters the area of the marker.
`mouseout`	This event is fired when the mouse leaves the area of the marker.
`clickable_changed`	This event is fired when markers `clickable` property changes.
`cursor_changed`	This event is fired when markers `cursor` property changes.
`icon_changed`	This event is fired when markers `icon` property changes.
`position_changed`	This event is fired when markers `position` property changes.
`dragstart`	Fired when dragging starts
`drag`	Fired while dragging
`dragend`	Fired when the marker is finished being dragged
`draggable_changed`	This event is fired when markers `draggable` property changes.
`visible_changed`	This event is fired when markers `visible` property changes.
`zIndex_changed`	This event is fired when markers `zIndex` property changes.

OverlayView class

woosmap.map.OverlayView

This class allows you to create custom overlay objects on the map. To use this class, set your overlay’s class to extend from OverlayView. You’ll need to implement three methods: onAdd(), draw(), and onRemove().

Example

        class MyOverlay extends woosmap.map.OverlayView {
 constructor({ map }) {
      super();
      this.setMap(map);
 }
 onAdd(){}
 draw(){}
 onRemove(){}
}

Constructor
`OverlayView`	`OverlayView()` Parameters: None This class allows you to create custom overlay objects on the map. To use this class, set your overlay’s class to extend from `OverlayView`. You’ll need to implement three methods: `onAdd()`, `draw()`, and `onRemove()`.

Methods
`draw`	`draw()` Parameters: None Return Type: `void` This method should be implemented to draw or update the overlay. Use the position from `projection.fromLatLngToDivPixel()` to correctly position the overlay relative to the `MapPanes`. This method is called after `onAdd()`, and whenever the zoom or center of the map changes. Avoid performing computationally expensive operations in this method.
`getMap`	`getMap()` Parameters: None Return Type: `(Map \| null)` Retrieves the map associated with this overlay.
`getPanes`	`getPanes()` Parameters: None Return Type: `(MapPanes \| null)` Retrieves the panes in which this `OverlayView` can be rendered. The panes are not initialized until onAdd is called by the API.
`getProjection`	`getProjection()` Parameters: None Return Type: `(Projection \| null)` Retrieves the map canvas `Projection` object associated with this `OverlayView`. The projection is not initialized until `onAdd` is called by the API.
`onAdd`	`onAdd()` Parameters: None Return Type: `void` This method should be implemented to initialize the overlay DOM elements. It is called once after `setMap()` is called with a valid map. At this point, panes and projection will have been initialized.
`onRemove`	`onRemove()` Parameters: None Return Type: `void` This method should be implemented to remove your elements from the DOM. It is called once following a call to `setMap(null)`.
`setMap`	`setMap(map)` Parameters: `map`: `Map \| null` The map to add the overlay to, or null to remove it. Return Type: `void` Adds or removes the overlay from the map.

Point class

woosmap.map.Point

Constructor
`Point`	`Point(x, y)` Parameters: `x`: `number` `y`: `number` Creates a Point object

Methods
`equals`	`equals(other)` Parameters: `other`: `Point` Return Type: `boolean` Indicates whether some other object is “equal to” this one.

Polygon class

woosmap.map.Polygon

This class extends BasePolygon.

Constructor
`Polygon`	`Polygon(options)` Parameters: `options`: `PolygonOptions` Constructs a polygon.

Methods
`getPath`	`getPath()` Parameters: None Return Type: `MVCArray<LatLng>` Returns the outer path of the polygon.
`getPaths`	`getPaths()` Parameters: None Return Type: `MVCArray<MVCArray<LatLng>>` Returns all the path that compose the polygon.
`setOptions`	`setOptions(options)` Parameters: `options`: `PolygonOptions` Return Type: `void` Sets the polygon options.
`setPath`	`setPath(path)` Parameters: `path`: `MVCArray<LatLng> \| Array<LatLng \| LatLngLiteral>` Return Type: `void` Sets the polygon path.
`setPaths`	`setPaths(paths)` Parameters: `paths`: `MVCArray<MVCArray<LatLng>> \| MVCArray<LatLng> \| Array<Array<LatLng \| LatLngLiteral>> \| Array<LatLng \| LatLngLiteral>` Return Type: `void` Sets the polygon paths.

Polyline class

woosmap.map.Polyline

This class extends BaseGeometry.

Constructor
`Polyline`	`Polyline(options)` Parameters: `options`: `PolylineOptions` Constructs a Polyline.

Methods
`getPath`	`getPath()` Parameters: None Return Type: `MVCArray<LatLng>`
`setOptions`	`setOptions(options)` Parameters: `options`: `PolylineOptions` Return Type: `void`
`setPath`	`setPath(path)` Parameters: `path`: `MVCArray<LatLng> \| LatLng[] \| LatLngLiteral[]` Return Type: `void`

Rectangle class

woosmap.map.Rectangle

This class extends BasePolygon.

Constructor
`Rectangle`	`Rectangle(options)` Parameters: `options`: `RectangleOptions` Constructs a Rectangle.

Methods
`getBounds`	`getBounds()` Parameters: None Return Type: `LatLngBounds`
`setBounds`	`setBounds(bounds)` Parameters: `bounds`: `LatLngBounds \| LatLngBoundsLiteral` Return Type: `void`
`setOptions`	`setOptions(options)` Parameters: `options`: `RectangleOptions` Return Type: `void`

Size class

woosmap.map.Size

Constructor
`Size`	`Size(width, height)` Parameters: `width`: `number` `height`: `number` Creates a Size object

Methods
`equals`	`equals(other)` Parameters: `other`: `Size` Return Type: `boolean` Indicates whether some other object is “equal to” this one.

StoresOverlay class

woosmap.map.StoresOverlay

This class extends woosmap.map.OverlayView.

Constructor
`StoresOverlay`	`StoresOverlay(style)` Parameters: `style`: `Style` Constructs a StoreOverlay

Methods
`clearSelection`	`clearSelection()` Parameters: None Return Type: `void` Clears selected store if any
`setSelection`	`setSelection(feature)` Parameters: `feature`: `Object` Return Type: `void` Sets the selected store
`setQuery`	`setQuery(query?)` Parameters: `query`: `(string \| null)` Return Type: `void` Sets the query used to fetch stores. To clear the query set it to undefined.
`setMap`	`setMap(map?)` Parameters: `map`: `(Map \| null)` Return Type: `void`

Events
`store_unselected`	This event is triggered when a store previously selected was unselected.
`store_selected`	This event is triggered when a store is selected

StoresService class

woosmap.map.StoresService

Contains methods related to retrieving stores and stores’ bounds.

Constructor
`StoresService`	`StoresService()` Parameters: None Contains methods related to retrieving stores and stores’ bounds.

Methods
`autocomplete`	`autocomplete(request)` Parameters: `request`: `StoresAutocompleteRequest` The store autocompletion request. Return Type: `Promise<StoresAutocompleteResponse>` Retrieves stores autocomplete suggestions based on the supplied autocomplete request.
`search`	`search(request)` Parameters: `request`: `StoresSearchRequest` The store search request. Return Type: `Promise<StoresSearchResponse>` Searches stores based on the supplied search request.
`getStoreById`	`getStoreById(storeId)` Parameters: `storeId`: `string` The store ID. Return Type: `Promise<StoreResponse>` Retrieves a store object based on the supplied store ID.
`getBounds`	`getBounds(request)` Parameters: `request`: `StoresBoundsRequest` The bounds search request. Return Type: `Promise<StoresBoundsResponse>` Retrieves bounds of stores based on the supplied bounds search request.

TransitRenderer class

woosmap.map.TransitRenderer

This class extends MVCObject.

Constructor
`TransitRenderer`	`TransitRenderer(options?)` Parameters: `options`: `TransitRendererOptions`

Methods
`setMap`	`setMap(map)` Parameters: `map`: `Map \| null` Sets the map.
`setRouteIndex`	`setRouteIndex(routeIndex)` Parameters: `routeIndex`: `number` Sets the current selected route.
`setRoutes`	`setRoutes(routes)` Parameters: `routes`: `TransitRoute[]` Sets the transit routes to display.

Events
`routeIndex_changed`	This event is triggered when the routeIndex changes.

TransitService class

woosmap.map.TransitService

A service for computing route using public transportation networks.

Constructor
`TransitService`	`TransitService()` Parameters: None A service for computing route using public transportation networks.

Methods
`route`	`route(request)` Parameters: `request`: `TransitRouteRequest` The transit route request. Return Type: `Promise<TransitRouteResponse>` Get distance, duration and path (as a polyline and transports details) for a pair of origin and destination, based on the recommended route between those two points and by using public transportations.

Feature class

woosmap.map.data.Feature

Constructor
`Feature`	`Feature(featureData)` Parameters: `featureData`: `FeatureData \| GeoJSONFeature` Constructs a new Data.Feature

Methods
`getGeometry`	`getGeometry()` Parameters: None Return Type: `GeometryCollectionElement \| GeometryCollection` Returns the feature geometry.
`setGeometry`	`setGeometry(geometry)` Parameters: `geometry`: `GeometryCollectionElement \| GeometryCollection` Return Type: `void` Set the feature geometry.
`getId`	`getId()` Parameters: None Return Type: `string` Returns the feature id.
`getProperty`	`getProperty(name)` Parameters: `name`: `string` Return Type: `any` Returns the feature property
`removeProperty`	`removeProperty(name)` Parameters: `name`: `string` Return Type: `void` Removes property
`setProperty`	`setProperty(name, newValue)` Parameters: `name`: `string` `newValue`: `any` Return Type: `void` Sets the value of the specified property. If newValue is undefined this is equivalent to calling removeProperty.
`toGeoJson`	`toGeoJson(callback)` Parameters: `callback`: `(geojson: GeoJSONFeature) => void` Return Type: `void` Exports the feature to a GeoJSON object.

Events
`setgeometry`	This event is triggered when geometry is set.
`removeproperty`	This event is triggered when a property is removed.
`setproperty`	This event is triggered when a property is set.

APIError class

woosmap.map.errors.APIError

This class extends Error.

Constructor
`APIError`	`APIError()` Parameters: None

Properties
`statusCode`	Type: `number` The http Status code extracted from the response.