Python ArcGIS suggest用法及代码示例

本文简要介绍 python 语言中 arcgis.geocoding.suggest 的用法。

用法:

arcgis.geocoding.suggest(text, location=None, distance=None, category=None, geocoder=None, search_extent=None, max_suggestions=5, country_code=None)

返回：

一个字典

suggest 方法检索表示输入文本的建议匹配列表的资源。此资源提供匹配文本以及唯一 ID 值，它将建议链接到特定地点或地址。地理编码器必须满足以下要求才能支持建议操作：

1. 发布地理编码器的地址定位器

must support suggestions.

注意：

只有使用ArcGIS 10.3 for Desktop 和更高版本创建的地址定位器才能支持建议。有关详细信息，请参阅创建地址定位器地理处理工具帮助主题。

2. 地理编码器必须启用建议函数。

注意：

Only geocoders published using ArcGIS 10.3 for Server or

稍后支持 Suggest 函数。

suggest 操作允许为客户端应用程序中的用户输入生成逐字符的 auto-complete 建议。此函数通过减少在获得建议的匹配之前需要键入的字符数来促进交互式搜索用户体验。客户端应用程序可以提供建议列表，该列表会随着用户键入的每个字符而更新，直到他们正在查找的地址出现在列表中为止。

Parameter	Description
text	用户提供的输入文本，建议操作使用它来生成可能匹配的列表。这是一个必需的参数。
location	可选的 x/y 字典。定义与距离参数一起使用的原点位置，以根据建议的候选者与该位置的接近程度对它们进行排序。 distance 参数指定到该位置的径向距离(以米为单位)。此范围内的候选人的优先级相对于范围外的候选人有所提高。这在用户想要搜索其当前 GPS 位置附近的地点的移动应用程序中非常有用。对于用户想要在Map范围内或附近查找地点的 Web 制图应用程序，它也很有用。 注意： 可以在不指定 distance 的情况下指定 location 参数。如果未指定距离，则默认为 2000 米。
distance	可选浮点数。指定 location 参数中定义的点周围的半径以创建一个区域，该区域用于提升建议候选人的排名，以便首先返回最接近该位置的候选人。距离值以米为单位。 注意： 如果指定了distance 参数，则还必须指定location 参数。 请务必注意，location 和 distance 参数允许搜索超出指定的搜索半径。它们不用于过滤结果，而是根据与某个位置的距离对结果候选者进行排名。
category	只有使用 StreetMap Premium 定位器发布的地理编码服务支持类别参数。
geocoder	可选 Geocoder - 要使用的地理编码器。如果未指定，则使用活动 GIS 对象的第一个地理编码器。
search_extent	可选字符串/字典。一组边界框坐标，将搜索区域限制在特定区域。您可以指定search_extent坐标的空间参考，如果Map空间参考与地理编码服务的空间参考不同，则必须这样做；否则，假定Map坐标的空间参考与地理编码服务的空间参考相同。输入可以是定义边界框的以逗号分隔的坐标列表，也可以是 JSON 信封对象。 注意： search_extent 坐标应始终使用句点作为小数分隔符，即使在传统上使用逗号的国家/地区也是如此。
max_suggestions	可选的国际。建议操作返回的建议的最大数量，最多可达服务允许的最大数量。 注意： 如果建议请求中不包含maxSuggestions，则默认值为5。可以在源地址定位器中修改最大建议值。
country_code	可选的STR。将返回的建议限制为特定国家/地区的值。每个国家/地区的有效二和 three-character 国家/地区代码值在地理代码覆盖范围内可用。 注意： 当在建议请求中指定country_code 参数时，相应的geocode 调用还必须包含具有相同值的country_code 参数。

例子：

# Usage Example
>>> suggested = suggest(text = "geocoding_text"
                                location = point1,
                                distance = 5000,
                                max_suggestions = 10
                                )
>>> type(suggested)
<Dictionary>