SearchURL class
SearchURL представляет URL-адрес Azure Maps операций поиска.
- Extends
Конструкторы
| SearchURL(Pipeline, string) | Создает экземпляр SearchURL. |
Унаследованные свойства
| maps |
Базовое строковое значение URL-адреса. |
Методы
| search |
Геокодирование адресов Во многих случаях полная служба поиска может оказаться слишком большой, например, если вас интересует только традиционное геокодирование. Поиск также можно получить доступ исключительно для поиска адресов. Геокодирование выполняется путем попадания в конечную точку геокода только с указанным адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных, превышающих уровень улиц. Никакие pois не будут возвращены. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, от точных адресов улиц или улиц или пересечений, а также более высокого уровня географических регионов, таких как центры города, округа, штаты и т. д. Использует API получения адреса Поиск:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress |
| search |
Обратное геокодирование на адрес Иногда может потребоваться перевести координату (например, -122.3862, 37.786505) в понятный человеку адрес. Чаще всего это необходимо в приложениях отслеживания, где вы получаете gps-канал от устройства или ресурса и хотите знать, по какому адресу расположена координата. Эта конечная точка возвращает сведения об адресе для заданной координаты. Использует обратный API получения Поиск адреса:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse |
| search |
Обратное геокодирование на перекрестную улицу Иногда может потребоваться перевести координату (например, -122,3862, 37,786505) в понятный для человека перекресток. Чаще всего это необходимо в приложениях отслеживания, где вы получаете gps-канал от устройства или ресурса и хотите знать, по какому адресу расположена координата. Эта конечная точка будет возвращать сведения о перекрестной улице для заданной координаты. Использует API получения Поиск обратного пересечения улиц:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet |
| search |
Геокодирование структурированных адресов Геокодирование адресов Azure также можно получить исключительно для поиска структурированных адресов. Индекс поиска геокодирования будет запрашиваться для всех данных, превышающих уровень улиц. Никакие pois не будут возвращены. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, от точных адресов улиц или улиц или пересечений, а также более высокого уровня географических регионов, таких как центры города, округа, штаты и т. д. Использует API получения структурированного адреса Поиск:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
| search |
Конечная точка Поиск Вдоль маршрута позволяет выполнять нечеткий поиск объектов по указанному маршруту.
Этот поиск ограничивается указанием ограничивающей |
| search |
Бесплатная форма Поиск Базовый API по умолчанию — это бесплатная форма Поиск которая обрабатывает самые нечеткие входные данные, обрабатывающие любое сочетание маркеров адреса или POI.
Этот API поиска является каноническим "однострочным поиском".
API Поиск в свободной форме — это простое сочетание поиска POI и геокодирования.
Api также может быть взвешен контекстной позицией (lat./lon. pair) или полностью ограничен координатой и радиусом или может выполняться в более общем случае без точки привязки к географическому смещению.
Мы настоятельно рекомендуем использовать параметр countrySet, чтобы указать только страны, для которых приложение нуждается в охвате, так как поведение по умолчанию будет выполнять поиск по всему миру, потенциально возвращая ненужные результаты. Например: |
| search |
Конечная точка Поиск Geometry позволяет выполнять поиск в свободной форме внутри одной геометрии или нескольких из них.
Будут возвращены результаты поиска, которые входят в геометрию или геометрию.
Географические признаки для поиска можно смоделировать как многоугольники и(или) круговые геометрические объекты, представленные с помощью любого из следующих |
| search |
Поблизости Поиск Если у вас есть вариант использования только для получения результатов POI в определенном расположении, метод поиска поблизости может быть правильным выбором. Эта конечная точка будет возвращать только результаты POI и не принимает параметр поискового запроса. Использует API получения Поиск поблизости:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
| searchPOI(Aborter, string, Search |
Получение POI по имени Если в вашем варианте использования поиска требуются только результаты POI, для поиска можно использовать конечную точку POI. Эта конечная точка будет возвращать только результаты POI. Использует API получения Поиск POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
| search |
Получение POI по категориям Если в вашем варианте использования поиска требуется только фильтрация результатов POI по категориям, можно использовать конечную точку категории. Эта конечная точка будет возвращать только результаты POI, которые классифицируются как указанные. Список доступных категорий можно найти здесь. Использует API получения Поиск категории POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
| search |
API Поиск Polygon позволяет запрашивать геометрические данные, такие как структура города или страны, для набора сущностей, ранее полученных из запроса online Поиск в формате GeoJSON. Идентификатор geometry возвращается в объекте dataSources в разделах geometry и id в Поиск Address или Поиск нечетких вызовов. Обратите внимание, что любой геометрический идентификатор, полученный из конечной точки Поиск в Сети, имеет ограниченный срок существования. Клиент не должен хранить геометрические идентификаторы в постоянном хранилище для последующей рефералы, так как стабильность этих идентификаторов не гарантируется в течение длительного периода времени. Ожидается, что запрос к методу Polygon будет выполнен в течение нескольких минут после запроса к методу Online Поиск, который предоставил идентификатор. Служба позволяет выполнять пакетные запросы до 20 идентификаторов. Использует API получения Поиск Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon |
Наследуемые методы
| new |
Статический метод, используемый для создания нового объекта Pipeline с предоставленными учетными данными. |
Сведения о конструкторе
SearchURL(Pipeline, string)
Создает экземпляр SearchURL.
new SearchURL(pipeline: Pipeline, mapsUrl?: string)Параметры
- pipeline
- Pipeline
Вызовите MapsURL.newPipeline(), чтобы создать конвейер по умолчанию или предоставить настраиваемый конвейер.
- mapsUrl
-
string
Строка URL-адреса, указывающая на службу Azure Maps, по умолчанию — "https://atlas.microsoft.com".
Если протокол не указан, например "atlas.microsoft.com", https будет принято.
Сведения об унаследованном свойстве
mapsUrl
Базовое строковое значение URL-адреса.
mapsUrl: stringЗначение свойства
string
Наследуется отMapsURL.mapsUrl
Сведения о методе
searchAddress(Aborter, string, SearchAddressOptions)
Геокодирование адресов Во многих случаях полная служба поиска может оказаться слишком большой, например, если вас интересует только традиционное геокодирование. Поиск также можно получить доступ исключительно для поиска адресов. Геокодирование выполняется путем попадания в конечную точку геокода только с указанным адресом или частичным адресом. Индекс поиска геокодирования будет запрашиваться для всех данных, превышающих уровень улиц. Никакие pois не будут возвращены. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, от точных адресов улиц или улиц или пересечений, а также более высокого уровня географических регионов, таких как центры города, округа, штаты и т. д. Использует API получения адреса Поиск:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- query
-
string
Адрес для поиска (например, "1 Microsoft way, Redmond, WA").
- options
- SearchAddressOptions
Возвращаемое значение
Promise<SearchAddressResponse>
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)
Обратное геокодирование на адрес Иногда может потребоваться перевести координату (например, -122.3862, 37.786505) в понятный человеку адрес. Чаще всего это необходимо в приложениях отслеживания, где вы получаете gps-канал от устройства или ресурса и хотите знать, по какому адресу расположена координата. Эта конечная точка возвращает сведения об адресе для заданной координаты. Использует обратный API получения Поиск адреса:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- position
- GeoJSON.Position
Позиция для обратного поиска, массив [longitude, latitude] координат, например [-122.125679, 47.641268].
- options
- SearchAddressReverseOptions
Возвращаемое значение
Promise<SearchAddressReverseResponse>
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)
Обратное геокодирование на перекрестную улицу Иногда может потребоваться перевести координату (например, -122,3862, 37,786505) в понятный для человека перекресток. Чаще всего это необходимо в приложениях отслеживания, где вы получаете gps-канал от устройства или ресурса и хотите знать, по какому адресу расположена координата. Эта конечная точка будет возвращать сведения о перекрестной улице для заданной координаты. Использует API получения Поиск обратного пересечения улиц:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
function searchAddressReverseCrossStreet(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseCrossStreetOptions): Promise<SearchAddressReverseCrossStreetResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- position
- GeoJSON.Position
Позиция для обратного поиска, массив [longitude, latitude] координат, например [-122.125679, 47.641268].
Возвращаемое значение
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
Геокодирование структурированных адресов Геокодирование адресов Azure также можно получить исключительно для поиска структурированных адресов. Индекс поиска геокодирования будет запрашиваться для всех данных, превышающих уровень улиц. Никакие pois не будут возвращены. Обратите внимание, что геокодер очень терпим к опечаткам и неполным адресам. Он также будет обрабатывать все, от точных адресов улиц или улиц или пересечений, а также более высокого уровня географических регионов, таких как центры города, округа, штаты и т. д. Использует API получения структурированного адреса Поиск:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- countryCode
-
string
2 или 3 буквы ISO3166-1 часть кода страны в адресе. Например, США.
- options
- SearchAddressStructuredOptions
Возвращаемое значение
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
Конечная точка Поиск Вдоль маршрута позволяет выполнять нечеткий поиск объектов по указанному маршруту.
Этот поиск ограничивается указанием ограничивающей maxDetourTime меры.
Для отправки точек маршрута используется body объект , который будет содержать route объект, представленный GeoJSON LineString в виде типа, а Content-Type заголовок будет иметь значение application/json.
Каждая точка маршрута в route представлена в виде GeoJSON Position типа, т. е. массива, за которым следует значение долготы, а значение высоты игнорируется.
Должен содержать по крайней route мере 2 точки маршрута.
Вполне возможно, что исходный маршрут будет изменен, некоторые из его точек могут быть пропущены.
Если маршрут, проходящий через найденную точку, выполняется быстрее, чем исходный, detourTime значение в ответе будет отрицательным.
Использует API post Поиск Вдоль маршрута:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
function searchAlongRoute(aborter: Aborter, query: string, maxDetourTime: number, body: SearchAlongRouteRequestBody, options?: SearchAlongRouteOptions): Promise<SearchAlongRouteResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- query
-
string
Применимая строка запроса (например, "seattle", "pizza").
- maxDetourTime
-
number
Максимальное время объезда точки интереса в секундах. Максимальное значение — 3600 секунд
Он представляет маршрут для поиска и должен быть допустимым GeoJSON LineString типом. Дополнительные сведения см. в документе RFC 7946 .
- options
- SearchAlongRouteOptions
Возвращаемое значение
Promise<SearchAlongRouteResponse>
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)
Бесплатная форма Поиск Базовый API по умолчанию — это бесплатная форма Поиск которая обрабатывает самые нечеткие входные данные, обрабатывающие любое сочетание маркеров адреса или POI.
Этот API поиска является каноническим "однострочным поиском".
API Поиск в свободной форме — это простое сочетание поиска POI и геокодирования.
Api также может быть взвешен контекстной позицией (lat./lon. pair) или полностью ограничен координатой и радиусом или может выполняться в более общем случае без точки привязки к географическому смещению.
Мы настоятельно рекомендуем использовать параметр countrySet, чтобы указать только страны, для которых приложение нуждается в охвате, так как поведение по умолчанию будет выполнять поиск по всему миру, потенциально возвращая ненужные результаты. Например: countrySet=US,FR. Полный список всех поддерживаемых стран см. в разделе [Поиск охвата] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage).
Большинство запросов Поиск по умолчанию maxFuzzyLevelравно =2, чтобы повысить производительность, а также уменьшить необычные результаты.
Это новое значение по умолчанию можно переопределить по мере необходимости для каждого запроса, передав параметр maxFuzzyLevelзапроса =3 или 4.
Использует API получения Поиск нечетких данных:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
function searchFuzzy(aborter: Aborter, query: string | GeoJSON.Position, options?: SearchFuzzyOptions): Promise<SearchFuzzyResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- query
-
string | GeoJSON.Position
Применимая строка запроса (например, "seattle", "pizza").
Можно также указать в виде массива [longitude, latitude] координат (например, [-122.125679, 47.641268]).
- options
- SearchFuzzyOptions
Возвращаемое значение
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
Конечная точка Поиск Geometry позволяет выполнять поиск в свободной форме внутри одной геометрии или нескольких из них.
Будут возвращены результаты поиска, которые входят в геометрию или геометрию.
Географические признаки для поиска можно смоделировать как многоугольники и(или) круговые геометрические объекты, представленные с помощью любого из следующих GeoJSON типов: GeoJSON FeatureCollection, The geometry можно представить в виде GeoJSON FeatureCollection объекта.
Это рекомендуемый вариант, если геометрия содержит как многоугольник, так и круги.
Может FeatureCollection содержать не более 50 GeoJSON Feature объектов.
Каждый Feature объект должен представлять либо многоугольник, либо круг со следующими условиями: Feature объект для геометрии polygon может иметь максимум 50 координат, а его свойства должны быть пустыми.
Объект Feature для геометрии Circle состоит из центра , представленного типом GeoJSON Point и значением радиуса (в метрах), которое должно быть указано в свойствах объекта вместе со свойством subType , значением которого должно быть "Circle".
Пример FeatureCollection представления см. в разделе Примеры ниже.
GeoJSON GeometryCollection, может geometry быть представлен как GeoJSON GeometryCollection объект .
Это рекомендуемый вариант, если геометрия содержит только список многоугольников.
Может GeometryCollection содержать не более 50 GeoJSON Polygon объектов.
Каждый Polygon объект может иметь максимум 50 координат.
Пример GeometryCollection представления см. в разделе Примеры ниже.
GeoJSON Polygon, может geometry быть представлен как GeoJSON Polygon объект .
Это рекомендуемый вариант, если геометрия содержит один многоугольник.
Объект Polygon может иметь максимум 50 координат.
Использует API Post Поиск Inside Geometry:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
function searchInsideGeometry(aborter: Aborter, query: string, body: SearchInsideGeometryRequestBody, options?: SearchInsideGeometryOptions): Promise<SearchInsideGeometryResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- query
-
string
Применимая строка запроса (например, "seattle", "pizza").
Он представляет геометрию для одного или нескольких географических объектов (парков, границы состояния и т. д.), в которые выполняется поиск, и должен быть типом, совместимым с GeoJSON. Дополнительные сведения см. в документе RFC 7946 .
- options
- SearchInsideGeometryOptions
Возвращаемое значение
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
Поблизости Поиск Если у вас есть вариант использования только для получения результатов POI в определенном расположении, метод поиска поблизости может быть правильным выбором. Эта конечная точка будет возвращать только результаты POI и не принимает параметр поискового запроса. Использует API получения Поиск поблизости:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- location
- GeoJSON.Position
Расположение, в котором результаты должны быть смещены.
Должен быть массивом [longitude, latitude], например [-121.89, 37.337].
- options
- SearchNearbyOptions
Возвращаемое значение
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
Получение POI по имени Если в вашем варианте использования поиска требуются только результаты POI, для поиска можно использовать конечную точку POI. Эта конечная точка будет возвращать только результаты POI. Использует API получения Поиск POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- query
-
string
Имя POI для поиска (например, "статуя свободы", "starbucks").
- options
- SearchPOIOptions
Возвращаемое значение
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
Получение POI по категориям Если в вашем варианте использования поиска требуется только фильтрация результатов POI по категориям, можно использовать конечную точку категории. Эта конечная точка будет возвращать только результаты POI, которые классифицируются как указанные. Список доступных категорий можно найти здесь. Использует API получения Поиск категории POI:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- query
-
string
Категория POI для поиска (например, "АЭРОПОРТ", "ПЛЯЖ").
- options
- SearchPOICategoryOptions
Возвращаемое значение
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
API Поиск Polygon позволяет запрашивать геометрические данные, такие как структура города или страны, для набора сущностей, ранее полученных из запроса online Поиск в формате GeoJSON. Идентификатор geometry возвращается в объекте dataSources в разделах geometry и id в Поиск Address или Поиск нечетких вызовов. Обратите внимание, что любой геометрический идентификатор, полученный из конечной точки Поиск в Сети, имеет ограниченный срок существования. Клиент не должен хранить геометрические идентификаторы в постоянном хранилище для последующей рефералы, так как стабильность этих идентификаторов не гарантируется в течение длительного периода времени. Ожидается, что запрос к методу Polygon будет выполнен в течение нескольких минут после запроса к методу Online Поиск, который предоставил идентификатор. Служба позволяет выполнять пакетные запросы до 20 идентификаторов.
Использует API получения Поиск Polygon:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>Параметры
- aborter
- Aborter
Создайте новый экземпляр Aborter с помощью Aborter.none или Aborter.timeout(), перейдите к документам Aborter, чтобы получить дополнительные примеры об отмене запроса.
- geometries
-
string[]
Разделенный запятыми список пользовательских идентификаторов геометрии, ранее полученных из запроса Поиск в Сети.
Возвращаемое значение
Promise<SearchPolygonResponse>
Сведения о наследуемом методе
newPipeline(Credential, INewPipelineOptions)
Статический метод, используемый для создания нового объекта Pipeline с предоставленными учетными данными.
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): PipelineПараметры
- credential
- Credential
Например, SubscriptionKeyCredential, TokenCredential и MapControlCredential.
- pipelineOptions
- INewPipelineOptions
Возвращаемое значение
Новый объект Pipeline.
Наследуется отMapsURL.newPipeline