SearchGetSearchAddressOptionalParams interface

Пакет:

azure-maps-rest

Необязательные параметры.

Extends

RequestOptionsBase

Свойства

btmRight	Нижняя правая позиция ограничивающего прямоугольника. Например, 37.553,-122.453
countrySet	Строка кодов стран, разделенных запятыми, например FR,ES. Это приведет к ограничению поиска в указанных странах
extendedPostalCodesFor	Индексы, для которых в результаты должны быть включены расширенные почтовые индексы. Доступные индексы: Addr = Диапазоны адресов Geo = Geographies PAD = адреса точек POI = точки интереса Str = Streets XStr = пересечения улиц (пересечений) Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или None для без индексов. По умолчанию для всех индексов, кроме географического, включены расширенные почтовые индексы. Расширенные списки почтовых индексов для географических регионов могут быть довольно длинными, поэтому их необходимо явно запрашивать при необходимости. Примеры использования extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.
language	Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых языковых тегов IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки .
lat	Широта, где результаты должны быть смещены. Например, 37.337
limit	Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100
lon	Долгота, где результаты должны быть смещены. Например, -121,89
ofs	Начальная смещение возвращаемых результатов в полном результирующем наборе.
radius	Радиус в метрах до для ограничения результатов определенной областью
topLeft	Верхняя левая позиция ограничивающего прямоугольника. Например, 37.553,-122.453
typeahead	Логическое. Если установлен флаг typeahead, запрос будет интерпретирован как частичный вход, а поиск перейдет в прогнозный режим.
view	Параметр View указывает, какой набор геополитически спорного содержимого возвращается через Azure Maps службы, включая границы и метки, отображаемые на карте. Параметр View (также называемый параметром пользовательского региона) отображает правильные карты для этой страны или региона. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное указание параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимым законодательством, в том числе в отношении сопоставления, страны, в которой доступны карты, изображения и другие данные и содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления.

Унаследованные свойства

abortSignal	Сигнал, который можно использовать для прерывания запросов.
customHeaders	{object} [customHeaders] Определяемые пользователем пользовательские заголовки запросов, которые будут применены перед отправкой запроса.
onDownloadProgress	Обратный вызов, который срабатывает при скачивании.
onUploadProgress	Обратный вызов, который запускается при выполнении отправки.
timeout	Количество миллисекундах, которые может занять запрос до автоматического завершения.

Сведения о свойстве

btmRight

Нижняя правая позиция ограничивающего прямоугольника. Например, 37.553,-122.453

btmRight?: string

Значение свойства

string

countrySet

Строка кодов стран, разделенных запятыми, например FR,ES. Это приведет к ограничению поиска в указанных странах

countrySet?: string[]

Значение свойства

string[]

extendedPostalCodesFor

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

Addr = Диапазоны адресов

Geo = Geographies

PAD = адреса точек

POI = точки интереса

Str = Streets

XStr = пересечения улиц (пересечений)

Значение должно быть разделенным запятыми списком типов индексов (в любом порядке) или None для без индексов.

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

Примеры использования

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Расширенный почтовый индекс возвращается как свойство extendedPostalCode адреса. Доступность зависит от региона.

extendedPostalCodesFor?: string

Значение свойства

string

language

Язык, на котором должны возвращаться результаты поиска. Должен быть одним из поддерживаемых языковых тегов IETF без учета регистра. Если данные на указанном языке недоступны для определенного поля, используется язык по умолчанию. Дополнительные сведения см. в разделе Поддерживаемые языки .

language?: string

Значение свойства

string

lat

Широта, где результаты должны быть смещены. Например, 37.337

lat?: number

Значение свойства

number

limit

Максимальное количество возвращаемых ответов. По умолчанию: 10, минимум: 1 и максимум: 100

limit?: number

Значение свойства

number

lon

Долгота, где результаты должны быть смещены. Например, -121,89

lon?: number

Значение свойства

number

ofs

Начальная смещение возвращаемых результатов в полном результирующем наборе.

ofs?: number

Значение свойства

number

radius

Радиус в метрах до для ограничения результатов определенной областью

radius?: number

Значение свойства

number

topLeft

Верхняя левая позиция ограничивающего прямоугольника. Например, 37.553,-122.453

topLeft?: string

Значение свойства

string

typeahead

Логическое. Если установлен флаг typeahead, запрос будет интерпретирован как частичный вход, а поиск перейдет в прогнозный режим.

typeahead?: boolean

Значение свойства

boolean

view

Параметр View указывает, какой набор геополитически спорного содержимого возвращается через Azure Maps службы, включая границы и метки, отображаемые на карте. Параметр View (также называемый параметром пользовательского региона) отображает правильные карты для этой страны или региона. По умолчанию параметр View имеет значение Unified, даже если он не определен в запросе. Вы несете ответственность за определение расположения пользователей, а затем правильное указание параметра View для этого расположения. Кроме того, можно задать параметр View=Auto, который будет возвращать данные карты на основе IP-адреса запроса. Параметр View в Azure Maps должен использоваться в соответствии с применимым законодательством, в том числе в отношении сопоставления, страны, в которой доступны карты, изображения и другие данные и содержимое третьих лиц, доступ к которому вы имеете через Azure Maps. Пример: view=IN. Дополнительные сведения и доступные представления см. в разделе Поддерживаемые представления.

view?: string

Значение свойства

string

Сведения об унаследованном свойстве

abortSignal

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

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

Наследуется от RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Определяемые пользователем пользовательские заголовки запросов, которые будут применены перед отправкой запроса.

customHeaders?: [key: string]: string

Значение свойства

[key: string]: string

Наследуется от RequestOptionsBase.customHeaders

onDownloadProgress

Обратный вызов, который срабатывает при скачивании.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onDownloadProgress

onUploadProgress

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

onUploadProgress?: (progress: TransferProgressEvent) => void

Значение свойства

(progress: TransferProgressEvent) => void

Наследуется от RequestOptionsBase.onUploadProgress

timeout

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

timeout?: number

Значение свойства

number

Наследуется от RequestOptionsBase.timeout