當前位置: 首頁>>編程示例 >>用法及示例精選 >>正文

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。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。