Class DirectionFinder

Пеленгатор

Позволяет получать маршруты между локациями.
В приведенном ниже примере показано, как вы можете использовать этот класс, чтобы проложить маршрут от Таймс-сквер до Центрального парка, сначала остановившись в Линкольн-центре, нанести на карту местоположения и путь и отправить карту по электронной почте.

// Get the directions.
var directions = Maps.newDirectionFinder()
    .setOrigin('Times Square, New York, NY')
    .addWaypoint('Lincoln Center, New York, NY')
    .setDestination('Central Park, New York, NY')
    .setMode(Maps.DirectionFinder.Mode.DRIVING)
    .getDirections();
var route = directions.routes[0];

// Set up marker styles.
var markerSize = Maps.StaticMap.MarkerSize.MID;
var markerColor = Maps.StaticMap.Color.GREEN
var markerLetterCode = 'A'.charCodeAt();

// Add markers to the map.
var map = Maps.newStaticMap();
for (var i = 0; i < route.legs.length; i++) {
  var leg = route.legs[i];
  if (i == 0) {
    // Add a marker for the start location of the first leg only.
    map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode));
    map.addMarker(leg.start_location.lat, leg.start_location.lng);
    markerLetterCode++;
  }
  map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode));
  map.addMarker(leg.end_location.lat, leg.end_location.lng);
  markerLetterCode++;
}

// Add a path for the entire route.
map.addPath(route.overview_polyline.points);

// Send the map in an email.
var toAddress = Session.getActiveUser().getEmail();
MailApp.sendEmail(
  toAddress,
  'Directions',
  'Please open: ' + map.getMapUrl() + '&key=YOUR_API_KEY', {
    htmlBody: 'See below.<br/><img src="cid:mapImage">',
    inlineImages: {
      mapImage: Utilities.newBlob(map.getMapImage(), 'image/png')
    }
  }
);

См. также

• API Google Направлений

Методы

Метод	Тип возврата	Краткое описание
addWaypoint(latitude, longitude)	DirectionFinder	Добавляет путевую точку, через которую должен пройти маршрут, используя точку (широта/долгота).
addWaypoint(address)	DirectionFinder	Добавляет путевую точку, через которую должен пройти маршрут, используя адрес.
clearWaypoints()	DirectionFinder	Очищает текущий набор путевых точек.
getDirections()	Object	Получает маршруты, используя пункт отправления, пункт назначения и другие заданные параметры.
setAlternatives(useAlternatives)	DirectionFinder	Устанавливает, следует ли возвращать альтернативные маршруты, а не только маршрут с самым высоким рейтингом (по умолчанию — false).
setArrive(time)	DirectionFinder	Устанавливает желаемое время прибытия (если применимо).
setAvoid(avoid)	DirectionFinder	Устанавливает, следует ли избегать определенных типов ограничений.
setDepart(time)	DirectionFinder	Устанавливает желаемое время отправления (если применимо).
setDestination(latitude, longitude)	DirectionFinder	Устанавливает конечное местоположение, для которого рассчитывается направление, используя точку (широта/долгота).
setDestination(address)	DirectionFinder	Устанавливает конечное местоположение, до которого рассчитывается маршрут, используя адрес.
setLanguage(language)	DirectionFinder	Устанавливает язык, который будет использоваться для указаний.
setMode(mode)	DirectionFinder	Устанавливает режим передвижения (по умолчанию — вождение).
setOptimizeWaypoints(optimizeOrder)	DirectionFinder	Устанавливает, следует ли оптимизировать предоставленный маршрут путем перестановки путевых точек в более эффективном порядке (по умолчанию — false).
setOrigin(latitude, longitude)	DirectionFinder	Устанавливает начальное местоположение для расчета направлений, используя точку (широта/долгота).
setOrigin(address)	DirectionFinder	Устанавливает начальное местоположение, от которого будут рассчитываться маршруты, используя адрес.
setRegion(region)	DirectionFinder	Устанавливает регион, который будет использоваться при интерпретации названий местоположений.

Подробная документация

addWaypoint(latitude, longitude)

Добавляет путевую точку, через которую должен пройти маршрут, используя точку (широта/долгота).

// Creates a DirectionFinder with a wapoint at Lincoln Center.
var directionFinder = Maps.newDirectionFinder().addWaypoint(40.772628, -73.984243);

Параметры

Имя	Тип	Описание
latitude	Number	Широта маршрутной точки.
longitude	Number	Долгота путевой точки.

Возвращаться

DirectionFinder — Объект DirectionFinder для облегчения объединения вызовов в цепочку.

---

addWaypoint(address)

Добавляет путевую точку, через которую должен пройти маршрут, используя адрес.

// Creates a DirectionFinder with a wapoint at Lincoln Center.
var directionFinder = Maps.newDirectionFinder().addWaypoint('Lincoln Center, New York, NY');

Параметры

Имя	Тип	Описание
address	String	Адрес.

Возвращаться

DirectionFinder — Объект DirectionFinder для облегчения объединения вызовов в цепочку.

---

clearWaypoints()

Очищает текущий набор путевых точек.

var directionFinder = Maps.newDirectionFinder()
// ...
// Do something interesting here ...
// ...
// Remove all waypoints added with addWaypoint().
directionFinder.clearWaypoints();

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

---

getDirections()

Получает маршруты, используя пункт отправления, пункт назначения и другие заданные параметры.

// Logs how long it would take to walk from Times Square to Central Park.
var directions = Maps.newDirectionFinder()
    .setOrigin('Times Square, New York, NY')
    .setDestination('Central Park, New York, NY')
    .setMode(Maps.DirectionFinder.Mode.WALKING)
    .getDirections();
Logger.log(directions.routes[0].legs[0].duration.text);

Возвращаться

Object — JSON-объект, содержащий набор маршрутов для направлений, как описано здесь.

См. также

• API Google Направлений

---

setAlternatives(useAlternatives)

Устанавливает, следует ли возвращать альтернативные маршруты, а не только маршрут с самым высоким рейтингом (по умолчанию — false). Если это правда, массив routes результирующего объекта может содержать несколько записей.

// Creates a DirectionFinder with alernative routes enabled.
var directionFinder = Maps.newDirectionFinder().setAlternatives(true);

Параметры

Имя	Тип	Описание
useAlternatives	Boolean	true для возврата альтернативных маршрутов, false в противном случае

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

---

setArrive(time)

Устанавливает желаемое время прибытия (если применимо).

// Creates a DirectionFinder with an arrival time of 2 hours from now.
var now = new Date();
var arrive = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var directionFinder = Maps.newDirectionFinder().setArrive(arrive);

Параметры

Имя	Тип	Описание
time	Date	время прибытия

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

См. также

• API Google Направлений

---

setAvoid(avoid)

Устанавливает, следует ли избегать определенных типов ограничений.

// Creates a DirectionFinder that avoid highways.
var directionFinder = Maps.newDirectionFinder().setAvoid(Maps.DirectionFinder.Avoid.HIGHWAYS);

Параметры

Имя	Тип	Описание
avoid	String	постоянное значение из Avoid

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

См. также

• API Google Направлений

---

setDepart(time)

Устанавливает желаемое время отправления (если применимо).

// Creates a DirectionFinder with a departure time of 1 hour from now.
var now = new Date();
var depart = new Date(now.getTime() + (1 * 60 * 60 * 1000));
var directionFinder = Maps.newDirectionFinder().setDepart(depart);

Параметры

Имя	Тип	Описание
time	Date	время отъезда

Возвращаться

DirectionFinder — Объект DirectionFinder для облегчения объединения вызовов в цепочку.

См. также

• API Google Направлений

---

setDestination(latitude, longitude)

Устанавливает конечное местоположение, до которого рассчитывается направление, используя точку (широта/долгота).

// Creates a DirectionFinder with the destination set to Central Park.
var directionFinder = Maps.newDirectionFinder().setDestination(40.777052, -73.975464);

Параметры

Имя	Тип	Описание
latitude	Number	широта конечного места
longitude	Number	долгота конечного места

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

---

setDestination(address)

Устанавливает конечное местоположение, до которого рассчитывается маршрут, используя адрес.

// Creates a DirectionFinder with the destination set to Central Park.
var directionFinder = Maps.newDirectionFinder().setDestination('Central Park, New York, NY');

Параметры

Имя	Тип	Описание
address	String	конечный адрес

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

---

setLanguage(language)

Устанавливает язык, который будет использоваться для указаний.

// Creates a DirectionFinder with the language set to French.
var directionFinder = Maps.newDirectionFinder().setLanguage('fr');

Параметры

Имя	Тип	Описание
language	String	идентификатор языка BCP-47

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

См. также

• Языковая поддержка в API Google Maps

---

setMode(mode)

Устанавливает режим передвижения (по умолчанию — вождение).

// Creates a DirectionFinder with the mode set to walking.
var directionFinder = Maps.newDirectionFinder().setMode(Maps.DirectionFinder.Mode.WALKING);

Параметры

Имя	Тип	Описание
mode	String	постоянное значение из Mode

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

См. также

• API Google Направлений

---

setOptimizeWaypoints(optimizeOrder)

Устанавливает, следует ли оптимизировать предоставленный маршрут путем перестановки путевых точек в более эффективном порядке (по умолчанию — false).

// Creates a DirectionFinder with wapoint optimization enabled.
var directionFinder = Maps.newDirectionFinder().setOptimizeWaypoints(true);

Параметры

Имя	Тип	Описание
optimizeOrder	Boolean	true для оптимизации порядка или false в противном случае

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

См. также

• API Google Направлений

---

setOrigin(latitude, longitude)

Устанавливает начальное местоположение для расчета направлений, используя точку (широта/долгота).

// Creates a DirectionFinder with the origin set to Times Square.
var directionFinder = Maps.newDirectionFinder().setOrigin(40.759011, -73.984472);

Параметры

Имя	Тип	Описание
latitude	Number	широта начальной точки
longitude	Number	долгота начальной точки

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

---

setOrigin(address)

Устанавливает начальное местоположение для расчета маршрутов с использованием адреса.

// Creates a DirectionFinder with the origin set to Times Square.
var directionFinder = Maps.newDirectionFinder().setOrigin('Times Square, New York, NY');

Параметры

Имя	Тип	Описание
address	String	начальный адрес

Возвращаться

DirectionFinder — экземпляр DirectionFinder для облегчения объединения вызовов в цепочку.

---

setRegion(region)

Устанавливает регион, который будет использоваться при интерпретации названий местоположений. Поддерживаемые коды регионов соответствуют ccTLD, поддерживаемым Google Maps. Например, код региона «uk» соответствует «maps.google.co.uk».

// Creates a DirectionFinder with the region set to France.
var directionFinder = Maps.newDirectionFinder().setRegion('fr');

Параметры

Имя	Тип	Описание
region	String	код региона, который нужно использовать

Возвращаться

DirectionFinder — объект DirectionFinder для облегчения цепочки вызовов.

См. также

• API Google Направлений