Class DirectionFinder

Поиск направления

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

// Get the directions.
const 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();
const route = directions.routes[0];

// Set up marker styles.

let markerLetterCode = 'A'.charCodeAt();

// Add markers to the map.
const map = Maps.newStaticMap();
for (let i = 0; i < route.legs.length; i++) {
  const leg = route.legs[i];
  if (i === 0) {
    // Add a marker for the start location of the first leg only.
    map.setMarkerStyle(
        Maps.StaticMap.MarkerSize.MID,
        Maps.StaticMap.Color.GREEN,
        String.fromCharCode(markerLetterCode),
    );
    map.addMarker(leg.start_location.lat, leg.start_location.lng);
    markerLetterCode++;
  }
  map.setMarkerStyle(
      Maps.StaticMap.MarkerSize.MID,
      Maps.StaticMap.Color.GREEN,
      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.
const 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'),
      },
    },
);

См. также

Методы

Метод Тип возвращаемого значения Краткое описание
add Waypoint(latitude, longitude) Direction Finder Добавляет путевую точку, через которую должен пройти маршрут, используя координаты (широта/долгота).
add Waypoint(address) Direction Finder Добавляет промежуточную точку, через которую должен пройти маршрут, используя адрес.
clear Waypoints() Direction Finder Очищает текущий набор путевых точек.
get Directions() Object Получает маршрут, используя начальную точку, конечную точку и другие заданные параметры.
set Alternatives(useAlternatives) Direction Finder Определяет, следует ли возвращать альтернативные маршруты вместо только маршрута с наивысшим рейтингом (по умолчанию — false ).
set Arrive(time) Direction Finder Устанавливает желаемое время прибытия (если применимо).
set Avoid(avoid) Direction Finder Определяет, следует ли избегать определенных типов ограничений.
set Depart(time) Direction Finder Устанавливает желаемое время отправления (при наличии).
set Destination(latitude, longitude) Direction Finder Задает конечное местоположение, для которого рассчитывается маршрут, используя точку (широта/долгота).
set Destination(address) Direction Finder Задает конечное местоположение, для которого рассчитывается маршрут, используя указанный адрес.
set Language(language) Direction Finder Задает язык, который будет использоваться для отображения указаний.
set Mode(mode) Direction Finder Определяет способ передвижения (по умолчанию — автомобиль).
set Optimize Waypoints(optimizeOrder) Direction Finder Определяет, следует ли оптимизировать предоставленный маршрут путем перестановки путевых точек в более эффективном порядке (по умолчанию — false ).
set Origin(latitude, longitude) Direction Finder Задает начальную точку, от которой рассчитывается маршрут, используя заданную координатную точку (широта/долгота).
set Origin(address) Direction Finder Задает начальную точку, от которой рассчитывается маршрут, используя адрес.
set Region(region) Direction Finder Задает регион, используемый при интерпретации названий местоположений.

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

add Waypoint(latitude, longitude)

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

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

Параметры

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.


add Waypoint(address)

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

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

Параметры

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.


clear Waypoints()

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

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.


get Directions()

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

// Logs how long it takes to walk from Times Square to Central Park.
const 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-объект, содержащий набор маршрутов для указания направлений, как описано здесь .

См. также


set Alternatives(useAlternatives)

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

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

Параметры

Имя Тип Описание
use Alternatives Boolean true возвращает альтернативные маршруты, в противном случае false .

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.


set Arrive(time)

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

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

Параметры

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.

См. также


set Avoid(avoid)

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

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

Параметры

Имя Тип Описание
avoid String Константа из функции Avoid .

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.

См. также


set Depart(time)

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

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

Параметры

Имя Тип Описание
time Date Время отправления.

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.

См. также


set Destination(latitude, longitude)

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

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

Параметры

Имя Тип Описание
latitude Number The latitude of the ending location.
longitude Number Долгота конечного пункта.

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.


set Destination(address)

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

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

Параметры

Имя Тип Описание
address String Заключительная речь.

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.


set Language(language)

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

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

Параметры

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.

См. также


set Mode(mode)

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

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

Параметры

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.

См. также


set Optimize Waypoints(optimizeOrder)

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

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

Параметры

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.

См. также


set Origin(latitude, longitude)

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

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

Параметры

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

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.


set Origin(address)

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

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

Параметры

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

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

Direction Finder — Экземпляр DirectionFinder, облегчающий цепочку звонков.


set Region(region)

Задает регион, используемый при интерпретации названий местоположений. Поддерживаемые коды регионов соответствуют национальным доменам верхнего уровня (ccTLD), поддерживаемым Google Maps. Например, код региона "uk" соответствует "maps.google.co.uk".

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

Параметры

Имя Тип Описание
region String Код региона для использования.

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

Direction Finder — объект DirectionFinder, облегчающий цепочку звонков.

См. также