locator

方法概述

方法详细说明

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

查找多个输入地址的候选地址。此方法需要 GeoScene Server 1.1 或更高版本的地理编码服务。

参数

url String 表示定位器服务的 GeoScene Server REST 资源的 URL。

params Object 请参阅以下规范。 规范 addresses Object[] 地理编码服务所支持格式的输入地址。如果服务支持“单行输入”，则输入地址将采用以下格式： { "OBJECTID": 0, "Single Line Input":"77 Main St, Plymouth, NH 03264" } countryCode String optional 将结果限制为仅在提供的国家/地区内进行搜索。例如，美国 US 或瑞典 SE。仅适用于世界地理编码服务。请参阅地理编码服务文档以了解更多信息。 categories String[] optional 将结果限制为一个或多个类别。例如，“Populated Place" 或 "Scandinavian Food"。仅适用于世界地理编码服务。请参阅分类过滤 (地理编码服务)以了解更多信息。 locationType String optional 定义从地理编码服务返回的点的位置类型 "street" 或 "rooftop"。 outSpatialReference SpatialReference optional 输出几何的空间参考。如果未指定，则在执行反向地理编码时，输出几何在输入几何的空间参考中，如果按地址查找位置，则在服务返回的默认空间参考中。

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

类型	描述
Promise<AddressCandidate[]>	解析后，结果为 AddressCandidates 的数组。数组的每个元素都是与输入地址相匹配的候选项。

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

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

参数

url String 表示定位器服务的 GeoScene Server 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" } 单行地址字段可以使用以下语法指定，其中 field_name 是单行地址字段的名称。您可以通过查看定位器服务的帮助或服务目录来找到此名称。常见值为 SingleLine 和 SingleLineFieldName： let address = { "field_name": "380 New York St, Redlands, CA 92373" }; 服务目录可用于查找必需和可选的地址字段以及输入名称字段的正确名称。如果您使用的是世界地理编码服务，请访问 GeoScene Online 地理编码服务帮助，以了解有关世界地理编码器的更多详细信息。 categories String[] optional 将结果限制为一个或多个类别。例如，“Populated Place" 或 "Scandinavian Food"。仅适用于世界地理编码服务。请参阅分类过滤 (地理编码服务)以了解更多信息。 countryCode String optional 将结果限制在特定国家/地区。例如，"US" 代表美国，"SE" 代表瑞典。仅适用于世界地理编码服务。请参阅地理编码覆盖范围 (地理编码服务) 以了解更多信息。 forStorage Boolean optional 允许保存单个地理编码事务的结果。 location Point optional 用于对指定区域的返回结果进行加权。 locationType String optional 定义从地理编码服务返回的点的位置类型 "street" 或 "rooftop"。 magicKey String optional suggestLocations 结果 ID (magicKey)。用于查询特定结果信息。 maxLocations Number optional 从查询返回的最大结果。 outFields String[] optional 包含在返回结果集中的字段列表。此列表是以逗号分隔的字段名称列表。如果在返回字段列表中指定了形状字段，则将其忽略。对于非相交的地址，您可以指定地理编码服务中定义的候选字段。对于相交的地址，您可以指定相交的候选字段。 outSpatialReference SpatialReference optional 输出几何的空间参考。如果未指定，则在执行反向地理编码时，输出几何在输入几何的空间参考中，如果按地址查找位置，则在服务返回的默认空间参考中。 searchExtent Extent optional 定义地理编码服务器将搜索的范围。需要 GeoScene Server 版本 1.1 或更高版本。

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

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

locationToAddress(url, params, requestOptions){Promise<AddressCandidate>}

根据给定点定位地址。

参数

url String 表示定位器服务的 GeoScene Server REST 资源的 URL。

params Object 至少指定 location 和可选的 locationType。 规范 location Point 搜索最近地址的点。该位置应位于与地理编码服务相同的空间参考中。 locationType String optional 定义从地理编码服务返回的点的位置类型 "street" 或 "rooftop"。 outSpatialReference SpatialReference optional 输出几何的空间参考。如果未指定，则在执行反向地理编码时，输出几何在输入几何的空间参考中，如果按地址查找位置，则在服务返回的默认空间参考中。

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

类型	描述
Promise<AddressCandidate>	成功解析后，结果为 AddressCandidate。

suggestLocations(url, params, requestOptions){Promise<SuggestionResult[]>}

逐个字符获取自动完成建议。

参数

url String 表示定位器服务的 GeoScene Server REST 资源的 URL。

params Object 定义建议参数的对象。请参阅以下规范。 规范 categories String[] optional 可用于过滤建议结果的位置或地址类型。该参数支持单个类别值或多个逗号分隔值的输入。 location Point 定义一个标准化的位置点，用于根据地理编码候选项与给定位置的接近程度对它们进行排序。 text String 由用户输入的输入文本，建议操作可使用它生成可能的匹配项列表。

requestOptions Object optional 用于数据请求的附加选项（将覆盖构造期间定义的 requestOptions）。

返回

类型	描述
Promise<SuggestionResult[]>	解析为一组 SuggestionResult 对象。

类型定义

SuggestionResult

描述表示 suggestLocations() 方法结果的对象。

属性

isCollection Boolean 指示结果是否为集合。

magicKey String ID 与 text 属性结合使用以唯一标识建议。

text String 要进行地理编码的建议位置的字符串名称。