当前位置: 首页>>代码示例 >>用法及示例精选 >>正文

JavaScript ArcGIS locator.addressToLocations用法及代码示例


基本信息

以下是所在类或对象的基本信息。

AMD: require(["esri/rest/locator"], (locator) => { /* code goes here */ });

ESM: import * as locator from "@arcgis/core/rest/locator";

对象： esri/rest/locator

自从：用于 JavaScript 4.19 的 ArcGIS API

用法说明

locator.addressToLocations函数(或属性)的定义如下：

addressToLocations (url, params, requestOptions) {Promise<AddressCandidate[]>}


向 ArcGIS REST 地理编码资源发送请求，以查找地址参数中指定的单个地址的候选者。

参数：

类型说明
url String

表示定位器服务的 ArcGIS 服务器 REST 资源的 URL。
params Object

至少指定 address 和可选的其他属性。请参阅下面的对象规格表。

规格：
address

Object

address 参数是数据对象，它包含表示相应地理编码服务接受的各种地址字段的属性。这些字段列在关联地理编码服务资源的 addressFields 属性中。例如，如果地理编码服务资源的 addressFields 包含具有以下名称的字段：Street、City、State 和 Zone，则 address 参数的格式为：

{
  Street: "1234 W Main St",
  City: "Small Town",
  State: "WA",
  Zone: "99027"
}

使用 ArcGIS 10 或更高版本发布的定位器支持单行地址字段，可以使用以下语法指定，其中 field_name 是单行地址字段的名称。您可以通过查看定位器服务的帮助或服务目录来找到此名称。常见值为 SingleLine 和 SingleLineFieldName：

let address = {
  "field_name": "380 New York St, Redlands, CA 92373"
};

服务目录可用于查找必需和可选的地址字段以及输入名称字段的正确名称。如果您使用的是世界地理编码服务，请访问ArcGIS 在线地理编码服务帮助，了解有关世界地理编码器的更多详细信息。
categories

String[]

 可选的

将结果限制为一个或多个类别。例如，"Populated Place" 或 "Scandinavian Food"。仅适用于世界地理编码服务。有关详细信息，请参阅Category filtering (World Geocoding Service)。
countryCode

String

 可选的

将结果限制在特定国家/地区。例如，"US" 代表美国，"SE" 代表瑞典。仅适用于世界地理编码服务。有关详细信息，请参阅地理编码覆盖范围(世界地理编码服务)。
forStorage

Boolean

 可选的

允许保存单个地理编码事务的结果。
location

Point

 可选的

用于对指定区域的返回结果进行加权。
locationType

String

 可选的

定义从 World Geocoding Service 返回的点的位置类型，可以是 "street" 或 "rooftop" 。
magicKey

String

 可选的

suggestLocations 结果 ID (magicKey)。用于查询特定结果信息。
maxLocations

Number

 可选的

从查询返回的最大结果。
outFields

String[]

 可选的

返回的结果集中包含的字段列表。此列表是以逗号分隔的字段名称列表。如果您在返回字段列表中指定 shape 字段，它将被忽略。对于非交叉口地址，您可以指定地理编码服务中定义的候选字段。对于交叉口地址，您可以指定交叉口候选字段。
outSpatialReference

SpatialReference

 可选的

输出几何的空间参考。如果未指定，则在执行反向地理编码时输出几何在输入几何的空间参考中，如果按地址查找位置，则在服务返回的默认空间参考中。
searchExtent

Extent

 可选的

定义地理编码服务器将搜索的范围。需要 ArcGIS 服务器版本 10.1 或更高版本。
requestOptions Object
可选的

用于数据请求的附加options(将覆盖构造期间定义的requestOptions)。

返回：

类型 说明
Promise<AddressCandidate[]> 解析后，返回 AddressCandidates 数组。数组的每个元素都是与输入地址匹配的候选。

相关用法


注：本文由纯净天空筛选整理自arcgis.com大神的英文原创作品 locator.addressToLocations。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。