Map Display

Common parameter formats

Geographical coordinates

All API methods that receive geographic coordinates as parameters accept two different formats:

  • Maplink Platform: an object containing the latitude and longitude properties. This format is compatible with returns from Maplink Platform APIs, such as Trip and Planning, in order to facilitate integration with them. Example:
maplink.marker({latitude: -23.986437,longitude: -46.308303});
  • Leaflet: an array containing the latitude and longitude values respectively. This is Leaflet’s standard coordinate format. Example:
L.marker([-23.986437, -46.308303]);

Optional configurations

Methods that have optional settings, such as color and size settings for geometric shapes, will always have the argument options. The expected value for this argument is an object whose properties represent the configuration settings.