what3words
what3words is a licensed WebMap extension that can integrate what3words functionality directly to your user maps. To customise options, select Configuration > what3words from the map card.
Field | Description |
API Key | API key to connect to what3words |
Language | Select a default language from the drop-down menu. (This list is automatically populated with options specified in your API key.) |
Offset X | X offset for the pin. The black dot on a pin is set exactly at the centre of the pin. i.e. it has an offset of x=0 and y=0. Customise these values to change the position of the black dot. |
Offset Y | Y offset for the pin. |
Zoom Level | Level map should be zoomed into when words or coordinates are found. |
Focus | To optimise the search experience, address suggestions can be focussed to where the user is located. |
Coordinates to Address | Convert a set of coordinates (comma-separated latitude and longitude) to a 3 word address. Other relevant information is also displayed (country, bounds of the grid square, a nearby town etc). The default URL to the API is displayed and does not need to be changed. |
Address to Coordinates | Converts a 3-word address to a latitude and longitude. |
Auto Suggest API | Auto suggest can take a slightly incorrect 3 word address and suggest a list of valid 3 word addresses. |
Auto Suggest Timeout | If no results are returned after a search, a time-out error is displayed after a specified period. This period value in milliseconds can be customised if necessary. |
Multilingual Auto Suggest | |
Clip Policies | Clipping allows you to specify a country (or list of countries) and/or geographic area to exclude results that are not likely to be relevant to users. Multiple clipping policies using the drop-down options. See here for more information. |
Select Pin | Click to select a customised icon to use for a what3words location. |
Clipping Policies
Clipping allows you to specify a country (or list of countries) and/or geographic area to exclude results that may not be relevant to users. To give a more targeted, shorter set of results to users, what3words recommends various clipping parameters.
Multiple clipping policies can be specified, though only one of each type. For example you can clip to country and clip to circle in the same AutoSuggest call, and it will clip to the intersection of the two (results must be in the circle AND in the country). However, you can't specify two clip-to-circle policies in the same call.
Field | Description |
Clip-to-country | Restricts AutoSuggest to only return results inside the countries specified by comma-separated list of uppercase ISO 3166-1 alpha-2 country codes ![]() |
Clip-to-bounding-box | Restricts AutoSuggest results to a bounding box, specified by coordinates. |
Clip-to-circle | Restrict AutoSuggest results to a circle- specified by latitude and longitude. Use the slider to set the radius of the circle (typically this is in kilometres) |
Clip-to-polygon | Restrict AutoSuggest results to a polygon, specified by latitude/longitude pairs defined at each vertex of the polygon. The polygon should be closed, i.e. the first element should be repeated as the last element; also the list should contain at least 4 entries. The API is currently limited to accepting up to 25 pairs. |