View Source ExMaps (ExMaps v1.1.3)

Public ExMaps application interface.

This module provides functions to interact with the Google Maps API, offering directions and distance matrix calculations.

Summary

Types

alternatives()

arrival_time()

avoid()

avoid_value()

coordinates()

Required parameters for directions API request.

departure_time()

destinations()

Represents destinations for a distance matrix request.

language()

matrix_coordinates()

Required parameters for distance matrix API request.

mode()

Optional parameters shared across API requests.

option()

options()

origins()

Represents origins for a distance matrix request.

output_format()

Format of the output of Google Maps API call. Please note that JSON is recommended by Google docs.

protocol()

Protocol type used for the request, defaults to HTTPS.

region()

traffic_model()

transit_mode()

transit_routing_preference()

ttl()

Time-to-live for cached results.

units()

waypoint()

Represents a waypoint, which can be a string, a tuple of latitude/longitude, or a map with a place ID.

waypoints()

Functions

get_directions(coordinates, options \\ [])

Returns calculated directions between provided locations.

get_distance_matrix(matrix_coordinates, options \\ [])

Returns travel distance and time for a matrix of origins and destinations.

Types

alternatives()

@type alternatives() :: boolean()

arrival_time()

@type arrival_time() :: integer()

avoid()

@type avoid() :: [avoid_value()]

avoid_value()

@type avoid_value() :: :tolls | :highways | :ferries | :indoor

coordinates()

@type coordinates() :: [%{origin: waypoint(), destination: waypoint()}]

Required parameters for directions API request.

departure_time()

@type departure_time() :: integer()

destinations()

@type destinations() :: String.t() | {float(), float()} | %{place_id: String.t()}

Represents destinations for a distance matrix request.

language()

@type language() :: String.t()

matrix_coordinates()

@type matrix_coordinates() :: [%{origins: [waypoint()], destinations: [waypoint()]}]

Required parameters for distance matrix API request.

mode()

@type mode() :: :driving | :walking | :bicycling | :transit

Optional parameters shared across API requests.

mode - Specifies the mode of transport to use when calculating directions. Defaults to driving.
waypoints - A list of waypoints.
alternatives - If set to true, API may provide more than one route alternative.
avoid - List of specific routes to avoid.
language - Directions may be provided in specified language (not all JSON/XML answer fields).
units - If not present, unit system of the origin's country or region will be returned.
region - Biasing on a specific region.
arrival_time - Desired arrival time in seconds since midnight, January 1, 1970 UTC.
departure_time - Desired departure time in seconds since midnight, January 1, 1970 UTC.
traffic_model - May only be specified for driving directions where the request includes a departure_time.
transit_mode - May only be specified for transit directions.
transit_routing_preference - May bias the options returned.

option()

@type option() ::
  mode()
  | output_format()
  | waypoints()
  | alternatives()
  | language()
  | units()
  | region()
  | arrival_time()
  | departure_time()
  | traffic_model()
  | transit_mode()
  | transit_routing_preference()

options()

@type options() :: [{option(), term()}]

origins()

@type origins() :: String.t() | {float(), float()} | %{place_id: String.t()}

Represents origins for a distance matrix request.

output_format()

@type output_format() :: :json | :xml

Format of the output of Google Maps API call. Please note that JSON is recommended by Google docs.

protocol()

@type protocol() :: :https | :http

Protocol type used for the request, defaults to HTTPS.

region()

@type region() :: String.t()

traffic_model()

@type traffic_model() :: :best_guess | :pessimistic | :optimistic

transit_mode()

@type transit_mode() :: :bus | :subway | :train | :tram | :rail

transit_routing_preference()

@type transit_routing_preference() :: :less_walking | :fewer_transfers

ttl()

@type ttl() :: integer()

Time-to-live for cached results.

units()

@type units() :: :metric | :imperial

waypoint()

@type waypoint() :: String.t() | {float(), float()} | %{place_id: String.t()}

Represents a waypoint, which can be a string, a tuple of latitude/longitude, or a map with a place ID.

waypoints()

@type waypoints() :: :waypoints

Functions

get_directions(coordinates, options \\ [])

@spec get_directions(coordinates(), options()) :: [map()]

Returns calculated directions between provided locations.

Checks whether the directions with the same set of options have already been calculated and cached. If not, it calls the Google API, fetches the result, saves it in cache, and returns it.

Examples

iex> ExMaps.get_directions([%{origin: "Warsaw", destination: "Amsterdam"}], units: :metric)
[%{"geocoded_waypoints" => ... }]

get_distance_matrix(matrix_coordinates, options \\ [])

@spec get_distance_matrix(matrix_coordinates(), options()) :: [map()]

Returns travel distance and time for a matrix of origins and destinations.

Checks whether the matrix with the same set of options has already been requested and cached. If not, it calls the Google API, fetches the result, saves it in cache, and returns it.

Examples

iex> ExMaps.get_distance_matrix([%{origins: ["Warsaw", "Kraków"], destinations: ["Amsterdam", "Utrecht"]}], language: "pl")
[%{"destination_addresses" => ...}]