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>