你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
SearchURL class
SearchURL 表示Azure Maps搜索操作的 URL。
- Extends
构造函数
| SearchURL(Pipeline, string) | 创建 SearchURL 的实例。 |
继承属性
| maps |
基 URL 字符串值。 |
方法
| search |
地址地理编码 在许多情况下，完整的搜索服务可能太多，例如，如果你只对传统的地理编码感兴趣。 还可以访问搜索以独占方式查找地址。 地理编码是通过只使用有问题的地址或部分地址命中地理编码终结点来执行的。 地理编码搜索索引将查询街道级别数据以上的所有内容。 不会返回任何 POI。 请注意，地理编码器非常能容忍拼写错误和不完整的地址。 它还将处理所有内容，从确切的街道地址或街道或交叉口，以及更高级别的地理区域，如市中心，县，州等。使用获取搜索地址 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 地址地理编码，以便以独占方式查找结构化地址。 地理编码搜索索引将查询街道级别数据以上的所有内容。 不会返回任何 POI。 请注意，地理编码器非常能容忍拼写错误和不完整的地址。 它还将处理所有内容，从确切的街道地址或街道或交叉口，以及更高级别的地理区域，如市中心，县，州等。使用获取搜索地址结构化 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
| search |
沿路由搜索终结点允许对指定路由上的 POI 执行模糊搜索。
此搜索通过指定 |
| search |
自由格式搜索基本的默认 API 是自由格式搜索，它处理处理地址或 POI 令牌的任意组合的最模糊的输入。
此搜索 API 是规范的“单行搜索”。
自由格式搜索 API 是 POI 搜索和地理编码的无缝组合。
还可以使用上下文位置 (lat./lon 对 API 进行加权。对) ，或完全受坐标和半径约束，或者可以更普遍地执行，没有任何地理偏差定位点。
强烈建议使用“countrySet”参数仅指定应用程序需要覆盖的国家/地区，因为默认行为是搜索整个世界，可能会返回不必要的结果。 例如： |
| search |
搜索 Geometry 终结点允许在单个或多个几何图形中执行自由形式搜索。
将返回 geometry/geometries 内的搜索结果。
可以使用以下 |
| search |
附近搜索如果你有一个用例，用于仅检索特定位置的 POI 结果，则附近搜索方法可能是正确的选择。 此终结点仅返回 POI 结果，不采用搜索查询参数。 使用 Get 搜索 就近 API：https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
| searchPOI(Aborter, string, Search |
按名称获取 POI 如果搜索用例只需要 POI 结果，则可以使用 POI 终结点进行搜索。 此终结点将仅返回 POI 结果。 使用 Get 搜索 POI API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
| search |
按类别获取 POI 如果搜索用例只需要按类别筛选的 POI 结果，则可以使用类别终结点。 此终结点将仅返回分类为指定的 POI 结果。 可 在此处找到可用类别的列表。 使用 Get 搜索 POI 类别 API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
| search |
搜索 Polygon API 允许你请求一组实体的几何图形数据，例如城市或国家/地区大纲，这些实体以前从 GeoJSON 格式的联机搜索请求中检索。 geometry ID 在 dataSources 对象中的“geometry”和“id”下返回搜索 Address 或 搜索 模糊调用。 请注意，从联机搜索终结点检索到的任何几何图形 ID 的生存期都有限。 客户端不应将几何图形 ID 存储在持久存储中供以后引用，因为长期无法保证这些标识符的稳定性。 预期会在向提供 ID 的 Online 搜索 方法发出请求后的几分钟内向 Polygon 方法发出请求。 该服务允许批处理请求最多 20 个标识符。 使用 Get 搜索 Polygon API：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
指向Azure Maps服务的 URL 字符串，默认值为 "https://atlas.microsoft.com"。
如果未指定任何协议，例如 "atlas.microsoft.com"， https 则假定为 。
继承属性详细信息
mapsUrl
方法详细信息
searchAddress(Aborter, string, SearchAddressOptions)
地址地理编码 在许多情况下，完整的搜索服务可能太多，例如，如果你只对传统的地理编码感兴趣。 还可以访问搜索以独占方式查找地址。 地理编码是通过只使用有问题的地址或部分地址命中地理编码终结点来执行的。 地理编码搜索索引将查询街道级别数据以上的所有内容。 不会返回任何 POI。 请注意，地理编码器非常能容忍拼写错误和不完整的地址。 它还将处理所有内容，从确切的街道地址或街道或交叉口，以及更高级别的地理区域，如市中心，县，州等。使用获取搜索地址 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 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.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 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.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- position
- GeoJSON.Position
要反向搜索的位置，坐标数组 [longitude, latitude] ，例如 [-122.125679, 47.641268]。
返回
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
结构化地址地理编码 还可以访问 Azure 地址地理编码，以便以独占方式查找结构化地址。 地理编码搜索索引将查询街道级别数据以上的所有内容。 不会返回任何 POI。 请注意，地理编码器非常能容忍拼写错误和不完整的地址。 它还将处理所有内容，从确切的街道地址或街道或交叉口，以及更高级别的地理区域，如市中心，县，州等。使用获取搜索地址结构化 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- countryCode
-
string
地址的 2 或 3 个字母 ISO3166-1 国家/地区代码部分。 例如 US。
- options
- SearchAddressStructuredOptions
返回
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
沿路由搜索终结点允许对指定路由上的 POI 执行模糊搜索。
此搜索通过指定 maxDetourTime 限制度量值进行约束。
若要发送路由点，将使用 body 将包含 route 表示为 GeoJSON LineString 类型的 对象， Content-Type 并且标头将设置为 application/json。
中的每个 route 路由点都表示为一种 GeoJSON Position 类型，即一个数组，其中 经度 值后跟 纬度 值， 并忽略海拔 值。
route应至少包含 2 个路由点。
原始路线可能会被更改，其中一些点可能会被跳过。
如果通过找到的点的路由比原始路由快，则 detourTime 响应中的值为负。
使用沿路由的 Post 搜索 API：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.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 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 搜索和地理编码的无缝组合。
还可以使用上下文位置 (lat./lon 对 API 进行加权。对) ，或完全受坐标和半径约束，或者可以更普遍地执行，没有任何地理偏差定位点。
强烈建议使用“countrySet”参数仅指定应用程序需要覆盖的国家/地区，因为默认行为是搜索整个世界，可能会返回不必要的结果。 例如： countrySet=US，FR。 有关所有受支持国家/地区的完整列表，请参阅 [搜索 覆盖范围] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) 。
大多数搜索查询默认为 maxFuzzyLevel=2，以提高性能并减少异常结果。
可以通过传入查询参数 maxFuzzyLevel=3 或 4，根据需要为每个请求重写此新默认值。
使用 Get 搜索 模糊 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.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- query
-
string | GeoJSON.Position
适用的查询字符串 (，例如“seattle”、“pizza”) 。
还可以指定为 (的坐标数组[longitude, latitude]， [-122.125679, 47.641268] 例如，) 。
- options
- SearchFuzzyOptions
返回
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
搜索 Geometry 终结点允许在单个或多个几何图形中执行自由形式搜索。
将返回 geometry/geometries 内的搜索结果。
可以使用以下 GeoJSON 任一类型将要搜索的地理特征建模为多边形和/或圆形几何图形： GeoJSON FeatureCollection、可以将 geometry 表示为 GeoJSON FeatureCollection 对象。
如果几何图形同时包含多边形和圆，则建议使用此选项。
FeatureCollection最多可以包含 50 GeoJSON Feature 个 对象。
每个 Feature 对象都应表示具有以下条件的 Polygon 或 Circle： Feature Polygon 几何图形的对象最多可以有 50 个坐标，并且其属性必须为空。
Feature圆形几何图形的对象由使用 GeoJSON Point 类型表示的中心和以米) (半径值（必须在对象的属性中指定）以及值应为“Circle”的 subType 属性组成。
有关示例表示形式，请参阅下面的示例 FeatureCollection 部分。
GeoJSON GeometryCollection， geometry 可以表示为 GeoJSON GeometryCollection 对象。
如果几何图形仅包含多边形列表，则建议使用此选项。
GeometryCollection最多可以包含 50 GeoJSON Polygon 个 对象。
每个 Polygon 对象最多可以有 50 个坐标。
有关示例表示形式，请参阅下面的示例 GeometryCollection 部分。
GeoJSON 多边形， geometry 可以表示为 GeoJSON Polygon 对象。
如果几何图形包含单个多边形，则这是建议的选项。
对象 Polygon 最多可以有 50 个坐标。
使用 Post 搜索 Inside Geometry API：https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
function searchInsideGeometry(aborter: Aborter, query: string, body: SearchInsideGeometryRequestBody, options?: SearchInsideGeometryOptions): Promise<SearchInsideGeometryResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- query
-
string
适用的查询字符串 (，例如“seattle”、“pizza”) 。
这表示 (公园、州边界等 ) 搜索的一个或多个地理特征的几何图形，并且应是符合 GeoJSON 的类型。 有关详细信息，请参阅 RFC 7946 。
- options
- SearchInsideGeometryOptions
返回
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
附近搜索如果你有一个用例，用于仅检索特定位置的 POI 结果，则附近搜索方法可能是正确的选择。 此终结点仅返回 POI 结果，不采用搜索查询参数。 使用 Get 搜索 就近 API：https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- location
- GeoJSON.Position
结果应有偏差的位置。
应为 的 [longitude, latitude]数组，例如 [-121.89, 37.337]。
- options
- SearchNearbyOptions
返回
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
按名称获取 POI 如果搜索用例只需要 POI 结果，则可以使用 POI 终结点进行搜索。 此终结点将仅返回 POI 结果。 使用 Get 搜索 POI API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- query
-
string
用于搜索 (的 POI 名称，例如“自由女神像”、“星巴克”) 。
- options
- SearchPOIOptions
返回
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
按类别获取 POI 如果搜索用例只需要按类别筛选的 POI 结果，则可以使用类别终结点。 此终结点将仅返回分类为指定的 POI 结果。 可 在此处找到可用类别的列表。 使用 Get 搜索 POI 类别 API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- query
-
string
要搜索 (的 POI 类别，例如“AIRPORT”、“BEACH”) 。
- options
- SearchPOICategoryOptions
返回
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
搜索 Polygon API 允许你请求一组实体的几何图形数据，例如城市或国家/地区大纲，这些实体以前从 GeoJSON 格式的联机搜索请求中检索。 geometry ID 在 dataSources 对象中的“geometry”和“id”下返回搜索 Address 或 搜索 模糊调用。 请注意，从联机搜索终结点检索到的任何几何图形 ID 的生存期都有限。 客户端不应将几何图形 ID 存储在持久存储中供以后引用，因为长期无法保证这些标识符的稳定性。 预期会在向提供 ID 的 Online 搜索 方法发出请求后的几分钟内向 Polygon 方法发出请求。 该服务允许批处理请求最多 20 个标识符。
使用 Get 搜索 Polygon API：https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>参数
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 创建新的 Aborter 实例，请转到 Aborter 的文档以获取有关请求取消的更多示例。
- geometries
-
string[]
以前从联机搜索请求检索的几何图形 UUID 的逗号分隔列表。
返回
Promise<SearchPolygonResponse>
继承的方法详细信息
newPipeline(Credential, INewPipelineOptions)
一种静态方法，用于创建提供凭据的新 Pipeline 对象。
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline参数
- credential
- Credential
例如 SubscriptionKeyCredential、TokenCredential 和 MapControlCredential。
- pipelineOptions
- INewPipelineOptions
返回
一个新的 Pipeline 对象。