Javascript API

Release notes

A log of core changes affecting API usage.

The Woosmap product team regularly updates the API with new features, bug fixes, and performance improvements. You can indicate which version of the API to load within your application by specifying it in the Woosmap Locator API bootstrap request. Read more about versioning. This changelog lists releases by date and version number, along with associated changes.

1.3.1

Available as March 24, 2017

Summary

Fixes
  • Fixes ReferenceError: event is not defined exception, that was problematic on Firefox. (reported by @pierrewgs)

1.3.0

Available as March 14, 2017

No changes from the last experimental.

1.3.exp

Available as March 13, 2017

Summary

Features
  • Adds addListener & removeListener methods to woosmap.BaseView. This allows registering events for the event view independently of the event source (TiledImageLayer, DefaultRenderer, MarkersRenderer or a custom renderer).

1.3.exp

Available as March 1, 2017

Summary

Features
  • Adds support for region parameter in MapsLoaderOptions
  • Adds support for version parameter in MapsLoaderOptions
  • Adds bounds and count support towoosmap.DataSource

1.3.exp

Available as November 2, 2016

Summary

Features
  • markers parameter in woosmap.View constructor may also be a BaseViewOptions object.
Deprecation notice
woosmap.View constructor

View(map:google.maps.Map, markersOrOptions?:String|Array.<DeprecatedStyleRule>|BaseViewOptions, zoomLevel?:Number)

  • markersOrOptions: String|Array.<DeprecatedStyleRule> is deprecated.
  • zoomLevel is deprecated, because it’s included in BaseViewOptions.

1.3.exp

Available as September 30, 2016

Summary

Features
  • Adds eventListeners option to renderers constructor allows registering handlers for named events on markers.
var renderer = new woosmap.layers.renderers.DefaultRenderer({
    styler: new woosmap.style.Styler(),
    eventListeners: {
        'mouseover': function(store) {
            console.log('over ' + store.properties.store_id);
        },
        'mouseout': function(store) {
            console.log('out ' + store.properties.store_id);
        }
    }
});

Works with MarkersRenderer.

  • Adds woosmap.query namespace to handle new style queries. (more information here)
  • Adds woosmap.search.SearchParameters query property that allows passing raw string queries.
    var q = woosmap.query;

    console.log(q.and([q.or([q.F('tag', 'tag1'), q.F('tag', 'tag2')]), q.F('type', 'awesome type')]));
    // should return
    // ((tag:"tag1" OR tag:"tag2") AND type:"awesome type")
Deprecation notice
Deprecated objects
  • woosmap.search.SearchQuery
woosmap.TiledView
  • setSearchQuery(searchQuery:SearchQuery)
  • setPolylineFilter(polylineFilter:PolylineFilter) are replaced by setSearchParameters(searchParameters)

  • searchQuery & polylineFilter from TiledViewOptions, superseded by searchParameters
woosmap.layers.TiledDataOverlay
  • setSearchQuery(searchQuery:SearchQuery)
  • setPolylineFilter(polylineFilter:PolylineFilter)

are replaced by setSearchParameters(searchParameters)

  • searchQuery & polylineFilter from TiledOverlayOptions, superseded by searchParameters
woosmap.layers.renderers.DefaultRenderer
  • setClick(callback:Function)

superseded by addEventListener(event:String, listener:Function)`

woosmap.layers.TiledImageLayer deprecated methods
  • setSearchQuery(searchQuery:SearchQuery)
  • setPolylineFilter(polylineFilter:PolylineFilter)

are replaced by setSearchParameters(searchParameters)

woosmap.search.SearchParameters
  • searchQuery property, you should use query property instead.
  • SearchParametersOptions searchTextOptions should use query option.
Deprecated before 1.3 cycle

The following methods or options were deprecated before 1.3 but due to the lack of public information about their future removal this will be postponed to the 1.4 cycle.

In any case you should avoid using deprecated methods/options.

woosmap.DataSource
  • getStoresBySearchQuery(query:String, callback:Function)
  • searchStores(searchQuery:SearchQuery, callback:Function)
  • searchNearbyStores(searchQuery:SearchQuery, lat:Number, lng:Number, callback:Function, maxStores:Number, maxDistanceFromUser:Number)

are superseded by searchStoresByParameters(searchParameters:SearchParameters, callback:Function)

SearchParameterOptions
  • maxStores superseded by page and storesByPage

1.2.0

Available as May 27, 2016

No changes from the last experimental.

1.2.exp

Available as April 18, 2016

Summary

Features

A new Loader method allows to load the sdk without it’s jQuery dependency. Instead it uses your jQuery (>=1.10) instance. (see Loader#load method)


1.2.exp

Available as March 10, 2016

Summary

Features
  • Search stores along a polyline and a radius.
  • Display route alternatives, in DirectionsRenderer.
  • Display selected marker on image tiles, using the current Styler
  • If no padding is defined in the view, the override on fitBounds is used (was ignored).
  • Added a language option in MapsLoaderOptions to specify the language of the google maps api.
  • Added a searchQuery parameter to the TiledViewOptions
  • Display stores at the tiled image level using different colors for different types.
Big Feature

Allow integrator to specify a custom renderer for tiled data and for search results.

We introduced two new classes:

  • woosmap.layers.renderers.DefaultRenderer
  • woosmap.layers.renderers.MarkersRenderer

that can be subclassed to customize the rendering on the map.

These renderers can be passed to the TiledView constructor through TiledViewOptions#interactionRender and TiledViewOptions#tiledDataRenderer

    // The two renderers *must* be different instances.
    var interactionRenderer = new woosmap.layers.renderers.DefaultRenderer();
    var tiledDataRenderer = new woosmap.layers.renderers.DefaultRenderer()
    
    var view = new woosmap.TiledView({
        "tiledDataRenderer": tiledDataRenderer,
        "interactionRenderer": interactionRenderer
    })

1.1.0

Released: October 20, 2015

Summary

  • Added woosmap.TiledView class which use tiles to represents stores instead of GMarkers. Useful for lot of stores.
  • SearchView Handles multiple geocoding results
  • Search can have a geolocation icon
  • When geolocation is used, we present an user defined text instead of latitude and longitude
  • MapsLoader supports channel parameter

1.0.2

Released: September 29, 2015

Summary

  • Fixed data collection on navigators that do not accept third party cookies
  • Store store_id when collecting selectedStore events.

1.0.1

Released: September 9, 2015

Summary

  • Fixed Woosmap watermark Link

1.0.0

Released: July 22, 2015

Summary

  • Initial release