Эта страница переведена с помощью Cloud Translation API.

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'),
      },
    },
);

См. также

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

Методы

Метод	Тип возврата	Краткое описание
`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 would take 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-объект, содержащий набор маршрутов для направлений, как описано здесь.

См. также

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

`set Alternatives(useAlternatives)`

Устанавливает, следует ли возвращать альтернативные маршруты, а не только маршрут с самым высоким рейтингом (по умолчанию — false). Если это правда, массив 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 для облегчения цепочки вызовов.

См. также

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

`set Avoid(avoid)`

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

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

Параметры

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

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

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

См. также

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

`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 для облегчения объединения вызовов в цепочку.

См. также

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

`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`	широта конечного места
`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 для облегчения цепочки вызовов.

См. также

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

`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 для облегчения цепочки вызовов.

См. также

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

`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 для облегчения цепочки вызовов.

См. также

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

`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 для облегчения цепочки вызовов.

См. также

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