Skip to content
English
More support Support Portal Sign in
Contact us
  • There are no suggestions because the search field is empty.

Getting Started

The Wayfinder 2.x API is mostly backward compatible with the 1.x version as long as you are only using the documented functions seen in Wayfinder Web API Reference This module does not implement a UI. This is expected to be created externally and use this API.

Getting Started

Include the library from the CDN as follows:

<script src="https://cdn.wayfinder.acquiredigital.com/live/js-api/three.min.js"></script>
<script src="https://cdn.wayfinder.acquiredigital.com/live/js-api/wayfinderv2.js"></script>
 

Each instance of the map is then created as follows:

var wayfinderInstance = new Wayfinder(htmldiv_element, settings);

htmldiv_element: The HTML DIV where a CANVAS element will be created to render the map in. The canvas is created with a z-index=0. To place something over the top you will need to use a greater z-index. The map will override the DIV border and padding, setting them both to zero.

settings: Is optional, and will override the defaults and any map-specific server defaults as follows:

Note: All colours can be typed in as '#RRGGBB', {r:0,g:0,b:0}, or '#RGB' etc