你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SearchGetSearchAddressOptionalParams interface

包:

azure-maps-rest

可选参数。

Extends

RequestOptionsBase

属性

btmRight	边界框的右下角位置。 例如 37.553，-122.453
countrySet	以逗号分隔的国家/地区代码字符串，例如 FR，ES。 这会将搜索限制为指定的国家/地区
extendedPostalCodesFor	结果中应包含扩展邮政编码的索引。 可用索引包括： Addr = 地址范围 Geo = Geographies PAD = 点地址 POI = 兴趣点 Str = Streets XStr = 十字路口 (交叉口) 值应该是以逗号分隔的索引类型列表， (以任何顺序) 或 无 索引。 默认情况下，除 Geo 之外的所有索引都包含扩展邮政编码。 地理位置的扩展邮政编码列表可能很长，因此必须在需要时显式请求它们。 用法示例： 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	布尔值。 如果设置了键入头标志，则查询将被解释为部分输入，并且搜索将进入预测模式
view	View 参数指定通过Azure Maps服务（包括地图上显示的边框和标签）返回的地缘政治争议内容集。 View 参数 (也称为“用户区域参数”) 将显示该国家/地区的正确地图。 默认情况下，View 参数设置为“Unified”，即使你尚未在请求中定义它。 你有责任确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用法律，包括有关地图、图像和其他数据以及你有权通过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 = 十字路口 (交叉口)

值应该是以逗号分隔的索引类型列表， (以任何顺序) 或 无 索引。

默认情况下，除 Geo 之外的所有索引都包含扩展邮政编码。 地理位置的扩展邮政编码列表可能很长，因此必须在需要时显式请求它们。

用法示例：

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?: boolean

属性值

boolean

view

View 参数指定通过Azure Maps服务（包括地图上显示的边框和标签）返回的地缘政治争议内容集。 View 参数 (也称为“用户区域参数”) 将显示该国家/地区的正确地图。 默认情况下，View 参数设置为“Unified”，即使你尚未在请求中定义它。 你有责任确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用法律，包括有关地图、图像和其他数据以及你有权通过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