JS API v 1.4

Javascript Store Locator API Reference v 1.4

Loader class

Loader

Constructs a new WoosmapLoader instance.

Constructor
`Loader`	`Loader()` Parameters: None Constructs a new WoosmapLoader instance.

Methods
`load`	`load(loadOptions)` Parameters: `loadOptions`: `LoadOptions` Load method with one parameter and no version aliases.

BaseView class

woosmap.BaseView

This class extends MVCObject.

Constructor
`BaseView`	`BaseView()` Parameters: None Constructs a new BaseView `didLocationMarkerDragEnd` is called when the location marker drag did end.

Properties
`location`	Type: `LatLngLiteral` The user defined location. This property is bindable.
`marker`	Type: `google.maps.Marker` This marker is positioned on the map when `location` property changes. If this marker is set draggable (`marker.setDraggable(true)`) the location property will be changed when dropping the marker (ie. when the marker fires the `dragend` event).
`padding`	Type: `BoundsPadding` Controls the viewport padding used by fitBounds.
`selectedStore`	Type: `Store` The currently selected store. This property is bindable.
`stores`	Type: `Store[]` List of stores displayed. This property is bindable.

Methods
`init`	`init(map, options)` Parameters: `map`: `google.maps.Map` the google maps to manipulate. `options`: `BaseViewOptions` map’s zoom will be set to this value. If not, no zoom. Initializer method to call in subclasses. This is splitted from the constructor to allow subclasses to use it as their prototype.
`panTo`	`panTo(center, padding?, force?)` Parameters: `center`: `google.maps.LatLng` `padding`: `BoundsPadding` `force`: `Boolean` forces the pan even if the new center is within visible bounds. Sets the center of the map. Takes in account the `padding` values to displace the viewport.
`fitBounds`	`fitBounds(bounds, padding?)` Parameters: `bounds`: `google.maps.LatLngBounds` `padding`: `BoundsPadding` padding to apply to the viewport. Sets the viewport to contain the given bounds. Takes in account the `padding` values to displace the viewport.
`enableZoom`	`enableZoom(activate)` Parameters: `activate`: `boolean` (e.g. true or false) Enable or Disable zoom when select a store
`enablePan`	`enablePan(activate)` Parameters: `activate`: `boolean` (e.g. true or false) Enable or Disable pan when select a store
`enablePaddedStoreCenter`	`enablePaddedStoreCenter(activate)` Parameters: `activate`: `Boolean` Enable or Disable padded Store Center the padded store center triggers panning only if the selected store is outside the ‘visible zone’ ie. the current map bounds minus padding.
`stores_changed`	`stores_changed()` Parameters: None This is the function called when the stores property has changed.
`selectedStore_changed`	`selectedStore_changed()` Parameters: None This function is called when `selectedStore` property is changed
`getDataBounds`	`getDataBounds()` Parameters: None Return Type: `google.maps.LatLngBounds \| null` Process each feature in the dataLayer to compute the bounds of the displayed data.
`getMap`	`getMap()` Parameters: None Return Type: `google.maps.Map` Returns the google maps used by the BaseView.
`removeAllStores`	`removeAllStores()` Parameters: None Removes all the stores from the map.
`displayStore`	`displayStore(store)` Parameters: `store`: `Store` the store to display Adds a single store to the map, zoom + pan on it
`location_changed`	`location_changed()` Parameters: None This function is called when `location` property is changed
`addListener`	`addListener(eventName, callback)` Parameters: `eventName`: `EventName` `callback`: `StoreEventCallback` Return Type: `StoreEventListener` Adds a store event listener.
`removeListener`	`removeListener(storeEventListener)` Parameters: `storeEventListener`: `StoreEventListener` Removes a store event listener.

DataSearchSource class

woosmap.DataSearchSource

This class extends woosmap.utils.MVCObject.

Constructs a new DataSearchSource

Constructor

Constructor
`DataSearchSource`	`DataSearchSource(dataSource, searchTextOptions, nearbyOptions, polylineFilter?)` Parameters: `dataSource`: `DataSource` an instance of woosmap DataSource `searchTextOptions`: `TextSearchQuery` to set initial search parameters if used with autocomplete `nearbyOptions`: `NearbyOptions` containing two key : maxStores and maxDistanceFromUser for the nearby search if lat/lng are provided through location property. `polylineFilter`: `PolylineFilter` the PolylineFilter if you want filter on a polyline path Constructs a new DataSearchSource


DataSearchSource

DataSearchSource(dataSource, searchTextOptions, nearbyOptions, polylineFilter?)

Parameters:

dataSource: DataSource an instance of woosmap DataSource
searchTextOptions: TextSearchQuery to set initial search parameters if used with autocomplete
nearbyOptions: NearbyOptions containing two key : maxStores and maxDistanceFromUser for the nearby search if lat/lng are provided through location property.
polylineFilter: PolylineFilter the PolylineFilter if you want filter on a polyline path

Constructs a new DataSearchSource

Properties
`autocomplete_query`	Type: `string` Observes his query to launch the search into store’s data.
`location`	Type: `LatLngLiteral` Observes his location to narrow the search around a location. Needs to be completed with a maxStore and a maxDistanceFromUser in constructors option nearbyOptions
`searchParameters`	Type: `SearchParameters` Contains options to searchStores

Methods
`autocomplete_query_changed`	`autocomplete_query_changed()` Parameters: None Listens the changes of query.
`location_changed`	`location_changed()` Parameters: None Listens the changes of location.
`updateSearchQuery`	`updateSearchQuery(key, value)` Parameters: `key`: `string` the key of the searchQuery’s field which will be updated. `value`: `SearchQuery` the new value of the searchQuery’s field. Updated the searchQuery value.
`updateSearchQueryAndSearch`	`updateSearchQueryAndSearch(key, value)` Parameters: `key`: `string` the key of the searchQuery’s field which will be update. `value`: `SearchQuery` the new value of the searchQuery’s field. Updated the searchQuery value and launch a search with the new value.
`addFieldToSearchTextOptions`	`addFieldToSearchTextOptions(fieldName, operator)` Parameters: `fieldName`: `string` the new value of the searchTextOptions `operator`: `string` the new value of the operator for filtering Add a new field to searchTextOptions or update an existing field (new field will be used for store filtering).
`removeFieldFromSearchTextOptions`	`removeFieldFromSearchTextOptions(fieldName)` Parameters: `fieldName`: `string` the name of the field you want to remove Remove a field from searchTextOptions (so field will not be use anymore for filtering).Update stores list after removal.
`updateTextSearchQuery`	`updateTextSearchQuery()` Parameters: None Get the value of ‘autocomplete_query’ and searchTextOptions and update the SearchQuery with them. Then request new store list.
`updateTextSearchQueryAndSearch`	`updateTextSearchQueryAndSearch()` Parameters: None Get the value of ‘autocomplete_query’ and searchTextOptions and update the SearchQuery with them. Then request new store list.
`search`	`search(querySearchParameters?)` Parameters: `querySearchParameters`: `SearchQuery` an object containing a query for search. If no searchParameters is pass then DataSearchSource will use searchQuery property Use the woosmap API to search into store’s data with nearbyOptions, polylineFilter, searchQuery and location as parameters.
`setPolylineFilter`	`setPolylineFilter(polylineFilter)` Parameters: `polylineFilter`: `PolylineFilter` the PolylineFilter to filter on. Add or update the polylineFilter for the searchSource.To remove the filter set is value to `null`.
`setMaxStores`	`setMaxStores(maxStores)` Parameters: `maxStores`: `Number` the new maxStores value. Update the maxStores value.To remove the search option set is value to `null`.
`setMaxDistanceFromUser`	`setMaxDistanceFromUser(maxDistanceFromUser)` Parameters: `maxDistanceFromUser`: `Number` the new maxDistanceFromUser value. Update the maxDistanceFromUser value.To remove the search option set is value to `null`.

DataSource class

woosmap.DataSource

Constructor
`DataSource`	`DataSource(api_url?, api_key?)` Parameters: `api_url`: `String` `api_key`: `String` The DataSource object is the bridge to the server API.

Methods
`getFromApi`	`getFromApi(url, callback)` Parameters: `url`: `String` url for the request `callback`: `Function` callback called if request is successful Make an ajax call with the url and call the callback if success
`getAllStores`	`getAllStores(callback)` Parameters: `callback`: `Function` Return Type: `Promise` Returns all the stores.
`getNearbyStores`	`getNearbyStores(lat, lng, callback, maxStores, maxDistanceFromUser)` Parameters: `lat`: `Number` the latitude. `lng`: `Number` the longitude. `callback`: `function` the callback to be called with the stores. `maxStores`: `Number` the maximum number of stores returned. `maxDistanceFromUser`: `Number` radius in meters to filter the stores. Return Type: `Promise` Fetches stores that are near the (lng, lat) position and pass it to the callback. if `lat` and `lng` are not defined, we use the IP geolocation to pinpoint the user.
`getStoreById`	`getStoreById(store_id, callback)` Parameters: `store_id`: `String` `callback`: `Function` Return Type: `Promise` Fetches a store by its store_id.
`getStoresBySearchQuery`	`getStoresBySearchQuery(query, callback)` Parameters: `query`: `string` the query `callback`: `function` the callback to be called with the stores. Return Type: `Promise` Fetches stores that name matches the search query and pass it to the callback.
`searchStores`	`searchStores(searchQuery, callback)` Parameters: `searchQuery`: `SearchQuery` the query object (composed by query, tags and types) `callback`: `function` the callback to be called with the stores. Return Type: `Promise` Fetches stores that matches the search query and pass it to the callback.
`searchNearbyStores`	`searchNearbyStores(searchQuery, lat, lng, callback, maxStores, maxDistanceFromUser)` Parameters: `searchQuery`: `SearchQuery` the query object (composed by query, tags and types) `lat`: `Number` the latitude. `lng`: `Number` the longitude. `callback`: `Function` the callback to be called with the stores. `maxStores`: `Number` the maximum number of stores returned. `maxDistanceFromUser`: `Number` radius in meters to filter the stores. Return Type: `Promise` Fetches nearby stores that matches the search query and pass it to the callback.
`searchStoresByParameters`	`searchStoresByParameters(searchParameters, callback)` Parameters: `searchParameters`: `SearchParameters` an object containing all the data to do the search. `callback`: `Function` the callback to be called with the stores. Return Type: `Promise` Search on store given a list of information
`countStoresByParameters`	`countStoresByParameters(searchParameters, callback)` Parameters: `searchParameters`: `SearchParameters` an object containing all the data to do the search. `callback`: `Function` the callback to be called with the stores count as an Object. Return Type: `Promise` return the number of stores matching parameters
`storesBoundsByParameters`	`storesBoundsByParameters(searchParameters, callback)` Parameters: `searchParameters`: `SearchParameters` an object containing all the data to do the search. `callback`: `Function` the callback to be called with the bounds as google.maps.LatLngBoundsLiteral. returns {} if no stores matched. Return Type: `Promise` return the bounds for all stores matching parameters
`getProjectConfig`	`getProjectConfig(callback)` Parameters: `callback`: `Function` the callback to be called with the config. Return Type: `Promise` Get the config object for the Project.

LocatorWindow class

woosmap.LocatorWindow

This class extends woosmap.utils.MVCObject.

Constructor
`LocatorWindow`	`LocatorWindow(map, renderer, infoBoxOptions?)` Parameters: `map`: `google.maps.Map` Google Maps Map Object `renderer`: `TemplateRenderer` the Renderer used to build the inner HTML. `infoBoxOptions`: `InfoBoxOptions` the options for infoBox object Construct a LocatorWindow.

Properties
`selectedStore`	Type: `Store` The currently `selectedStore`. This property is bindable

Methods
`selectedStore_changed`	`selectedStore_changed()` Parameters: None When selectedStore changes open the InfoWindow on the current store. if selectedStore is null then close the InfoWindow.
`getAnchorForCoordinates`	`getAnchorForCoordinates(coordinates)` Parameters: `coordinates`: `Array` coordinates to build the anchor from. Return Type: `google.maps.MVCObject` Computes the Window anchor for `coordinates`
`getMarkerForCoordinates`	`getMarkerForCoordinates(coordinates)` Parameters: `coordinates`: `Array` to build the marker from. Return Type: `google.maps.Marker` Return a marker for `coordinates`
`openOn`	`openOn(store)` Parameters: `store`: `Object` the store that was selected. Opens the info window on the `store`.
`close`	`close()` Parameters: None Closes the Locatorwindow
`setOpeningCallback`	`setOpeningCallback(openingCallback?)` Parameters: `openingCallback`: `Function` a callback fired every time the infowindow open Adds a listener for `domready` event of infowindow. This method clears previously added `domready` listeners.
`setInfoBoxOptions`	`setInfoBoxOptions(options?)` Parameters: `options`: `InfoBoxOptions` containing each options that needs to be changed Method to set InfoboxOptions if it’s not a google InfoWindow

MapsLoader class

woosmap.MapsLoader

Constructor
`MapsLoader`	`MapsLoader(clientIdOrOptions?, librariesToLoad?)` Parameters: `clientIdOrOptions`: `String \| MapsLoaderOptions` parameters to load Google Maps API or clientId as string Deprecated : `clientIdOrOptions` and `librariesToLoad` can be strings . `librariesToLoad`: `String[]` Deprecated : a list of String containing additional google libraries to load. Construct a MapsLoader instance

Methods
`load`	`load(callback)` Parameters: `callback`: `function` the function to be called when done. Loads the google maps api and calls the callback when done.

TemplateRenderer class

woosmap.TemplateRenderer

Constructs a TemplateRendererInstance

Constructor
`TemplateRenderer`	`TemplateRenderer(template)` Parameters: `template`: `string` the hogan.js template string Constructs a TemplateRendererInstance

Methods
`render`	`render(properties?)` Parameters: `properties`: `object` the template context. Return Type: `any` Renders the compiled template with the context
`registerLambda`	`registerLambda(name, lambda)` Parameters: `name`: `String` `lambda`: `Function` Registers a template Lambda

TiledView class

woosmap.TiledView

This class extends BaseView.

TiledView this view is mostly compatible with {woosmap.View}. This object mixes two layers:

a tiled image layer for higher zoom levels
a tiled vector layer for lower zoom levels

Constructor
`TiledView`	`TiledView(map, options?)` Parameters: `map`: `google.maps.Map` `options`: `TiledViewOptions`

Methods
`setSearchParameters`	`setSearchParameters(searchParameters)` Parameters: `searchParameters`: `SearchParameters` Sets the `searchParameters` used to filter both image and vector layer.
`setSearchQuery`	`setSearchQuery(searchQuery)` Parameters: `searchQuery`: `SearchQuery` Sets the `searchQuery` used to filter both image and vector layer.
`setPolylineFilter`	`setPolylineFilter(polylineFilter)` Parameters: `polylineFilter`: `PolylineFilter` Sets the `polylineFilter` used to filter both image and vector layer.

View class

woosmap.View

This class extends woosmap.BaseView.

Constructs a View

Constructor
`View`	`View(map, markersOrOptions?, zoomLevel?)` Parameters: `map`: `google.maps.Map` the map to decorate `markersOrOptions`: `String \| DeprecatedStyleRule[] \| BaseViewOptions` the marker base url or the array of style rules. `zoomLevel`: `Number` the zoom level to use when selecting a Store.

ZipCodeProvider class

woosmap.ZipCodeProvider

This class extends woosmap.utils.MVCObject.

Constructs a new ZipCodeProvider

Constructor
`ZipCodeProvider`	`ZipCodeProvider()` Parameters: None Constructs a new ZipCodeProvider

Properties
`location`	Type: `LatLngLiteral` The `location` used by the reverse geocoding to derive the `zipcode`. This property is bindable.
`zipcode`	Type: `string` Stores the `zipcode` associated the `location`. This property is bindable.

Methods
`getZipCode`	`getZipCode()` Parameters: None Return Type: `string` Get the currently saved zipcode
`getZipCodeType`	`getZipCodeType()` Parameters: None Return Type: `string` Get the zipcode type
`location_changed`	`location_changed()` Parameters: None This method is called when the location has changed. It updates the zipcode by reverse geocoding

BaseLayer class

woosmap.layers.BaseLayer

Constructor
`BaseLayer`	`BaseLayer(options)` Parameters: `options`: `Object` BaseLayer.

Methods
`setMap`	`setMap(map)` Parameters: `map`: `google.maps.Map` Set the map instance
`getMap`	`getMap()` Parameters: None Return Type: `google.maps.Map` Getter to access to the map instance
`setHidden`	`setHidden(isHidden)` Parameters: `isHidden`: `Boolean` Set the visibility of the data
`getHidden`	`getHidden()` Parameters: None Return Type: `Boolean` Getter to access to the visibility state
`selectStore`	`selectStore(selectedStore)` Parameters: `selectedStore`: `Store` the store to select. Set the map instance

DataLayer class

woosmap.layers.DataLayer

This class extends woosmap.layers.BaseLayer.

Constructor
`DataLayer`	`DataLayer(options?)` Parameters: `options`: `DataLayerOptions` DataLayer

Methods
`displayStores`	`displayStores(stores)` Parameters: `stores`: `Store[]` the stores to display. Displays on the map the stores passed as parameter.
`displayNumberedStores`	`displayNumberedStores(stores)` Parameters: `stores`: `Store[]` the stores sorted by distance. Displays the stores with numbered icons.

TiledDataOverlay class

woosmap.layers.TiledDataOverlay

This class extends BaseLayer.

TiledDataOverlay Uses marker vector tiles and displays it using a renderer.

Constructor
`TiledDataOverlay`	`TiledDataOverlay(options?)` Parameters: `options`: `TiledOverlayOptions` TiledDataOverlay.

Methods
`clear`	`clear()` Parameters: None Clears the overlay data and cache.
`setMap`	`setMap(map)` Parameters: `map`: `google.maps.Map` Set the map instance
`setSearchParameters`	`setSearchParameters(searchParameters)` Parameters: `searchParameters`: `SearchParameters` Sets the search parameters used to filter the displayed data.
`setSearchQuery`	`setSearchQuery(searchQuery)` Parameters: `searchQuery`: `SearchQuery` the searchQuery. Sets the searchQuery used to filter the displayed data.
`setPolylineFilter`	`setPolylineFilter(polylineFilter)` Parameters: `polylineFilter`: `PolylineFilter` Sets the polylineFilter used to filter the displayed data.
`onAdd`	`onAdd()` Parameters: None
`onRemove`	`onRemove()` Parameters: None
`tileDidLoad`	`tileDidLoad(data)` Parameters: `data`: `GeoJSON` Called when a tile has finished loading
`tilesDidLoad`	`tilesDidLoad()` Parameters: None Called when all the tiles requested from the api server were fetched.

TiledImageLayer class

woosmap.layers.TiledImageLayer

Constructor
`TiledImageLayer`	`TiledImageLayer(options?)` Parameters: `options`: `TiledImageLayerOptions` options including map, and style. Constructs a new TiledImageLayer

Methods
`setMap`	`setMap(map)` Parameters: `map`: `google.maps.Map` the map to set the overlay FIXME: Not sure if it’s the best way of doing this. Set an overlay to a map with the tiles generated by the tiler server
`getMap`	`getMap()` Parameters: None Return Type: `google.maps.Map \| null` Returns the google map bound to the image layer.
`setSearchParameters`	`setSearchParameters(searchParameters)` Parameters: `searchParameters`: `SearchParameters` Sets the search parameters used to filter the displayed data.
`setSearchQuery`	`setSearchQuery(searchQuery)` Parameters: `searchQuery`: `SearchQuery` the searchQuery. Sets the searchQuery used to filter the displayed data.
`setPolylineFilter`	`setPolylineFilter(polylineFilter)` Parameters: `polylineFilter`: `PolylineFilter` Sets the polylineFilter used to filter the displayed data.

BaseRenderer class

woosmap.layers.renderers.BaseRenderer

Base renderer.

Constructor
`BaseRenderer`	`BaseRenderer(options)` Parameters: `options`: `Object`

Methods
`addEventListener`	`addEventListener(event, listener)` Parameters: `event`: `EventName` `listener`: `StoreEventListener` Adds an eventListener triggered when the event is triggered on markers.
`setClick`	`setClick(callback)` Parameters: `callback`: `StoreEventListener` Build the click listener with the callback argument
`getMap`	`getMap()` Parameters: None Return Type: `google.maps.Map` Getter to access to the map instance
`setMap`	`setMap(map)` Parameters: `map`: `google.maps.Map` Set the map instance
`displayStores`	`displayStores(stores)` Parameters: `stores`: `GeoJSON` Call to display the stores with the basic style
`displayNumberedStores`	`displayNumberedStores(stores)` Parameters: `stores`: `GeoJSON` Call to display the stores with the numbered style
`tileDidLoad`	`tileDidLoad(data)` Parameters: `data`: `GeoJSON` Call on each tiles request.
`tilesDidLoad`	`tilesDidLoad()` Parameters: None Called once all tiles request are finished.
`selectStore`	`selectStore(selectedStore)` Parameters: `selectedStore`: `Store` the store to select. Use the `selected` style for the `selectedStore`
`clear`	`clear()` Parameters: None Removes all the data and style from the layer.

DefaultRenderer class

woosmap.layers.renderers.DefaultRenderer

This class extends woosmap.layers.renderers.BaseRenderer.

Default renderer.

Constructor
`DefaultRenderer`	`DefaultRenderer(options)` Parameters: `options`: `Object`

Methods
`getMap`	`getMap()` Parameters: None Return Type: `google.maps.Map` Getter to access to the map instance
`setMap`	`setMap(map)` Parameters: `map`: `google.maps.Map` Set the map instance
`displayStores`	`displayStores(stores)` Parameters: `stores`: `GeoJSON` Call to display the stores with the basic style
`displayNumberedStores`	`displayNumberedStores(stores)` Parameters: `stores`: `GeoJSON` Call to display the stores with the numbered style
`tilesDidLoad`	`tilesDidLoad()` Parameters: None Called once all tiles request are finished.
`selectStore`	`selectStore(selectedStore)` Parameters: `selectedStore`: `Store` the store to select. Use the `selected` style for the `selectedStore`
`clear`	`clear()` Parameters: None Removes all the data and style from the layer.

MarkersRenderer class

woosmap.layers.renderers.MarkersRenderer

This class extends DefaultRenderer.

Constructor
`MarkersRenderer`	`MarkersRenderer(options)` Parameters: `options`: `RendererOptions` Markers renderer.

Methods
`displayMarkers`	`displayMarkers(features, markers?)` Parameters: `features`: `Store[]` `markers`: `google.maps.Marker` Display the markers of each features
`clear`	`clear()` Parameters: None Hide the markers and remove the idleListener
`setMap`	`setMap(map)` Parameters: `map`: `undefined \| google.maps.Map` Set the map instance.
`getMap`	`getMap()` Parameters: None Return Type: `undefined \| google.maps.Map` Return the map instance
`getDisplayingMarkers`	`getDisplayingMarkers()` Parameters: None Return Type: `google.maps.Marker[]` Return the markers object for the current bounds
`getDisplayingFeatures`	`getDisplayingFeatures()` Parameters: None Return Type: `Array` Return the features objects for the current bounds
`tileDidLoad`	`tileDidLoad(geojson)` Parameters: `geojson`: `GeoJSON`
`displayCurrentMarkers`	`displayCurrentMarkers()` Parameters: None Display the markers in the current bounds
`displayMarkersForStores`	`displayMarkersForStores(stores)` Parameters: `stores`: `GeoJSON` Display the marker for a stores list
`displayStores`	`displayStores(stores)` Parameters: `stores`: `GeoJSON` Display the stores list
`displayNumberedStores`	`displayNumberedStores(stores)` Parameters: `stores`: `GeoJSON` Display the stores list with a numbered style
`tilesDidLoad`	`tilesDidLoad()` Parameters: None
`selectStore`	`selectStore(data)` Parameters: `data`: `Store`

DirectionsProvider class

woosmap.location.DirectionsProvider

This class extends MVCObject.

Constructor

Constructor
`DirectionsProvider`	`DirectionsProvider(directionRendererOptions?, googleDirectionsRequestOptions?, directionsRequestErrorCallback?)` Parameters: `directionRendererOptions`: `google.maps.DirectionsRendererOptions` options for Google Maps. Deprecated since 1.2 Set options into {DirectionsResultsDisplayer} instead. `googleDirectionsRequestOptions`: `google.maps.DirectionsRequest` options for Google Maps. `directionsRequestErrorCallback`: `function` callback call if directions request status is not OK. The callback arguments are response (the google response) and status ( StatusCodes ). Constructs a new DirectionsProvider


DirectionsProvider

DirectionsProvider(directionRendererOptions?, googleDirectionsRequestOptions?, directionsRequestErrorCallback?)

Parameters:

directionRendererOptions: google.maps.DirectionsRendererOptions options for Google Maps. Deprecated since 1.2 Set options into {DirectionsResultsDisplayer} instead.
googleDirectionsRequestOptions: google.maps.DirectionsRequest options for Google Maps.
directionsRequestErrorCallback: function callback call if directions request status is not OK. The callback arguments are response (the google response) and status ( StatusCodes ).

Constructs a new DirectionsProvider

Properties
`directionsLink`	Type: `String` This property is observable A link to open google map with the current itinerary
`directionsRenderers`	Type: `google.maps.DirectionsRenderer[]` This property is observable An array containing renderer about each route
`directionsSummaries`	Type: `DirectionsRouteInformationsParams[]` This property is observable An array containing information about each route
`originDestination`	Type: `LatLngLiteral` This property is observable
`selectedTravelMode`	Type: `String` This property is observable

Methods
`originDestination_changed`	`originDestination_changed()` Parameters: None Triggered when originDestination attribute changed (observer)
`selectedTravelMode_changed`	`selectedTravelMode_changed()` Parameters: None Triggered when selectedTravelMode attribute changed (observer)
`cleanMapFromRoutes`	`cleanMapFromRoutes()` Parameters: None Trigger setMap and setPanel with null parameter for each renderer to remove their polyline and panel details
`getRouteEncodedPolyline`	`getRouteEncodedPolyline(rendererIndex)` Parameters: `rendererIndex`: `Number` Return Type: `string`
`getDirectionsFromOrToStore`	`getDirectionsFromOrToStore()` Parameters: None Get directions from, or to, store with google directions services and set results in directionsRenderers
`route`	`route(requestParams, successCallback, failCallback)` Parameters: `requestParams`: `Object` `successCallback`: `Function` `failCallback`: `Function` Return Type: `any`
`setDirectionsObjectsWithResponse`	`setDirectionsObjectsWithResponse(response)` Parameters: `response`: `google.maps.DirectionsResult` a google direction result which contain all path and info Set directionsRenderers and directionsSummary objects
`getDirectionsLink`	`getDirectionsLink(origin, destination, travelMode)` Parameters: `origin`: `woosmap.maps.utils.LatLng \| null` route origin `destination`: `woosmap.maps.utils.LatLng \| null` route destination `travelMode`: `string \| null` travelMode for Baidu if needed Get the direct link to google or baidu directions from the user’s input
`getAvailableTravelModes`	`getAvailableTravelModes()` Parameters: None Return Type: `any` Gets available travel modes.

DistanceProvider class

woosmap.location.DistanceProvider

This class extends MVCObject.

Constructs a new DistanceProvider. It should be bound to a location property or it needs to be set manually.

Constructor
`DistanceProvider`	`DistanceProvider(options?)` Parameters: `options`: `Object` optionals options to DistanceMatrixService DistanceMatrix Doc Constructs a new DistanceProvider. It should be bound to a location property or it needs to be set manually.

Properties
`location`	Type: `LatLngLiteral` The location to compute a distance from. This property is bindable.

Methods

Methods
`updateStoresDistanceWithGoogle`	`updateStoresDistanceWithGoogle(stores, user_callback, orderby)` Parameters: `stores`: `Store[]` the stores array to be updated `user_callback`: `Function` the callback method which will be called with the new store’s array `orderby`: `String` should be distance or duration. By default it will use distance. This method updates or adds the following properties of each `stores` in the array : `duration`: the duration in seconds. `distance`: the distance in meters. `duration_text`: a String representation of the duration. `distance_text`: A string representation of the distance value, using the `unitSystem` specified in the constructor options.


updateStoresDistanceWithGoogle

updateStoresDistanceWithGoogle(stores, user_callback, orderby)

Parameters:

stores: Store[] the stores array to be updated
user_callback: Function the callback method which will be called with the new store’s array
orderby: String should be distance or duration. By default it will use distance.

This method updates or adds the following properties of each stores in the array :

duration: the duration in seconds.
distance: the distance in meters.
duration_text: a String representation of the duration.
distance_text: A string representation of the distance value, using the unitSystem specified in the constructor options.

GeocoderSearchSource class

woosmap.location.GeocoderSearchSource

This class extends MVCObject.

GeocoderSearchSource

Constructor
`GeocoderSearchSource`	`GeocoderSearchSource(geocoderOptions?)` Parameters: `geocoderOptions`: `GeocoderOptions` options for the geocoder Constructs a new GecoderSearchSource

Properties
`location`	Type: `LatLngLiteral` When google answer a geocoding requests with only one result, it sets this property. If maxResultsReturn is set to one then google’s answer always set this property. This property is bindable
`locationResults`	Type: `Array` When google answer a geocoding requests with more than one result, it sets this property. This property is bindable
`query`	Type: `string` Observes his query to launch the geocoding.

Methods
`query_changed`	`query_changed()` Parameters: None Listens the changes of query.
`search`	`search(query)` Parameters: `query`: `String` Use the google maps geocoder to geocode the query.

LocationProvider class

woosmap.location.LocationProvider

This class extends MVCObject.

Constructs a new LocationProvider, in order to track browser location

Constructor
`LocationProvider`	`LocationProvider()` Parameters: None Constructs a new LocationProvider, in order to track browser location

Properties
`location`	Type: `LatLngLiteral` When the LocationProvider returns a result it sets this property. This property is bindable

Methods
`askForLocation`	`askForLocation(geoLocationProvider)` Parameters: `geoLocationProvider`: `GeolocationProvider \| undefined` if provider is undefined or if user refuse geolocation then ip location is used Set user location given provider.

NearbyStoresSource class

woosmap.location.NearbyStoresSource

This class extends MVCObject.

Constructor
`NearbyStoresSource`	`NearbyStoresSource(dataSource, maxStores, maxDistanceFromUser)` Parameters: `dataSource`: `DataSource` `maxStores`: `Number` maximum number of stores which will be retrieved from data source `maxDistanceFromUser`: `Number` the maximum distance from user in meters Builds a NearbyStoresSource

Properties
`location`	Type: `LatLngLiteral` The location to search stores from. This property is bindable.
`stores`	Type: `Array` An array of stores. This property is bindable.

Methods
`location_changed`	`location_changed()` Parameters: None This method is called when the location has changed.

PlacesSearchSource class

woosmap.location.PlacesSearchSource

This class extends MVCObject.

Constructs a new PlacesSearchSourceAutocompleteRequest can be biased using location, radius or bounds property through the options param

Constructor


PlacesSearchSource

PlacesSearchSource(options?, minQuerySize?, searchCallback?)

Parameters:

options: google.maps.places.AutocompletionRequest The Google Places AutocompletionRequest
minQuerySize: Number if the size of the input is smaller than minQuerySize then no request to googleMap is done (default 0)
searchCallback: null | Function Callback to execute after search if set

Constructs a new PlacesSearchSourceAutocompleteRequest can be biased using location, radius or bounds property through the options param

Properties
`autocomplete_query`	Type: `String` Observes his autocomplete_query to launch the autocomplete.
`minQuerySize`	Type: `Number` If autocomplete query change but with a length smaller than minQuerySize then no request to google map is done.
`options`	Type: `Object` Observes this property to launch configure autocomplete. should comply to google’s specifications See : AutocompletionRequest
`predictions`	Type: `Array` When Places returns a prediction list it sets this property. This property is observable
`searchCallback`	Type: `null \| Function` Callback to execute after search if needed

Methods
`autocomplete_query_changed`	`autocomplete_query_changed()` Parameters: None Listens the changes of autocomplete_query.

Data class

woosmap.maps.data.Data

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` Adds the feature passed as parameter.
`remove`	`remove(feature)` Parameters: `feature`: `Feature` Remove the feature passed as parameter.
`addGeoJson`	`addGeoJson(geojson, options?)` Parameters: `geojson`: `GeoJSON` `options`: `Object` 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`: `Function` 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`: `Function` 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: `google.maps.Map \| BMap.Map` Returns the map on which the features are displayed.
`setMap`	`setMap(map)` Parameters: `map`: `google.maps.Map \| BMap.Map` 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`: `Function \| google.maps.Icon` 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: `any` Gets the style for all features in the collection.
`overrideStyle`	`overrideStyle(feature, style)` Parameters: `feature`: `Feature` `style`: `google.maps.Icon` 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` 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.
`addListener`	`addListener(event, callback)` Parameters: `event`: `any` `callback`: `Function` Adds a listener for event
`trigger`	`trigger(event, eventData)` Parameters: `event`: `String` `eventData`: `any` Trigger event listeners.

Feature class

woosmap.maps.data.Feature

Constructor
`Feature`	`Feature(featureData)` Parameters: `featureData`: `FeatureData`

Methods
`getGeometry`	`getGeometry()` Parameters: None Return Type: `google.maps.LatLng \| BMap.Point` Returns 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` Removes property
`setProperty`	`setProperty(name, newValue)` Parameters: `name`: `String` `newValue`: `any`
`toGeoJson`	`toGeoJson(callback)` Parameters: `callback`: `Function` Exports the feature to a GeoJSON object.

LatLng class

woosmap.maps.geometry.LatLng

Constructor
`LatLng`	`LatLng(lat, lng)` Parameters: `lat`: `Number` the latitude. `lng`: `Number` the longitude.

Properties
`lat`	Type: `Number` The latitude.
`lng`	Type: `Number` The latitude.

Methods
`toJSON`	`toJSON()` Parameters: None Return Type: `LatLngLiteral`

LatLngBounds class

woosmap.maps.geometry.LatLngBounds

Constructor
`LatLngBounds`	`LatLngBounds(ne, sw)` Parameters: `ne`: `LatLng \| google.maps.LatLng \| BMap.Point` `sw`: `LatLng \| google.maps.LatLng \| BMap.Point`

Methods
`getNorthEast`	`getNorthEast()` Parameters: None Return Type: `LatLng`
`getSouthWest`	`getSouthWest()` Parameters: None Return Type: `LatLng`
`getCenter`	`getCenter()` Parameters: None Return Type: `LatLng \| null` Computes the center of the latlng bounds.
`isEmpty`	`isEmpty()` Parameters: None Return Type: `Boolean` Checks if the current bounds are empty.
`intersects`	`intersects(other)` Parameters: `other`: `LatLngBounds` Return Type: `Boolean` Checks if bounds are intersecting with other.
`union`	`union(other)` Parameters: `other`: `LatLngBounds`
`contains`	`contains(latlng)` Parameters: `latlng`: `LatLng \| LatLngLiteral` Return Type: `Boolean` Checks if current bounds contain latlng.
`extend`	`extend(point)` Parameters: `point`: `LatLng \| LatLngLiteral` Return Type: `LatLngBounds` Extends the current bounds with point.
`toJSON`	`toJSON()` Parameters: None Return Type: `google.maps.LatLngBoundsLiteral` Returns the bounds as JSON.

Point class

woosmap.maps.geometry.Point

Constructor
`Point`	`Point(x, y)` Parameters: `x`: `Number` `y`: `Number`

Properties
`x`	Type: `Number` x coordinate.
`y`	Type: `Number` y coordinate.

Size class

woosmap.maps.geometry.Size

Constructor
`Size`	`Size(width, height)` Parameters: `width`: `Number` `height`: `Number`

Properties
`height`	Type: `Number`
`width`	Type: `Number`

F class

woosmap.query.F

Function helper to instantiate a Field, used to form queries.

Constructor
`F`	`F(key, value, operator?)` Parameters: `key`: `String` `value`: `String \| Number` `operator`: `Operators` Function helper to instantiate a Field, used to form queries.

Field class

woosmap.query.Field

Represents a field filter

Constructor
`Field`	`Field(key, value, operator?)` Parameters: `key`: `String` `value`: `String \| Number` `operator`: `Operators`

Methods
`toString`	`toString()` Parameters: None Return Type: `string` Returns the field clause in query format.

Query class

woosmap.query.Query

Represents a Query

Constructor
`Query`	`Query(children, connector, negate)` Parameters: `children`: `Array<Query \| Field \| String>` `connector`: `BoolOperators` `negate`: `Boolean`

Methods
`toString`	`toString()` Parameters: None Return Type: `String` Returns the Query as a string usable for the search endpoint query parameter.

SearchParameters class

woosmap.search.SearchParameters

Constructor
`SearchParameters`	`SearchParameters(searchParametersOptions?)` Parameters: `searchParametersOptions`: `SearchParametersOptions` Constructs a new SearchParameters

Properties
`GroupByValues`	Type: `String` Allowed values for the groupBy parameter.
`bounds`	Type: `google.maps.LatLngBoundsLiteral` Bounds in which the search will be performed
`groupBy`	Type: `woosmap.search.SearchParameters.GroupByValues` Count the stores by group values
`lat`	Type: `Number` Latitude of the position to search nearest stores
`lng`	Type: `Number` Longitude of the position to search nearest stores.
`maxDistanceFromUser`	Type: `Number` Maximum distance from user (in meter).
`maxStores`	Type: `Number` Maximum number of stores to return.
`page`	Type: `Number` The expected page
`polylineFilter`	Type: `PolylineFilter` PolylineFilter to filter on polyline path
`query`	Type: `Query \| Field \| String`
`searchQuery`	Type: `SearchQuery` Query to filter on store’s properties (text, types and tags).
`storesByPage`	Type: `Number` Number of store in one page (default: 100, max: 300)
`zone`	Type: `Boolean` Whether the search should perform an intersection between point and zones.

Methods
`buildUrl`	`buildUrl()` Parameters: None Return Type: `String` Build encoded parameters of an url to search stores (&max_number=3).

SearchQuery class

woosmap.search.SearchQuery

This class extends MVCObject.

Constructor
`SearchQuery`	`SearchQuery(querySearchOptions)` Parameters: `querySearchOptions`: `QuerySearchOptions` Constructs a new SearchQuery

Properties
`AND`	Type: `string` AND query operator
`OR`	Type: `string` OR query operator
`query`	Type: `TextSearchQuery` Property for text search
`tags`	Type: `String[]` Property for tag search
`types`	Type: `String[]` Property for type search

Methods
`addTagFilter`	`addTagFilter(tagName, operator)` Parameters: `tagName`: `String` the tag name `operator`: `Boolean` the boolean operator to use in the query. Adds a tag filter to the query.
`addTypeFilter`	`addTypeFilter(typeName, operator)` Parameters: `typeName`: `String` the type name `operator`: `Boolean` the boolean operator to use in the query. Adds a type filter to the query.
`setQuery`	`setQuery(queryText, options?)` Parameters: `queryText`: `String` the query text `options`: `Object` Sets the query text
`addQueryOption`	`addQueryOption(name, operator)` Parameters: `name`: `String` the option to add `operator`: `Boolean` the boolean operator to use in the query. Adds a query option
`removeQueryOption`	`removeQueryOption(name)` Parameters: `name`: `String` Removes a QueryOption by name.

Styler class

woosmap.style.Styler

Styler duty is to style google maps Data Layer

Constructor
`Styler`	`Styler(options)` Parameters: `options`: `DataStyle`

Methods
`getStyle`	`getStyle()` Parameters: None Return Type: `Style` Returns the the current style.
`getDefaultStyle`	`getDefaultStyle()` Parameters: None Return Type: `StyleRule` Returns the default style.
`getMarkerStyleForStore`	`getMarkerStyleForStore(store, options)` Parameters: `store`: `google.maps.Data.Feature \| Store` `options`: `MarkerStyleOptions` Return Type: `google.maps.Icon` Resolves style for the store feature using options.

DirectionsResultsDisplayer class

woosmap.ui.DirectionsResultsDisplayer

This class extends MVCObject.

You must bind directionsLink property to directionsProvider if you want to handle the click button on an object with the CSS class woosmap-mobile-link-button to redirect mobile user on Gmaps app.

Constructor


DirectionsResultsDisplayer

DirectionsResultsDisplayer(map, summaryTemplate, displayNewRenderersCallback, selectedAndUnselectedRendererOptions)

Parameters:

map: google.maps.Map the google map which will display route polyline
summaryTemplate: String html template for the route summary
displayNewRenderersCallback: Function callback calling after all renderers are set
selectedAndUnselectedRendererOptions: SelectedAndUnselectedRendererOptions options for both selected an unselected renderers.

You must bind directionsLink property to directionsProvider if you want to handle the click button on an object with the CSS class woosmap-mobile-link-button to redirect mobile user on Gmaps app.

Methods
`displayRouteSteps`	`displayRouteSteps(rendererIndex)` Parameters: `rendererIndex`: `Number` the index of the renderer which contain direction to display Display route’s steps on panel
`cleanRoutes`	`cleanRoutes()` Parameters: None Clean all routes on panel
`cleanRouteSteps`	`cleanRouteSteps()` Parameters: None Clean all route’s step on panel
`cleanMapFromRoutes`	`cleanMapFromRoutes()` Parameters: None Hide all route’s Polyline on map
`displayAllRoutes`	`displayAllRoutes()` Parameters: None Display all the route on the map
`displayRouteOnMap`	`displayRouteOnMap(rendererIndex)` Parameters: `rendererIndex`: `Number` the index of the renderer which contain the route to display Display a selected route polyline on map
`setSelectedRenderer`	`setSelectedRenderer(rendererIndex)` Parameters: `rendererIndex`: `Number` the index of the renderer to set options. Set renderer options to `selectedRendererOptions` and set others renderers options to `unselectedRenderersOptions`

InfoBox class

woosmap.ui.InfoBox

Creates an InfoBox with the options specified in InfoBoxOptions. Call InfoBox.open to add the box to the map.

Constructor
`InfoBox`	`InfoBox(opt_opts?)` Parameters: `opt_opts`: `InfoBoxOptions` Creates an InfoBox with the options specified in InfoBoxOptions. Call InfoBox.open to add the box to the map.

Methods
`onRemove`	`onRemove()` Parameters: None Invoked when close is called. Do not call it directly.
`draw`	`draw()` Parameters: None Draws the InfoBox based on the current map projection and zoom level.
`setInfoBoxOptions`	`setInfoBoxOptions(opt_opts)` Parameters: `opt_opts`: `InfoBoxOptions` Sets the options for the InfoBox. Note that changes to the maxWidth, closeBoxMargin, closeBoxURL, and enableEventPropagation properties have no affect until the current InfoBox is closed and a new one is opened.
`setContent`	`setContent(content)` Parameters: `content`: `string \| Node` Sets the content of the InfoBox. The content can be plain text or an HTML DOM node.
`setPosition`	`setPosition(latlng)` Parameters: `latlng`: `LatLng` Sets the geographic location of the InfoBox.
`setZIndex`	`setZIndex(index)` Parameters: `index`: `number` Sets the zIndex style for the InfoBox.
`setVisible`	`setVisible(isVisible)` Parameters: `isVisible`: `boolean` Sets the visibility of the InfoBox.
`getContent`	`getContent()` Parameters: None Return Type: `string` Returns the content of the InfoBox.
`getPosition`	`getPosition()` Parameters: None Return Type: `LatLng` Returns the geographic location of the InfoBox.
`getZIndex`	`getZIndex()` Parameters: None Return Type: `number` Returns the zIndex for the InfoBox.
`getVisible`	`getVisible()` Parameters: None Return Type: `boolean` Returns a flag indicating whether the InfoBox is visible.
`show`	`show()` Parameters: None Shows the InfoBox. [Deprecated; use setVisible instead.]
`hide`	`hide()` Parameters: None Hides the InfoBox. [Deprecated; use setVisible instead.]
`open`	`open(map, anchor?)` Parameters: `map`: `Map \| StreetViewPanorama` `anchor`: `MVCObject` Adds the InfoBox to the specified map or Street View panorama. If anchor (usually a google.maps.Marker) is specified, the position of the InfoBox is set to the position of the anchor. If the anchor is dragged to a new location, the InfoBox moves as well.
`close`	`close()` Parameters: None Removes the InfoBox from the map.

Events
`domready`	This event is fired when the DIV containing the InfoBox’s content is attached to the DOM.
`closeclick`	This event is fired when the InfoBox’s close box is clicked.
`content_changed`	This event is fired when the content of the InfoBox changes.
`position_changed`	This event is fired when the position of the InfoBox changes.
`zindex_changed`	This event is fired when the zIndex of the InfoBox changes.

MailView class

woosmap.ui.MailView

This class extends woosmap.utils.DelegateProtocol.

Constructs a new MailView, in order to ask our API endpoint to send a mail for directions

Template example

        <div>
     <input type="text" placeholder="email" class="woosmap-mail-input"/>
     <button class="woosmap-send-button">Send mail</button>
</div>

Delegates

mailSending called when mail is in sending state.
mailError called when mail is in error state.
mailSent called when mail is in sent state.

Constructor


MailView

MailView(template, custom_params)

Parameters:

template: String The template used to render mail form. It should contain at least two inputs the text input with the class woosmap-mail-input and the send button with woosmap-send-button class
custom_params: Object The custom params to pass in return url.

Constructs a new MailView, in order to ask our API endpoint to send a mail for directions

Properties
`mailStatus`	Type: `mailStatus` When the MailView returns a result it sets this property. This property is bindable
`selectedStore`	Type: `String` When the MailView sends an email with directions, it needs to have the currently selected store set in in order to send the proper directions. This property is bindable
`status`	Type: `Object` Contains all the available status for the MailView. Status states `Sent`, `Sending`, `Initialized`, and `Error`

Methods
`sendDirectionsMail`	`sendDirectionsMail(receiver_mail)` Parameters: `receiver_mail`: `String` The mail to send the mail to. Sends a request to the datastore to send a mail with directions link to the mail provided
`getContainer`	`getContainer()` Parameters: None Return Type: `any`

OriginDestinationInput class

woosmap.ui.OriginDestinationInput

This class extends MVCObject.

Take the template for an Origin Destination Panel and link with an originDestination object

Constructor
`OriginDestinationInput`	`OriginDestinationInput(originDestinationPanelTemplate, odInputOptions?)` Parameters: `originDestinationPanelTemplate`: `String` template of the origin destination panel `odInputOptions`: `OdInputOptions` Take the template for an Origin Destination Panel and link with an originDestination object

Properties
`location`	Type: `LatLngLiteral` The location to use to compute the directions.
`originDestination`	Type: `OriginDestination`
`selectedStore`	Type: `Store` The selected store. This property is bindable.
`storeIsDestination`	Type: `boolean` Flag to decide where to put the store name.

Methods
`isSelectedStoreName`	`isSelectedStoreName(name)` Parameters: `name`: `String` the name which will be compared to selectedStore.name Return true if the selectedStore has a name equal to the name in parameters
`updateOriginDestination`	`updateOriginDestination()` Parameters: None Set the originDestination object {origin: , destination: } with value containing in woosmap-origin and woosmap-destination input If one name is the same that selectedStore’s name then store position is set instead of the name
`setOriginValue`	`setOriginValue(newOriginValue)` Parameters: `newOriginValue`: `String` the value to set Set the value of woosmap-origin input
`setDestinationValue`	`setDestinationValue(newDestinationValue)` Parameters: `newDestinationValue`: `String` the value to set Set the value of woosmap-destination input
`getOriginValue`	`getOriginValue(useLatLng?)` Parameters: `useLatLng`: `boolean` if param is set to true and the selectedStore is the origin store then return lat,lng instead of input value Get the value of woosmap-origin input return selectedStore position is value is the same tha store name
`getDestinationValue`	`getDestinationValue(useLatLng?)` Parameters: `useLatLng`: `boolean` if param is set to true and the selectedStore is the destination store then return lat,lng instead of input value Get the value of woosmap-destination input return selectedStore position is value is the same tha store name
`onKeyUp`	`onKeyUp(event)` Parameters: `event`: `Event` Method called when keyUp on origin or destination input
`selectedStore_changed`	`selectedStore_changed()` Parameters: None Method called when selectedStore changed
`location_changed`	`location_changed()` Parameters: None Method called when location changed
`getODContainer`	`getODContainer()` Parameters: None Return the container instantiated with origin-destination panel

SearchView class

woosmap.ui.SearchView

This class extends woosmap.utils.DelegateProtocol.

Constructs a SearchView

didSearchClear is called when the search query is validated.

Constructor
`SearchView`	`SearchView(searchViewOptions?)` Parameters: `searchViewOptions`: `SearchViewOptions` options for the searchView Constructs a SearchView `didSearchClear` is called when the search query is validated.

Methods
`setupInteraction`	`setupInteraction()` Parameters: None Setups the interactions with the input, button, and clear button
`setSearchQueryWithInputValue`	`setSearchQueryWithInputValue(property)` Parameters: `property`: `String` Sets the query property with the value of the input.
`clearResults`	`clearResults()` Parameters: None Method called when searchView need to clear its results.
`clearInput`	`clearInput()` Parameters: None Method called when searchView need to clear its input.
`getContainer`	`getContainer()` Parameters: None Return Type: `any`
`locationResults_changed`	`locationResults_changed()` Parameters: None Method called when locationResults changed.When changed is trigger searchView will display location results into resultSelector container.
`getResultsSelector`	`getResultsSelector()` Parameters: None Return Type: `any` Return resultsSelector container.

TableView class

woosmap.ui.TableView

This class extends MVCObject.

Constructs a new TableView

TableView container

        <div class="woosmap-tableview-container"></div>

TableView Store Cell template example

        <div>{{name}}</div>
<a class="title">{{name}}</a><br/>
<small class="quiet">{{address.city}}</small>
<div>{{address.lines}} {{address.city}} {{address.zip}}</div>
<div>Tel : <a href="tel:{{phone}}">{{phone}}</a></div>

TableView Places Cell template example

        <div>{{description}}</div>

If a card is selected its container will bear woosmap-tableview-selected-cell class. If a card is highlighted using arrow keys, its container will bear woosmap-tableview-highlighted-cell class.

Constructor
`TableView`	`TableView(templates, placesSearchSource?)` Parameters: `templates`: `Object` should contain two templates accessible through keys “cell_store” and “cell_place”. Store’s template can also use deprecated key “cell” `placesSearchSource`: `PlacesSearchSource` the placesSearchSource instance to use for getDetails. Constructs a new TableView

Properties
`details`	Type: `Object` When user selects a places prediction it sets this property with places details This property is observable
`location`	Type: `Object` When user click on a Places cell, it sets this property This property is observable
`predictions`	Type: `Array` An array of Places predictions. This property is bindable.
`selectedStore`	Type: `Object` When user click on a Store cell, it sets this property This property is observable
`stores`	Type: `Array` An array of stores. This property is bindable.

Methods
`setupInteraction`	`setupInteraction()` Parameters: None Setups the interactions with the keyboard
`selectedStore_changed`	`selectedStore_changed()` Parameters: None When the selectedStore changes select the right cell in the table view. If the table view cell is not visible then scroll the list to render it visible.
`scrollToCell`	`scrollToCell($cell)` Parameters: `$cell`: `jQuery` Scrolls the table view to show the `$cell`
`stores_changed`	`stores_changed()` Parameters: None When the stores list changes update the table view accordingly.
`predictions_changed`	`predictions_changed()` Parameters: None When the predictions list changes update the table view accordingly.
`getContainer`	`getContainer()` Parameters: None Return Type: `any` Returns the container of the TableView.
`update`	`update()` Parameters: None Displays the `stores` by rendering a cell for each store.
`setStoresTemplate`	`setStoresTemplate(storesTemplate)` Parameters: `storesTemplate`: `string` new templates for stores cells. Set new template for stores cells.
`setPlacesTemplate`	`setPlacesTemplate(placesTemplate)` Parameters: `placesTemplate`: `string` new templates for places cells. Set new template for places cells.
`setOnCellCreatedCallback`	`setOnCellCreatedCallback(callback)` Parameters: `callback`: `function` function call by the tableView. Params of the callback are `store_container` a jquery object which contain cell’s html and `storeData` a json containing the data of the store. Set a function to be called by the tableView after the rendering of the cells.

TravelModeSelector class

woosmap.ui.TravelModeSelector

This class extends MVCObject.

Take the template of travelModePanel to generate an object

Constructor
`TravelModeSelector`	`TravelModeSelector(travelModeSelectionPanelTemplate)` Parameters: `travelModeSelectionPanelTemplate`: `string` template of the travel mode pane Take the template of travelModePanel to generate an object

Methods
`initializedTravelModeChoice`	`initializedTravelModeChoice()` Parameters: None Initialized comportement of travel mode panel’s objects
`getSelectorContainer`	`getSelectorContainer()` Parameters: None Return the container instantiated with travel mode panel

DelegateProtocol class

woosmap.utils.DelegateProtocol

This class extends MVCObject.

Constructor
`DelegateProtocol`	`DelegateProtocol()` Parameters: None Constructs a new DelegateProtocol

Properties
`delegate`	Type: `Object` The delegate object.

Methods
`callDelegateMethod`	`callDelegateMethod(methodName)` Parameters: `methodName`: `String` the method to call. Return Type: `DelegateReturn` Calls the method `methodName` on the delegate.

DelegateReturn class

woosmap.utils.DelegateReturn

This class extends MVCObject.

Constructor
`DelegateReturn`	`DelegateReturn()` Parameters: None Builds a delegate return value.

Methods
`or`	`or(defaultValue)` Parameters: `defaultValue`: `any` Return Type: `any` Returns `defaultValue` when the delegate was not called. Else return the delegate return value.

MVCObject class

woosmap.utils.MVCObject

Constructor for MVCObject.

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

Methods
`bindTo`	`bindTo(key, target, target_key?, notify?)` Parameters: `key`: `string` the property to be bound `target`: `object` the object to bind to `target_key`: `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, force_callback?)` Parameters: `key`: `string` the name of the property to set `value`: `mixed` the new value of the property identified by ‘key’ `force_callback`: `boolean` optional call callbacks, regardless of whether the value has changed or not. Return Type: `void` Sets ‘value’ to ‘key’ on ‘this’.
`setValues`	`setValues(key_value_pairs)` Parameters: `key_value_pairs`: `object` an object containing ‘key’ => ‘value’ of properties to change Return Type: `void` Set all the values of the properties contained in ‘key_value_pairs’
`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

Address Interface

Address

Properties
`city`	Type: `String`
`lines`	Type: `String[]` the address lines.
`zipCode`	Type: `String`

BaiduDirectionsRouteParams Interface

BaiduDistance Interface

Properties
`text`	Type: `string` A string representation of the distance value.
`value`	Type: `number` The distance in meters.

BaiduDuration Interface

Properties
`text`	Type: `string` A string representation of the duration value.
`value`	Type: `number` The duration in seconds.

BaiduMapsOptions Interface

Type: object

Properties
`mapStyle`	Type: `BMap.MapStyle` Baidu Map Style

BaiduPolylineOptions Interface

BaiduPolylineOptions

Properties
`map?`	Type: `BMap.Map` Map on which to display Polyline.
`path?`	Type: `BMap.Point[]` The ordered sequence of coordinates of the Polyline
`strokeColor`	Type: `string`
`strokeOpacity`	Type: `number \| string`
`strokeStyle`	Type: `string`
`strokeWeight`	Type: `number`

BaseViewOptions Interface

Properties
`style?`	Type: `Style`
`zoomLevel?`	Type: `Number`

BoundsPadding Interface

BoundsPadding All properties values are expected to be in pixels.

Properties
`bottom?`	Type: `Number`
`left?`	Type: `Number`
`right?`	Type: `Number`
`top?`	Type: `Number`

Contact Interface

Contact

Properties
`email`	Type: `String` the location email contact.
`phone`	Type: `String` the location phone.
`website`	Type: `String` the location website.

DataLayerOptions Interface

Properties
`click`	Type: `StoreEventCallback`
`styler`	Type: `Styler`

DataStyle Interface

Properties
`markers?`	Type: `DeprecatedStyleRule[]` deprecated marker style format used in BaseView.
`style?`	Type: `Style`

DeprecatedStyleRule Interface

Properties
`default`	Type: `String` base url for the marker icon.
`selected`	Type: `String` base url for the marker icon in its selected state.
`type`	Type: `String` the type for which the rules applies. Use `default` to define the default style.

DirectionsRouteInformationsParams Interface

Properties
`distance`	Type: `number` distance
`durationInTrafficLong`	Type: `String` durationInTrafficLong
`durationInTrafficShort`	Type: `number` durationInTrafficShort
`durationLong`	Type: `String` durationLong
`durationShort`	Type: `number` durationShort
`rendererIndex`	Type: `number` rendererIndex
`summary`	Type: `String` summary
`travelMode`	Type: `String` travelMode

EventListeners Interface

Properties
`click?`	Type: `StoreEventCallback` event handler function for `click` google maps event.
`mousedown?`	Type: `StoreEventCallback` event handler function for `mousedown` google maps event.
`mouseout?`	Type: `StoreEventCallback` event handler function for `mouseout` google maps event.
`mouseover?`	Type: `StoreEventCallback` event handler function for `mouseover` google maps event.
`mouseup?`	Type: `StoreEventCallback` event handler function for `mouseup` google maps event.

EventName Interface

Type: String

EventName EventName should be one of the following: click, mousedown, mouseout, mouseover, mouseup.

FeatureData Interface

FeatureData

Properties
`geometry`	Type: `LatLngLiteral`
`id`	Type: `String \| Number`
`properties`	Type: `Object`

GeoJSON Interface

GeoJSON

Properties
`features`	Type: `Store[]`

GeocoderOptions Interface

Properties
`errorCallback?`	Type: `GoogleGeocoderErrorCallback` The function to call when a geocoder error occurs. Google Maps only
`maxResultsReturn?`	Type: `Number` Maximum number of geocoding results return by the geocoder. If google find more result then only the N first results will be returned.

Geometry Interface

Geometry

Properties
`coordinates`	Type: `Number[]` WGS84 longitude, latitude.

GoogleGeocoderErrorCallback Interface

Type: Function

The function to call when a google geocoder error occurs.

Function
`GoogleGeocoderErrorCallback`	`GoogleGeocoderErrorCallback(status)` Parameters: `status`: `google.maps.GeocoderStatus` the error status from the google geocoder. The function to call when a google geocoder error occurs.

JSONPOptions Interface

Properties
`prefix`	Type: `String` callback prefix (defaults to `__jp`)
`qs`	Type: `String` parameter (defaults to `callback`)
`timeout`	Type: `Number` how long after the request until a timeout error is emitted (defaults to `15000`)

LatLngLiteral Interface

Location

Properties
`lat`	Type: `Number` the latitude.
`lng`	Type: `Number` the longitude.

LoadOptions Interface

Properties
`callback`	Type: `Function`
`loadJQuery`	Type: `Boolean`
`publicKey`	Type: `String`
`scope`	Type: `Object`
`version`	Type: `String`

MapsLoaderOptions Interface

MapsLoaderOptions example

        var mapsOptions = {
   clientId: "a_client_id",
   librariesToLoad: ["places"],
   channelId: "a_channel_id",
   language: "fr",
   region: "FR"
   version: "3.26"
}

Properties
`channelId?`	Type: `String` is a string to track usage across different applications using the same client ID
`clientId?`	Type: `string` the google client id.
`key?`	Type: `String` a google maps api key.
`language?`	Type: `String` desired for google maps api
`librariesToLoad?`	Type: `Array` a list of String containing additional google libraries to load.
`region?`	Type: `String` desired for google maps api
`version?`	Type: `String` desired for google maps api

MarkerStyleOptions Interface

NearbyOptions Interface

Properties
`maxDistanceFromUser`	Type: `Number` the maximum distance allowed between the user and a store.
`maxStores`	Type: `Number` the maximum number of stores to return

OdInputOptions Interface

Properties
`geolocText?`	Type: `String` Text to display in input field after geolocation

OriginDestination Interface

Properties
`destination`	Type: `String`
`origin`	Type: `String`

PolylineFilter Interface

Properties
`encodedPolyline`	Type: `String` a polyline encoded to the google format
`radius?`	Type: `Number` max distance to retrieve store from the polyline (in meter). Default value is 10000

RendererOptions Interface

Properties
`click?`	Type: `StoreEventListener` The click callback.
`eventListeners`	Type: `EventListeners`
`styler`	Type: `Styler`

SearchParametersOptions Interface

Properties
`bounds?`	Type: `google.maps.LatLngBounds \| google.maps.LatLngBoundsLiteral` Bounds in which the search will be performed
`groupBy?`	Type: `woosmap.search.SearchParameters.GroupByValues` Aggregate stores by type or tag. Only available when using DataSource.countStoresByParameters method
`lat?`	Type: `Number` latitude of the position to search nearest stores.
`lng?`	Type: `Number` longitude of the position to search nearest stores.
`maxDistanceFromUser?`	Type: `Number` maximum distance from user (in meter).
`maxStores?`	Type: `Number` maximum number of stores to return (deprecated use pagination instead).
`page?`	Type: `Number` the request page
`polylineFilter?`	Type: `PolylineFilter` to filter on polyline path.
`query?`	Type: `Query \| Field \| String` search query that replaces the searchTextOptions.
`searchTextOptions?`	Type: `QuerySearchOptions` options to filter on store’s text properties.
`storesByPage?`	Type: `Number` the number of store by page (default:100, max:300)
`zone?`	Type: `Boolean` whether the search should perform an intersection between point and zones.

SelectedAndUnselectedRendererOptions Interface

Properties
`selectedRendererOptions`	Type: `google.maps.DirectionsRendererOptions` options for selected renderer.
`unselectedRenderersOptions`	Type: `google.maps.DirectionsRendererOptions` options for unselected renderers.

Store Interface

Store

Properties
`address?`	Type: `Address` the Store address
`contact?`	Type: `Contact` the contact information.
`geometry`	Type: `Geometry` The geometry associated to this store
`name`	Type: `String` the store name.
`storeId`	Type: `String` the unique Id for this store.
`tags?`	Type: `String[]` the store tags.
`types?`	Type: `String[]` the store types.
`user_properties?`	Type: `Object` user definied properties

StoreEventCallback Interface

Type: Function

The marker parameter is only valued when the event is generated from a MarkersRenderer.

Function
`StoreEventCallback`	`StoreEventCallback(store, marker?)` Parameters: `store`: `Store` the store data that generated the event. `marker`: `google.maps.Marker` the marker object associated, valued only when using The marker parameter is only valued when the event is generated from a MarkersRenderer.

Style Interface

Style Example

        {
    rules: [
        {
            type: 'value1',
            icon: {url: 'http://url/img/marker1.png'},
            selectedIcon: {url: 'http://url/img/marker1-selected.png'}
        },
        {
            type: 'value2',
            icon: {url: 'http://url/img/marker2.png'},
            selectedIcon: {url: 'http://url/img/marker2-selected.png'}
        }
    ],
    default: {
        icon: {url: 'http://url/img/marker.png'},
        numberedIcon: {url: 'http://url/img/{number}.png'},
        selectedIcon: {url: 'http://url/img/selected.png'}
    }
}

Properties
`default`	Type: `StyleRule` the default styling rules, applies when no typed rule matched.
`rules`	Type: `StyleRule[]` the typed rules, each rule bears a `store type`, the last one matching prevails.

StyleRule Interface

Properties
`icon`	Type: `google.maps.Icon`
`numberedIcon`	Type: `google.maps.Icon`
`selectedIcon`	Type: `google.maps.Icon`
`type?`	Type: `String` a `store` type that controls the rule application.

TileStyle Interface

TileStyle Object specifications.

Properties
`color?`	Type: `String` a color rgba formatted
`minSize?`	Type: `Number` the minimum size acceptable for the marker.
`size?`	Type: `Number` the size of the marker in pixels, between 1 and 16.
`typeRules?`	Type: `TypesRules[]` rules to display different color depending of types. Two different rules cannot be applied to the same store. In case of conflict the latest type in the array win. If a store has no rule, the default type is apply.
`updatedAt`	Type: `Number` the timestamp at which the data was updated.

TiledImageLayerOptions Interface

TiledImageLayerOptions

Properties
`map?`	Type: `google.maps.Map` the map where the layer will be displayed.
`maxZoom?`	Type: `Number` the layer will be visible between 0 and `maxZoom`.
`searchParameters`	Type: `SearchParameters`
`style?`	Type: `TileStyle` object that contains style parameters for the current layer.

TiledOverlayOptions Interface

Properties
`minZoom?`	Type: `Number`
`polylineFilter?`	Type: `PolylineFilter` Deprecated - use `searchParameters`
`searchParameters?`	Type: `SearchParameters`
`searchQuery?`	Type: `SearchQuery` Deprecated - use `searchParameters`

TiledViewOptions Interface

TiledViewOptions

Properties
`breakPoint?`	Type: `Number` the zoom level to change the representation.
`gentleCenter?`	Type: `Boolean` when gentleCenter is true the view will center on the selectedStore only if it’s not already in the padded zone.
`interactionRenderer?`	Type: `DefaultRenderer` the renderer used to display search results.
`paddedStoreCenter?`	Type: `Boolean` sets the paddedStoreCenter
`polylineFilter?`	Type: `PolylineFilter` a polylineFilter to filter stores.
`searchParameters?`	Type: `SearchParameters`
`searchQuery?`	Type: `SearchQuery` Deprecated - use `searchParameters`. a searchQuery to filter stores.
`style?`	Type: `Style` the style for the tiled vector layer.
`tileStyle?`	Type: `TileStyle` the style for the tiled image layer.
`tiledDataRenderer?`	Type: `DefaultRenderer` the renderer used to display vector tiles.

TrafficLayerOptions Interface

Properties
`autoRefresh?`	Type: `boolean` Whether the traffic layer refreshes with updated information automatically. This is true by default.
`map?`	Type: `BMap.Map \| google.maps.Map` Map on chich to display the traffic layer.

TypesRules Interface

TypesRules Object specifications.

Properties
`color`	Type: `String` a color rgba formatted
`type`	Type: `String` of a store
`zIndex?`	Type: `Number` the zIndex priority of the points

createMapOptions Interface

Properties
`center?`	Type: `LatLng` Zoom center.
`enableScrollWheelZoom?`	Type: `boolean` Enable scroll wheel zoom with Baidu.
`zoom?`	Type: `Number` If set and positive, set zoom level.

QuerySearchOptions Interface

Example value

        var querySearchOptions = {
  'query': {
    'value': 'string to search',
    'options': {
      'name': SearchQuery.OR,
      'city': SearchQuery.AND
    }
  },
  'tags': [{
    'value': 'a tag name',
    'operator': SearchQuery.OR
  }],
  'types': [{
    'value': 'a type name', 'operator': SearchQuery.AND
  }]
}

Properties
`query?`	Type: `TextSearchQuery` search string and its options.
`tags?`	Type: `String[]` a list of tags object
`types?`	Type: `String[]` a list of types object

TextSearchQuery Interface

Example value

        var textSearchQuery = {
  'value': 'string to search',
  'options': {
    'name': SearchQuery.OR,
    'city': SearchQuery.AND
  }
}

Properties
`options?`	Type: `Object` keys are the attributes of the store where the search will be performed, attached value are operator that will be used. Attributes can be `name`, `city`, and `idstore`. Operators can be `SearchQuery.AND`, and `SearchQuery.OR`
`value?`	Type: `String` the text to be searched.

InfoBoxOptions Interface

This object represents the optional parameter passed to the InfoBox constructor.

Properties
`alignBottom`	Type: `boolean` Align the bottom left corner of the InfoBox to the position location (default is false which means that the top left corner of the InfoBox is aligned).
`boxClass?`	Type: `string` The name of the CSS class defining the styles for the InfoBox container.
`boxStyle?`	Type: `Object` An object literal whose properties define specific CSS style values to be applied to the InfoBox. Style values defined here override those that may be defined in the boxClass style sheet. If this property is changed after the InfoBox has been created, all previously set styles (except those defined in the style sheet) are removed from the InfoBox before the new style values are applied.
`closeBoxMargin`	Type: `string` The CSS margin style value for the close box. The default is “2px” (a 2-pixel margin on all sides).
`closeBoxURL`	Type: `string` The URL of the image representing the close box. Note: The default is the URL for Google’s standard close box. Set this property to “” if no close box is required.
`content`	Type: `string \| Node` The content of the InfoBox (plain text or an HTML DOM node).
`disableAutoPan?`	Type: `boolean` Disable auto-pan on open.
`enableEventPropagation`	Type: `boolean` Propagate mousedown, mousemove, mouseover, mouseout, mouseup, click, dblclick, touchstart, touchend, touchmove, and contextmenu events in the InfoBox (default is false to mimic the behavior of a google.maps.InfoWindow). Set this property to true if the InfoBox is being used as a map label.
`infoBoxClearance`	Type: `Size` Minimum offset (in pixels) from the InfoBox to the map edge after an auto-pan.
`isHidden?`	Type: `boolean` Hide the InfoBox on open. [Deprecated in favor of the visible property.]
`maxWidth`	Type: `number` The maximum width (in pixels) of the InfoBox. Set to 0 if no maximum.
`pane`	Type: `string` The pane where the InfoBox is to appear (default is “floatPane”). Set the pane to “mapPane” if the InfoBox is being used as a map label. Valid pane names are the property names for the google.maps.MapPanes object.
`pixelOffset`	Type: `Size` The offset (in pixels) from the top left corner of the InfoBox (or the bottom left corner if the alignBottom property is true) to the map pixel corresponding to position.
`position`	Type: `LatLng` The geographic location at which to display the InfoBox.
`visible?`	Type: `boolean` Show the InfoBox on open.
`zIndex`	Type: `number` The CSS z-index style value for the InfoBox. Note: This value overrides a zIndex setting specified in the boxStyle property.

SearchViewOptions Interface

Template sample

        <div>
     <input class="woosmap-search-input"/>
     <span class="woosmap-search-clear">✕</span>
     <span class="woosmap-my-location-button">My location</span>
     <button class="woosmap-search-button">Search</button>
<div>

CSS classes purpose

woosmap-search-input The input used to fill the search query
woosmap-search-clear The element used to clear the search input
woosmap-search-button The element used to trigger the search on click.
woosmap-my-location-button The element used to trigger geolocation based search

Additionaly the search is triggered when the search input is validated (ie: Enter key is pressed).

Location template sample

        <div>
     {{formattedAddress}}
</div>

Properties
`geolocText?`	Type: `string` text to display on input field after a geolocation
`resultsTemplate?`	Type: `string` location results template.
`template?`	Type: `string` Search input template.

ControlPosition Enum

Allowed values for control position.

Constants
`BOTTOM_LEFT`	Position control to the very bottom left of the map (alongside google watermark).
`BOTTOM_RIGHT`	Position control to the very bottom right of the map (alongside google watermark).
`LEFT_BOTTOM`	Position control to the bottom left of the map.
`RIGHT_BOTTOM`	Position control to the bottom right of the map.
`TOP_LEFT`	Position control to the top left of the map.
`TOP_RIGHT`	Position control to the top right of the map.

BoolOperators Enum

Represents Query Boolean operators.

Constants
`AND`	And boolean operator
`NOT`	Not boolean operator
`OR`	Or boolean operator

Operators Enum

Represents Query operators.

Constants
`gt`	Greater-than operator
`gte`	Greater-than or equal-to operator
`lt`	Less-than-or-equal-to operator
`lte`	Less-than-or-equal-to operator