Source: https://developers.woosmap.com/products/widgets/store-locator-widget/store-locator-widget-reference/ > For clean Markdown of any page, append `.md` to the page URL. > For a complete documentation index, see https://developers.woosmap.com/llms.txt # Store Locator Widget Reference ## WebApp class `WebApp` Construct a new Webapp. #### Create a new WebApp example ```javascript const webapp = new WebApp('html-container-id', 'woosmap-project-key'); webapp.render(); ``` ### Constructor #### `WebApp` `WebApp(elementId, projectKey)` **Parameters:** - `elementId`: `string` The ID of the div that should contain the webapp. - `projectKey`: `string` The public project key. Construct a new Webapp. ### Properties #### `HANDLED_EVENT` **Type** : ` HANDLED_EVENT` ### Methods #### `render` `render(isMobile)` **Parameters:** - `isMobile`: `Boolean` Render the webapp. #### `setConf` `setConf(conf)` **Parameters:** - `conf`: `WebAppConf` Set a custom configuration for the webapp. #### `setInitialStateToNearbyStores` `setInitialStateToNearbyStores()` **Parameters:** None Set the webapp to ask for HTML5 location and display nearby stores on load. #### `setInitialStateToHtmlLocation` `setInitialStateToHtmlLocation()` **Parameters:** None Set the webapp to ask for HTML5 location, center on the position on load. #### `setInitialStateToDirections` `setInitialStateToDirections(storeId, zoom?, travelMode, askForLocation?, originLocation?)` **Parameters:** - `storeId`: `string` - `zoom`: `Number` - `travelMode`: `DirectionMode` - `askForLocation`: `Boolean` - `originLocation`: `LatLngLiteral` Set the webapp to init with directions from an HTML5 location or custom origin to a store. Custom origin is not a fallback to HTML5 location and could be used only if HTML5 location is not asked. #### `setInitialStateToSelectedStore` `setInitialStateToSelectedStore(store_id, zoom)` **Parameters:** - `store_id`: `string` - `zoom`: `Number` Set the webapp to init with a selected store. #### `setInitialStateToGeolocation` `setInitialStateToGeolocation()` **Parameters:** None Set initial state to use the Geolocation API and load nearby stores. #### `listenOn` `listenOn(event, listener)` **Parameters:** - `event`: `HANDLED_EVENT` - `listener`: `Function` Use this method to register a callback on a webapp event. The listener will be called everytime the event is fired. #### `listenOnce` `listenOnce(event, listener)` **Parameters:** - `event`: `HANDLED_EVENT` - `listener`: `Function` Use this method to register a callback on a webapp event. The listener will be called only the first time the event is fired. #### `setFullStoreRenderer` `setFullStoreRenderer(fullStoreRenderer)` **Parameters:** - `fullStoreRenderer`: `Function` a function that takes a `Store` and returns a DOM `Element` Sets the store details renderer. This is a function that takes Store data and renders the store details to an Element. #### `setSummaryStoreRenderer` `setSummaryStoreRenderer(summaryStoreRenderer)` **Parameters:** - `summaryStoreRenderer`: `Function` a function that takes a `Store` and returns a DOM `Element` Sets the store summary renderer. This is a function that takes Store data and renders the store summary to an Element. #### `setFilterRenderer` `setFilterRenderer(filterRenderer)` **Parameters:** - `filterRenderer`: `Function` function returning a DOM `Element` Sets a custom filter renderer. This is a function that takes Filter data and renders the filter to a DOM Element. #### `setFilterPanelRenderer` `setFilterPanelRenderer(filterPanelRenderer)` **Parameters:** - `filterPanelRenderer`: `Function` function returning a DOM `Element` Sets the filter panel renderer. This is a function that takes Filter panel data and renders the filter panel to a DOM Element. If setFilterRenderer is not set, setFilterPanelRenderer will not be applied. #### `setMarkerStyle` `setMarkerStyle(customMarkerStyle)` **Parameters:** - `customMarkerStyle`: `SetMarkerStyleCallback` a function that takes a `Store`, an options object (with selected bool) and returns a `google.maps.Icon` Object Sets Custom Marker Style for Stores. This is a function that takes a callback with parameter Store data and which returns a google.maps.Icon (url, anchor, scaledSize). If setMarkerStyle is not set, default style is applied. ## AddressConf Interface #### AddressConf Example ```javascript { language: "fr", componentRestrictions: { country: ["be", "fr"] }, } ``` ### Properties #### `componentRestrictions?` **Type** : ` LocalitiesComponentRestrictions` The component restrictions. Component restrictions are used to restrict predictions to only those within the parent component. For example, the country. #### `language` **Type** : ` string` The language code, indicating in which language the results should be returned, if possible. Searches are also biased to the selected language; results in the selected language may be given a higher ranking. If language is not supplied, the Localities service will use the default language of each country. No language necessary for postal\_code request.To use this parameter a dedicated option on your licence is needed. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet. ## AutocompleteCallback Interface Type: `Function` AUTOCOMPLETE Event Callback ### Function #### `AutocompleteCallback` `AutocompleteCallback(query)` **Parameters:** - `query`: `string` AUTOCOMPLETE Event Callback ## AutocompleteStoresConf Interface #### AutocompleteStoresConf Example ```javascript { maxStores:3, } ``` ### Properties #### `maxStores` **Type** : ` Number` the maximum number of stores to add to the autocomplete predictions. Default is 1. ## CustomTranslations Interface #### CustomTranslations Example The first level must be a string corresponding to the wanted language (see [I18nConf](#I18nConf) **lang** parameter). Next levels allow to customize “More details” and “Set as favorite” buttons when a store is selected. ```javascript { fr: { storeview: { visitStorePage: "Plus de détails" }, favoritebuttonview: { setAsFavorite: "Définir comme Favori" } } } ``` ## DataSourceConf Interface #### DataSourceConf example ```javascript { baseFilter: '(type:"type1" OR type:"type2") AND tag:"tag1"', maxResponses: 10, maxDistance: 10000, useDistanceMatrix: true, distanceMatrixProvider: 'google', routeProvider: 'woosmap', openedStoresFilter: true } ``` ### Properties #### `baseFilter` **Type** : ` string` A filter to display only a part of your stores. Using this disables Filters feature. #### `distanceMatrixProvider` **Type** : ` string` Choose the distance matrix provider between ‘woosmap’ and ‘google’. Default is google. Woosmap does not return duration. #### `maxDistance` **Type** : ` Number` Maximum distance, in meters, between the searched location and the assets. Default is 0. #### `maxResponses` **Type** : ` Number` Maximum numbers of assets to return on a search. Default is 5. #### `openedStoresFilter` **Type** : ` Boolean` Displays a toggle filtering search results on the opening status of stores. If defined, the toggle can be set as true (display only open stores) or as false (display all stores). If not defined, all stores are shown. #### `routeProvider` **Type** : ` string` Sets the Woosmap route provider using ‘woosmap’. Default is google (or baidu if set as maps provider). #### `useDistanceMatrix` **Type** : ` Boolean` Toggles the usage of Google Distance Matrix to compute time & distance to the search results. Default is true. ## DirectionsConf Interface #### DirectionsConf example ```javascript { selectedMode: "WALKING", traffic: true, } ``` ### Properties #### `selectedMode` **Type** : ` DirectionMode` The default selected mode in directions. #### `traffic?` **Type** : ` Boolean` Allows getting predicted time in traffic (DRIVING mode only). Default is false. #### `transit?` **Type** : ` Boolean` Allows getting directions for the public transit mode. Default is false. ## EmailClickCallback Interface Type: `Function` EMAIL\_CLICK Event Callback ### Function #### `EmailClickCallback` `EmailClickCallback(id_store, email)` **Parameters:** - `id_store`: `string` - `email`: `string` EMAIL\_CLICK Event Callback ## FavoritedCallback Interface Type: `Function` FAVORITED Event Callback ### Function #### `FavoritedCallback` `FavoritedCallback(id_store)` **Parameters:** - `id_store`: `string` FAVORITED Event Callback ## Filter Interface ### Properties #### `choices` **Type** : ` FilterValue[]` Set the different values to filter on. #### `innerOperator` **Type** : ` FilterOperator` Operator applied against the different value of the filter. #### `propertyType` **Type** : ` FilterProperty` Set the property of the asset to filter on. #### `title` **Type** : ` I18nValues` Set the title of the current filter. ## FilterValue Interface ### Properties #### `hidden?` **Type** : ` Boolean` The hidden status of the filter: set true to make it hidden when loading. It can’t be modified after loading. #### `key` **Type** : ` string` The value to filter on or a custom query for custom filters. #### `selected?` **Type** : ` Boolean` The default status of the filter: set true to make it active by default when loading. ## Filters Interface ### Properties #### `filters` **Type** : ` Filter[]` A list of all filters to apply. #### `outerOperator` **Type** : ` FilterOperator` Operator applied against filters. ## FiltersConf Interface #### FiltersConf example ```javascript { filters: { opened: true, customOrder: false, filters: [ { propertyType: "type", title: { en: "Store Type" }, choices: [ { key: "bose_store", en: "Bose Store", selected: true }, { key: "bose_reseller", en: "Bose Reseller" } ], innerOperator: "and" }, { propertyType: "tag", title: { en: "Services" }, choices: [ { key: "wheelchair_access", en: "Wheelchair Access" }, { key: "in-store_wi-fi", en: "Wifi" } ], innerOperator: "and" }, { propertyType: "custom", title: { en: "Location" }, choices: [ { key: "country:France OR user.region:europe", en: "France or Europe" }, ], innerOperator: "and" } ], outerOperator: "or" } } ``` ### Properties #### `customOrder?` **Type** : ` Boolean` Applies customised sorting of filter groups. Set true to sort the filters in the order defined in the filters array. #### `filters` **Type** : ` Filters` #### `opened?` **Type** : ` Boolean` The default state of the filter panel, set true to make it opened by default when loading. ## GeocodeCallback Interface Type: `Function` GEOCODE Event Callback ### Function #### `GeocodeCallback` `GeocodeCallback(query)` **Parameters:** - `query`: `string` GEOCODE Event Callback ## GeocoderConf Interface #### GeocoderConf Example ```javascript { provider: 'address', componentRestrictions: {'country': fr} } ``` ### Properties #### `componentRestrictions?` **Type** : ` google.maps.GeocoderComponentRestrictions` Components are used to restrict results to a specific area. A filter consists of one or more of: route, locality, administrativeArea, postalCode, country. Only the results that match all the filters will be returned. Filter values support the same methods of spelling correction and partial matching as other geocoding requests. #### `provider?` **Type** : ` string` Define which geocode provider to use between address and google. If not specified, google geocoder will be used when the map provider is google otherwise address geocoder will be used. #### `region?` **Type** : ` string` Country code used to bias the search, specified as a Unicode region subtag / CLDR identifier. ## GetDirectionsCallback Interface Type: `Function` GET\_DIRECTIONS Event Callback ### Function #### `GetDirectionsCallback` `GetDirectionsCallback(id_store, start, end)` **Parameters:** - `id_store`: `string` - `start`: `LatLngLiteral` - `end`: `LatLngLiteral` GET\_DIRECTIONS Event Callback ## HANDLED\_EVENT Interface Type: `HANDLED_EVENT` ### Properties #### `AUTOCOMPLETE` **Type** : ` AutocompleteCallback` Triggered when an autocomplete request is sent. #### `EMAIL_CLICK` **Type** : ` EmailClickCallback` Triggered when the email of a selected store is clicked. #### `FAVORITED` **Type** : ` Function` Triggered when a store is set as favorite. #### `GEOCODE` **Type** : ` GeocodeCallback` Triggered when a geocode request succeeds. #### `GET_DIRECTIONS` **Type** : ` GetDirectionsCallback` Triggered when retrieving directions. #### `LOCATION_SELECTED` **Type** : ` LocationSelectedCallback` Triggered when the user location is selected. #### `PHONE_CLICK` **Type** : ` PhoneClickCallback` Triggered when the phone number of a selected store is clicked. #### `SELECT_DIRECTION` **Type** : ` SelectDirectionCallback` Triggered when an itinerary is selected from the directions list. #### `SELECT_STORE` **Type** : ` SelectedStoreCallback` Triggered when a store is selected. #### `UNSELECT_STORE` **Type** : ` UnselectedStoreCallback` Triggered when a store is unselected. ## I18nConf Interface #### I18nConf example ```javascript { lang: "es", period: "en-US", unitSystem: 1; customTranslations: {en: {storeview: {visitStorePage: "View more details"}}} } ``` ### Properties #### `customTranslations?` **Type** : ` Object` Provides custom internationalization for given languages. #### `lang?` **Type** : ` string` The language, values available are [fr, en, es, de, it, nl, ca, pt, pt-br, ru, zh, zh-HK, ja, uk, he, pl, ro, hr, sv, el, sl, hu, cs, sk, da, no]. #### `period?` **Type** : ` string` Hour system to display openning hours [‘fr’ (for 24h), ‘en-US’ (for 12h)]. #### `unitSystem?` **Type** : ` Number` The unit system to display distances [0 (Metric), 1 (Imperial)]. ## I18nValues Interface ### Properties #### `ca?` **Type** : ` string` Catalan value. #### `cs?` **Type** : ` string` Czech value. #### `da?` **Type** : ` string` Danish value. #### `de?` **Type** : ` string` Deutsch value. #### `el?` **Type** : ` string` Greek value. #### `en?` **Type** : ` string` English value. #### `es?` **Type** : ` string` Spanish value. #### `fr?` **Type** : ` string` French value. #### `he?` **Type** : ` string` Hebrew value. #### `hr?` **Type** : ` string` Croatian value. #### `hu?` **Type** : ` string` Hungarian value. #### `it?` **Type** : ` string` Italian value. #### `ja?` **Type** : ` string` Japanese value. #### `nl?` **Type** : ` string` Dutch value. #### `no?` **Type** : ` string` Norwegian value. #### `pl?` **Type** : ` string` Polish value. #### `pt?` **Type** : ` string` Portuguese value. #### `pt-br?` **Type** : ` string` Brazilian Portuguese value. #### `ro?` **Type** : ` string` Romanian value. #### `ru?` **Type** : ` string` Russian value. #### `sk?` **Type** : ` string` Slovak value. #### `sl?` **Type** : ` string` Slovenian value. #### `sv?` **Type** : ` string` Swedish value. #### `zh?` **Type** : ` string` Chinese simplified value. ## InitialSearchConf Interface #### InitialSearchConf example ```javascript { text: "Paris" } ``` ### Properties #### `text` **Type** : ` string` The text to geocode. ## LatLngBoundsLiteral Interface ### Properties #### `northeast` **Type** : ` LatLngLiteral` Latitude in degrees. #### `southwest` **Type** : ` LatLngLiteral` Longitude in degrees. ## LatLngLiteral Interface #### LatLngLiteral Example ```javascript { lat: 43.4 lng: 3.883 } ``` ### Properties #### `lat` **Type** : ` number` Latitude in degrees. #### `lng` **Type** : ` number` Longitude in degrees. ## LocalitiesComponentRestrictions Interface #### LocalitiesComponentRestrictions Example ```javascript { country: ["be", "fr"] } ``` ### Properties #### `country?` **Type** : ` string` Restricts predictions to the specified country (ISO 3166-1 Alpha-2 country code, case insensitive). For example, ‘us’, ‘br’, or ‘au’. You can provide a single one, or an array of up to five country code strings. ## LocalitiesConf Interface #### LocalitiesConf Example ```javascript { language: "fr", componentRestrictions: { country: ["be", "fr"] }, types: ["locality"], } ``` ### Properties #### `componentRestrictions?` **Type** : ` LocalitiesComponentRestrictions` The component restrictions. Component restrictions are used to restrict predictions to only those within the parent component. For example, the country. #### `data` **Type** : ` LocalitiesDataModes` Sets the data mode for your request to localities. Advanced mode is used to get worldwide postcodes.To use this parameter a dedicated option on your licence is needed. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet. #### `extended` **Type** : ` string` parameter, can be set to ‘postal\_code’ to search localities by name or postal codes. #### `language` **Type** : ` string` The language code, indicating in which language the results should be returned, if possible. Searches are also biased to the selected language; results in the selected language may be given a higher ranking. If language is not supplied, the Localities service will use the default language of each country. No language necessary for postal\_code request. #### `types?` **Type** : ` LocalitiesTypes[]` The types of predictions to be returned ## LocationSelectedCallback Interface Type: `Function` LOCATION\_SELECTED Event Callback ### Function #### `LocationSelectedCallback` `LocationSelectedCallback(location)` **Parameters:** - `location`: `LatLngLiteral` LOCATION\_SELECTED Event Callback ## MapsConf Interface #### MapsConf Example ```javascript { provider: "google", apiKey: "AKqsdlj19898s_qsdk", localities: { language: "fr" }, geocoder: { provider: 'google', region: "gb" } } ``` ### Properties #### `address?` **Type** : ` AddressConf` If this key is defined, search will use address service. It overrides places key configuration. This feature is not currently available in China. #### `apiKey?` **Type** : ` string` Your Baidu or Google Maps api key. #### `autocompleteStores?` **Type** : ` AutocompleteStoresConf` If set and autocomplete provider is not Google Places, using the autocomplete will get prediction from stores alongside locations predictions. #### `channel?` **Type** : ` string` A string to track usage across different applications using the same client ID (Google only). #### `clientKey?` **Type** : ` string` Your Client id (Google only). #### `disableDirections?` **Type** : ` Boolean` If set to true, Directions in the widget will be disabled and directions button will open Directions on google maps in a new window. #### `geocoder?` **Type** : ` GeocoderConf` Use this to configure the Geocoder requests (If Places is not used). #### `localities?` **Type** : ` LocalitiesConf` If this key is defined, search will use localities service. It overrides address and places key configuration. This feature is not currently available in China. #### `minLength?` **Type** : ` Number` The minimum number of characters a user must type before search is performed. Default is 3 and when using Baidu default is 1. #### `places?` **Type** : ` google.maps.places.AutocompletionRequest` If this key is defined, then places library will be used. Use this to configure Places requests. #### `provider?` **Type** : ` MapType` Sets whether you want the widget to load and use baidu or google maps. #### `w3w?` **Type** : ` Boolean` Activates the what3words autocomplete and 3wa retrieval for assets. Localities should be the base autocomplete provider. Use /// prefix to search for words. ## MarkerConf Interface #### MarkerConf example ```javascript { icon: { url: "http://webapp.woosmap.com/img/geolocated_marker.png", scaledSize: {height: 32, width: 32}, anchor: {x: 16, y: 16} } } ``` ### Properties #### `icon` **Type** : ` google.maps.Icon` Defines the icons parameters.To prevent display issues on IE11 with SVG, be sure to set a scaledSize to markers. ## MarkerStyleOption Interface ### Properties #### `numbered` **Type** : ` bool` #### `selected` **Type** : ` bool` ## PhoneClickCallback Interface Type: `Function` PHONE\_CLICK Event Callback ### Function #### `PhoneClickCallback` `PhoneClickCallback(id_store, phone)` **Parameters:** - `id_store`: `string` - `phone`: `string` PHONE\_CLICK Event Callback ## SelectDirectionCallback Interface Type: `Function` SELECT\_DIRECTION Event Callback ### Function #### `SelectDirectionCallback` `SelectDirectionCallback(id_store, Selected)` **Parameters:** - `id_store`: `string` Selected store id. - `Selected`: `SelectedDirection` direction. SELECT\_DIRECTION Event Callback ## SelectedDirection Interface ### Properties #### `bounds` **Type** : ` LatLngBoundsLiteral` Direction bounds. #### `end` **Type** : ` SelectedDirectionStartEndObject` Object with address and location. #### `start` **Type** : ` SelectedDirectionStartEndObject` Object with address and location. #### `summary` **Type** : ` string` Direction summary. #### `transportMode` **Type** : ` string` Direction transport mode. ## SelectedDirectionStartEndObject Interface ### Properties #### `address` **Type** : ` string` #### `location` **Type** : ` LatLngLiteral` ## SelectedStoreCallback Interface Type: `Function` SELECTED\_STORE Event Callback ### Function #### `SelectedStoreCallback` `SelectedStoreCallback(id_store)` **Parameters:** - `id_store`: `string` SELECTED\_STORE Event Callback ## SetMarkerStyleCallback Interface Type: `Function` setMarkerStyle Callback ### Function #### `SetMarkerStyleCallback` `SetMarkerStyleCallback(feature, options?)` **Parameters:** - `feature`: `Store` - `options`: `MarkerStyleOption` setMarkerStyle Callback ## Style Interface #### Style Example ```javascript { 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. ## ThemeConf Interface #### ThemeConf example ```javascript { primaryColor: "#FF66CC", storeWebsiteInSameWindow: true } ``` ### Properties #### `enforceAccessibility?` **Type** : ` Boolean` Improve accessibility compliance by adding labels and dedicated buttons to the HTML structure. May enter in conflict with unsupported custom CSS integrations. #### `primaryColor?` **Type** : ` string` The primary color used for the webapp visuals. It should be in hexadecimal format (#FF0066). #### `storeWebsiteInSameWindow?` **Type** : ` Boolean` Defines whether clicking on a store’s website link should open in a new window. ## TileStyle Interface ### Properties #### `color?` **Type** : ` string` An rgba formatted color. #### `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. ## TypesRules Interface ### Properties #### `color` **Type** : ` string` An rgba formatted color. #### `type` **Type** : ` string` Type of a store. #### `zIndex?` **Type** : ` Number` The zIndex priority of the points. ## UnselectedStoreCallback Interface Type: `Function` UNSELECTED\_STORE Event Callback ### Function #### `UnselectedStoreCallback` `UnselectedStoreCallback()` **Parameters:** None UNSELECTED\_STORE Event Callback ## ViewportConf Interface #### ViewportConf example ```javascript { initialZoom: 12, initialCenter: { lat: 43.3, lng: 3.883 } } ``` ### Properties #### `initialCenter` **Type** : ` LatLngLiteral` The geographic position of the center of the map. #### `initialZoom` **Type** : ` Number` The initial zoom, should be a value of from this range [0-22]. ## WebAppConf Interface ### Properties #### `dataSource?` **Type** : ` DataSourceConf` Configure the data source and set filters on your assets. #### `directions?` **Type** : ` DirectionsConf` Configure the way directions feature will behave. #### `filters?` **Type** : ` FiltersConf` Configure The filters buttons to filter on some key values in your asset’s properties. #### `initialSearch?` **Type** : ` InitialSearchConf` Set an initial search to the webapp. It will be automatically geocoded to display stores. #### `internationalization?` **Type** : ` I18nConf` Configure the language and display settings of your widget. #### `maps?` **Type** : ` MapsConf` Configure the maps Api (Baidu or Google). #### `theme?` **Type** : ` ThemeConf` Configure the theme color of the widget. #### `woosmapView?` **Type** : ` WoosmapViewConf` Configure the Woosmap View overlay. ## WoosmapViewConf Interface ### Properties #### `baiduMapStyle?` **Type** : ` BMap.MapStyle` Use this property to change Baidu map style (only some themes are available). ```javascript { ... baiduMapStyle: { style: 'dark' } ... } ``` #### `baseMapStyle?` **Type** : ` google.maps.MapTypeStyle` Use this property to change Google Map basemap style. #### `breakPoint?` **Type** : ` Number` Use this property to configure the breaking point between Tiled view and Marker View. Value is between 0 and 22. #### `enableSatelliteMode?` **Type** : ` Boolean` If true, display a satellite/roadmap toggle button on the map. #### `fitBounds?` **Type** : ` Boolean` If true, the widget will set the viewport of the map to fit all the displayed assets. #### `initialCenter?` **Type** : ` LatLngLiteral` Use this property to configure the initial center of the map. #### `initialZoom?` **Type** : ` Number` Use this property to configure the initial zoom on the map. Value is between 0 and 22. #### `locationMarker?` **Type** : ` MarkerConf` Use this property to configure the current location marker. #### `startLocationMarker?` **Type** : ` MarkerConf` Use this property to configure the start location marker used in directions. #### `style?` **Type** : ` Style` This property references styling rules (StyleRule) used by Woosmap Views. #### `tileStyle?` **Type** : ` TileStyle` Use this property to configure the style of the tiled view. ## DirectionMode Enum DirectionMode ### Constants #### `BICYCLING` **Type** : ` string` #### `DRIVING` **Type** : ` string` #### `TRANSIT` **Type** : ` string` #### `WALKING` **Type** : ` string` ## FilterOperator Enum FilterOperator ### Constants #### `and` **Type** : ` string` #### `or` **Type** : ` string` ## FilterProperty Enum FilterProperty ### Constants #### `custom` **Type** : ` string` #### `tag` **Type** : ` string` #### `type` **Type** : ` string` ## LocalitiesDataModes Enum Values for localities data mode ### Constants #### `advanced` **Type** : ` string` Allows access to worldwide postcodes suggestions (dedicated licence option needed). #### `standard` **Type** : ` string` Allows access to Western Europe postal code suggestions (default value). ## LocalitiesTypes Enum LocalitiesTypes ### Constants #### `address` **Type** : ` string` Includes street addresses for UK and France territories. #### `admin_level` **Type** : ` string` Most commonly used administrative areas. #### `airport` **Type** : ` string` Includes all medium sized to international sized airports. #### `amusement_park` **Type** : ` string` Includes amusement parks like Disneyland Paris. #### `art_gallery` **Type** : ` string` Includes art galleries. #### `country` **Type** : ` string` Countries as whole point of interest. #### `locality` **Type** : ` string` Includes locality names and suburbs worldwide. #### `metro_station` **Type** : ` string` Includes all metro stations. #### `museum` **Type** : ` string` Includes museums. #### `postal_code` **Type** : ` string` Publicly-used postcodes around the world. #### `shopping` **Type** : ` string` Includes shopping malls (or “shopping centers”) - may include private retail brands. #### `tourist_attraction` **Type** : ` string` Includes tourist attractions like the Eiffel tower. #### `train_station` **Type** : ` string` Includes all train stations. #### `zoo` **Type** : ` string` Includes zoos. ## MapType Enum MapType ### Constants #### `baidu` **Type** : ` string` #### `google` **Type** : ` string` #### `woosmap` **Type** : ` string`