Обзор
Сервис Elevation предоставляет сведения о высоте для точек на земной поверхности, включая глубины океана (в этом случае возвращаются отрицательные значения). Если у Google нет точных данных о высоте для интересующей вас точки, сервис использует интерполяцию и возвращает усредненное значение по четырем ближайшим точкам.
Объект ElevationService реализует простой интерфейс, позволяющий запрашивать данные о высоте разных точек земной поверхности. Кроме того, можно запросить выборку данных о высоте для точек пути. Это позволит вычислить изменения высоты в равноудаленных друг от друга точках маршрута. Объект ElevationService взаимодействует с сервисом Elevation в Google Maps API, который получает запросы о высоте и возвращает нужные данные.
С помощью сервиса Elevation можно разрабатывать приложения для пешего и велосипедного туризма, мобильного позиционирования или топографической съемки с низким разрешением.
Начало работы
Прежде чем использовать сервис Elevation в Maps JavaScript API, убедитесь, что в консоли Google Cloud включен Elevation API в том же проекте, который вы настроили для работы с Maps JavaScript API.
Чтобы посмотреть список включенных API:
- Перейдите в консоль Google Cloud.
- Нажмите кнопку Select a project (Выбрать проект), затем выберите тот же проект, который вы используете для Maps JavaScript API, и нажмите Open (Открыть).
- В списке API на панели управления найдите Elevation API.
- Если этот API есть в списке – все готово к работе. Если API в списке нет, включите его:
- Вверху страницы нажмите Enable API (Включить API), чтобы перейти на вкладку Library (Библиотека). Вы также можете выбрать в меню слева пункт Library (Библиотека).
- Введите поисковый запрос Elevation API и выберите API из списка результатов.
- Нажмите Enable (Включить). Когда процесс завершится, Elevation API появится в списке API на панели управления.
Цены и правила
Цены
Узнать больше о ценах и правилах использования сервиса JavaScript Elevation можно в статье Статистика использования и оплата для Elevation API.
Правила
Сервис Elevation необходимо использовать в соответствии с правилами для Elevation API.
Запросы данных о высоте
Доступ к сервису Elevation осуществляется асинхронно, поскольку Google Maps API требуется отправлять вызовы на внешний сервер. По этой причине необходимо передавать метод обратного вызова, который будет выполняться по завершении запроса. Этот метод обратного вызова должен обрабатывать результаты. Обратите внимание, что сервис Elevation возвращает код статуса (ElevationStatus) и массив отдельных объектов ElevationResult.
Объект ElevationService обрабатывает следующие два типа запросов:
- Запросы для отдельных местоположений с помощью метода
getElevationForLocations(), которому передается список из одного или нескольких местоположений в объектеLocationElevationRequest. - Запросы данных о высоте в последовательности соединенных точек вдоль пути с помощью метода
getElevationAlongPath(), которому передается упорядоченный набор точек маршрута в объектеPathElevationRequest. При запросе данных о высоте вдоль путей нужно также передавать параметр, указывающий количество контрольных точек вдоль пути, которые вы хотите обработать.
Каждый из этих методов также должен передавать метод обратного вызова для обработки возвращаемых объектов ElevationResult и ElevationStatus.
Запросы данных о высоте места
Объектный литерал LocationElevationRequest содержит следующее поле:
{ locations[]: LatLng }
locations (обязательный параметр) задает одну или несколько точек на земной поверхности, высоту которых требуется получить. Этот параметр принимает массив объектов LatLng.
В массиве можно передать любое число координат, но в пределах квот сервиса. Обратите внимание, что при передаче координат нескольких точек точность полученных данных может быть ниже, чем при запросе данных для одной точки.
Запросы данных о высоте по контрольным точкам пути
Объектный литерал PathElevationRequest содержит следующие поля:
{ path[]: LatLng, samples: Number }
Назначение этих полей объясняется ниже.
path(обязательный параметр) определяет путь на земной поверхности, для которого требуются данные о высоте. Параметрpathопределяет набор из одной или нескольких упорядоченных пар {широта,долгота} с помощью массива из двух и более объектовLatLng.samples(обязательный параметр) указывает количество контрольных точек вдоль пути, для которого требуется получить данные о высоте. Параметрsamplesделит заданный параметромpathпуть на отрезки из ряда равноудаленных точек.
Как и в запросах для отдельных точек, параметр path указывает набор значений широты и долготы. Однако, в отличие от запросов для отдельных точек, в параметре path указывается упорядоченный набор вершин ломаной кривой. Запрос пути не просто возвращает данные о высоте в каждой вершине. Производится выборка вдоль пути, где все контрольные точки равноудалены друг от друга (включая конечные точки).
Ответы на запросы о высоте
Для каждого допустимого запроса сервис Elevation возвращает указанному обратному вызову набор объектов ElevationResult наряду с объектом ElevationStatus.
Состояния сервиса Elevation
Каждый запрос данных о высоте возвращает код ElevationStatus в своей функции обратного вызова. Этот код status содержит одно из следующих значений:
OKозначает, что запрос к сервису успешно выполнен;INVALID_REQUESTозначает, что запрос к сервису сформирован неправильно;OVER_QUERY_LIMITозначает, что запрашивающее приложение превысило квоту;REQUEST_DENIEDозначает, что сервис не выполнил запрос, вероятнее всего, из-за недопустимого параметра;UNKNOWN_ERRORозначает неизвестную ошибку.
Успешное выполнение обратного вызова следует проверять по коду статуса OK.
Результаты сервиса Elevation
При успешном выполнении запроса аргумент results функции обратного вызова будет содержать набор объектов ElevationResult.
Эти объекты содержат следующие элементы:
- Элемент
location(содержащий объектыLatLng) той точки, для которой вычисляются данные о высоте. Обратите внимание, что для запросов пути набор элементовlocationбудет содержать контрольные точки вдоль пути. - Элемент
elevation, указывающий высоту точки над уровнем моря в метрах. - Значение
resolution, указывающее максимальное расстояние (в метрах) между точками данных, на основании которых интерполируется значение высоты. Если разрешение неизвестно, это свойство отсутствует. Обратите внимание, что если передается много точек, точность высотных данных снижается (более высокие значения элементаresolution). Чтобы получить максимально точное значение высоты для точки, следует запрашивать его независимо от других точек.
Примеры использования сервиса Elevation
Следующий код с помощью объекта LocationElevationRequest переводит клик по карте в запрос данных о высоте:
TypeScript
async function init(): Promise<void> { const [{ InfoWindow }, { ElevationService }] = await Promise.all([ google.maps.importLibrary('maps'), google.maps.importLibrary('elevation'), ]); const mapElement = document.querySelector('gmp-map')!; const innerMap = mapElement.innerMap; const elevator = new ElevationService(); const infowindow = new InfoWindow(); infowindow.open(innerMap); // Add a listener for the click event. Display the elevation for the LatLng of // the click inside the infowindow. innerMap.addListener('click', (event: google.maps.MapMouseEvent) => { displayLocationElevation(event.latLng!, elevator, infowindow, innerMap); }); } function displayLocationElevation( location: google.maps.LatLng, elevator: google.maps.ElevationService, infowindow: google.maps.InfoWindow, map: google.maps.Map ) { // Format numeric values to two decimal places const formatter = new Intl.NumberFormat(undefined, { maximumFractionDigits: 2, }); // Initiate the location request elevator .getElevationForLocations({ locations: [location], }) .then(({ results }) => { if (results[0]) { const { elevation, location: resultLocation } = results[0]; infowindow.setPosition(resultLocation); infowindow.setContent( `The elevation at ${String(resultLocation)} <br>is ${formatter.format(elevation)} meters.` ); } else { infowindow.setPosition(location); infowindow.setContent('No results found'); } infowindow.open(map); }) .catch((e: unknown) => { infowindow.setContent( `Elevation service failed due to: ${String(e)}` ); }); } void init();
JavaScript
async function init() { const [{ InfoWindow }, { ElevationService }] = await Promise.all([ google.maps.importLibrary('maps'), google.maps.importLibrary('elevation'), ]); const mapElement = document.querySelector('gmp-map'); const innerMap = mapElement.innerMap; const elevator = new ElevationService(); const infowindow = new InfoWindow(); infowindow.open(innerMap); // Add a listener for the click event. Display the elevation for the LatLng of // the click inside the infowindow. innerMap.addListener('click', (event) => { displayLocationElevation(event.latLng, elevator, infowindow, innerMap); }); } function displayLocationElevation(location, elevator, infowindow, map) { // Format numeric values to two decimal places const formatter = new Intl.NumberFormat(undefined, { maximumFractionDigits: 2, }); // Initiate the location request elevator .getElevationForLocations({ locations: [location], }) .then(({ results }) => { if (results[0]) { const { elevation, location: resultLocation } = results[0]; infowindow.setPosition(resultLocation); infowindow.setContent( `The elevation at ${String(resultLocation)} <br>is ${formatter.format(elevation)} meters.` ); } else { infowindow.setPosition(location); infowindow.setContent('No results found'); } infowindow.open(map); }) .catch((e) => { infowindow.setContent( `Elevation service failed due to: ${String(e)}` ); }); } void init();
В следующем примере из заданного набора координат строится ломаная линия и приводятся данные о высоте вдоль этого пути с использованием API визуализации Google. Этот API необходимо загрузить с помощью Google Common Loader. Запрос данных о высоте создается с помощью объекта PathElevationRequest:
TypeScript
// Load the Visualization API and the columnchart package. // @ts-ignore TODO update to newest visualization library google.load("visualization", "1", { packages: ["columnchart"] }); function initMap(): void { // The following path marks a path from Mt. Whitney, the highest point in the // continental United States to Badwater, Death Valley, the lowest point. const path = [ { lat: 36.579, lng: -118.292 }, // Mt. Whitney { lat: 36.606, lng: -118.0638 }, // Lone Pine { lat: 36.433, lng: -117.951 }, // Owens Lake { lat: 36.588, lng: -116.943 }, // Beatty Junction { lat: 36.34, lng: -117.468 }, // Panama Mint Springs { lat: 36.24, lng: -116.832 }, ]; // Badwater, Death Valley const map = new google.maps.Map( document.getElementById("map") as HTMLElement, { zoom: 8, center: path[1], mapTypeId: "terrain", } ); // Create an ElevationService. const elevator = new google.maps.ElevationService(); // Draw the path, using the Visualization API and the Elevation service. displayPathElevation(path, elevator, map); } function displayPathElevation( path: google.maps.LatLngLiteral[], elevator: google.maps.ElevationService, map: google.maps.Map ) { // Display a polyline of the elevation path. new google.maps.Polyline({ path: path, strokeColor: "#0000CC", strokeOpacity: 0.4, map: map, }); // Create a PathElevationRequest object using this array. // Ask for 256 samples along that path. // Initiate the path request. elevator .getElevationAlongPath({ path: path, samples: 256, }) .then(plotElevation) .catch((e) => { const chartDiv = document.getElementById( "elevation_chart" ) as HTMLElement; // Show the error code inside the chartDiv. chartDiv.innerHTML = "Cannot show elevation: request failed because " + e; }); } // Takes an array of ElevationResult objects, draws the path on the map // and plots the elevation profile on a Visualization API ColumnChart. function plotElevation({ results }: google.maps.PathElevationResponse) { const chartDiv = document.getElementById("elevation_chart") as HTMLElement; // Create a new chart in the elevation_chart DIV. const chart = new google.visualization.ColumnChart(chartDiv); // Extract the data from which to populate the chart. // Because the samples are equidistant, the 'Sample' // column here does double duty as distance along the // X axis. const data = new google.visualization.DataTable(); data.addColumn("string", "Sample"); data.addColumn("number", "Elevation"); for (let i = 0; i < results.length; i++) { data.addRow(["", results[i].elevation]); } // Draw the chart using the data within its DIV. chart.draw(data, { height: 150, legend: "none", // @ts-ignore TODO update to newest visualization library titleY: "Elevation (m)", }); } declare global { interface Window { initMap: () => void; } } window.initMap = initMap;
JavaScript
// Load the Visualization API and the columnchart package. // @ts-ignore TODO update to newest visualization library google.load("visualization", "1", { packages: ["columnchart"] }); function initMap() { // The following path marks a path from Mt. Whitney, the highest point in the // continental United States to Badwater, Death Valley, the lowest point. const path = [ { lat: 36.579, lng: -118.292 }, // Mt. Whitney { lat: 36.606, lng: -118.0638 }, // Lone Pine { lat: 36.433, lng: -117.951 }, // Owens Lake { lat: 36.588, lng: -116.943 }, // Beatty Junction { lat: 36.34, lng: -117.468 }, // Panama Mint Springs { lat: 36.24, lng: -116.832 }, ]; // Badwater, Death Valley const map = new google.maps.Map(document.getElementById("map"), { zoom: 8, center: path[1], mapTypeId: "terrain", }); // Create an ElevationService. const elevator = new google.maps.ElevationService(); // Draw the path, using the Visualization API and the Elevation service. displayPathElevation(path, elevator, map); } function displayPathElevation(path, elevator, map) { // Display a polyline of the elevation path. new google.maps.Polyline({ path: path, strokeColor: "#0000CC", strokeOpacity: 0.4, map: map, }); // Create a PathElevationRequest object using this array. // Ask for 256 samples along that path. // Initiate the path request. elevator .getElevationAlongPath({ path: path, samples: 256, }) .then(plotElevation) .catch((e) => { const chartDiv = document.getElementById("elevation_chart"); // Show the error code inside the chartDiv. chartDiv.innerHTML = "Cannot show elevation: request failed because " + e; }); } // Takes an array of ElevationResult objects, draws the path on the map // and plots the elevation profile on a Visualization API ColumnChart. function plotElevation({ results }) { const chartDiv = document.getElementById("elevation_chart"); // Create a new chart in the elevation_chart DIV. const chart = new google.visualization.ColumnChart(chartDiv); // Extract the data from which to populate the chart. // Because the samples are equidistant, the 'Sample' // column here does double duty as distance along the // X axis. const data = new google.visualization.DataTable(); data.addColumn("string", "Sample"); data.addColumn("number", "Elevation"); for (let i = 0; i < results.length; i++) { data.addRow(["", results[i].elevation]); } // Draw the chart using the data within its DIV. chart.draw(data, { height: 150, legend: "none", // @ts-ignore TODO update to newest visualization library titleY: "Elevation (m)", }); } window.initMap = initMap;