你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SearchAddressOptions 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
搜索地址 API 的选项。
public class SearchAddressOptions : Azure.Maps.Search.SearchAddressBaseOptions
type SearchAddressOptions = class
inherit SearchAddressBaseOptions
Public Class SearchAddressOptions
Inherits SearchAddressBaseOptions
- 继承
构造函数
SearchAddressOptions() |
搜索地址 API 的选项。 |
属性
BoundingBox |
边界框。 |
Coordinates |
一对坐标 (lon、lat) ,结果应有偏差。 例如 -121.89、37.337。 (继承自 SearchAddressBaseOptions) |
CountryFilter |
以逗号分隔的国家/地区代码字符串,例如 FR,ES。 这会将搜索限制为指定的国家/地区。 (继承自 SearchAddressBaseOptions) |
EntityType |
指定对地理位置执行的筛选级别。 缩小对指定地理实体类型的搜索范围,例如仅返回市政当局。 生成的响应将包含地理 ID 以及匹配的实体类型。 如果提供多个实体作为逗号分隔列表,终结点将返回“可用最小实体”。 返回的几何 ID 可用于通过 获取搜索多边形 API 获取该地理位置的几何图形。 设置 entityType 时,将忽略以下参数:
|
ExtendedPostalCodesFor |
结果中应包含扩展邮政编码的索引。 可用索引包括:
null 无索引。
默认情况下,除 Geo 之外的所有索引都包含扩展邮政编码。 地理位置的扩展邮政编码列表可能很长,因此必须在需要时显式请求它们。
|
IsTypeAhead |
布尔值。 如果设置了 typeahead 标志,则查询将被解释为部分输入,并且搜索将进入预测模式。 |
Language |
应返回搜索结果的语言。 应该是受支持的 IETF 语言标记之一,不区分大小写。 当指定语言的数据不适用于特定字段时,将使用默认语言。 有关详细信息,请参阅 支持的语言 。 (继承自 SearchBaseOptions) |
LocalizedMapView |
View 参数 (也称为“用户区域”参数,) 允许您为地缘政治争议区域显示特定国家/地区的正确地图。 不同国家/地区对此类区域有不同的视图,并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下,View 参数设置为“Unified”,即使你尚未在请求中定义它。 你有责任确定用户的位置,然后为该位置正确设置 View 参数。 或者,可以选择设置“View=Auto”,这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数的使用必须符合适用法律,包括有关地图、图像和其他数据以及你有权通过Azure Maps访问的第三方内容的国家/地区的法律,包括有关地图的法律。 示例:view=IN。 有关详细信息,请参阅 支持的视图 ,并查看可用的视图。 (继承自 SearchBaseOptions) |
RadiusInMeters |
结果要限制到定义的区域的半径(以米为单位)。 (继承自 SearchAddressBaseOptions) |
Skip |
返回的结果在完整结果集中的起始偏移量。 默认值:0,最小值:0,最大值:1900。 (继承自 SearchBaseOptions) |
Top |
将返回的最大响应数。 默认值:10,最小值:1,最大值:100。 (继承自 SearchBaseOptions) |