Locator
Краткая информация
Класс Locator позволяет изменять локаторы и использовать их для геокодирования. Геокодирование - это процесс, преобразующий описание местоположения (например, координаты, адрес или название места) в местоположение на поверхности Земли.
Модуль Geocoding поддерживает локаторы, созданные инструментом Создать локатор. У локаторов, созданных устаревшими инструментами, может оказаться ограниченный функционал, и они не поддерживают ряд свойств и параметров.
Обсуждение
Локатор - это переносимый файл, который используется для выполнения геокодирования, то есть процесса поиска адресов и мест на карте. Локаторы содержат снимок базовых данных, которые используются для геокодирования, а также индексы и информацию о локальных адресовах, которые помогают вернуть наилучший результат в процессе геокодирования.
С локатором можно работать как с сервисом на вашем портале, например, ArcGIS World Geocoding Service, сервисом, работающем через подключение ArcGIS Server или как с расположенном на диске файлом.
Синтаксис
Locator(path)
| Имя | Объяснение | Тип данных |
|---|---|---|
|
path |
The path to the locator. |
String |
Свойства
| Имя | Объяснение | Тип данных |
|---|---|---|
|
capabilities (Только для чтения) |
Определяет возможности, доступные для локатора, опубликованного в виде сервиса в ArcGIS Enterprise или сервиса геокодирования ArcGIS Server. Доступны следующие возможности:
Этим свойством будет возвращена одна строка, содержащая все поддерживаемые возможности. Это свойство поддерживается только сервисами геокодирования. Оно не поддерживается локальными локаторами, и при попытке его вызова для локального локатора будет возвращена ошибка. |
String |
|
categories (Чтение / Запись) |
Управляет точностью, ограничивая категории, которые могут быть возвращены локатором в набор. Если локатор с несколькими ролями поддерживает несколько типов адресов, можно изменить это свойство, чтобы исключить совпадения с определенными типами. Например, локатор может поддерживать соответствия уровней PointAddress, StreetAddress, StreetName и Postal и вы хотите исключить сопоставления на уровне Postal. Эта настройка позволяет контролировать точность получаемого результата. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
String |
|
compatibilityVersion (Только для чтения) |
Самая ранняя версия ArcGIS Pro, с которой совместим локатор. Локатор также будет поддерживаться только в соответствующих версиях ArcGIS Server и ArcGIS Enterprise. Например, значение 3.4 будет поддерживаться только в ArcGIS Pro 3.4 или более поздней версии и ArcGIS Server и ArcGIS Enterprise 11.4 или более поздней версии. |
String |
|
comprehensiveZoneMatch (Чтение / Запись) |
Указывает, будут ли для входных адресов, которые не совсем соответствуют имени города, возвращаться кандидаты из методов Если для этого свойства установлено значение Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
defaultLocationType (Чтение / Запись) |
Задает предпочитаемую выходную геометрию для соответствия Вариантами для этого параметра являются Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
String |
|
defaultSuggestCandidates (Чтение / Запись) |
Число предполагаемых кандидатов, возвращаемых по умолчанию методом Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Integer |
|
endOffset (Чтение / Запись) |
Расстояние в метрах, используемое для смещения результата в сторону от конца (в направлении к центру) объекта улицы для целей отображения. Подробнее об использовании этого свойства см. в разделе Отступ от конца. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Double |
|
intersectionConnectors (Чтение / Запись) |
Список соединителей пересечений, которые могут быть символами или словами, замещающими соединители пересечений по умолчанию. Используйте список, заключенный в кавычки через запятую, чтобы перечислить соединители пересечений, например, Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
String |
|
matchOutOfRange (Чтение / Запись) |
Определяет, будет ли возвращаться совпадение, если искомый номер дома по улице немного выходит за пределы диапазона, содержащегося в сегменте данных, для которых был построен локатор. Если нужно сопоставить сегмент улицы, даже если ее номер не существует на сегменте линии в ваших данных, но находится в пределах пороговых значений и скорее всего он есть, задайте для этого свойства значение Это свойство применяется только к локаторам, которые поддерживают и возвращают соответствия StreetAddress. Подробнее об этом свойстве см. в разделе Сопоставить вне диапазона. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
maxCandidates (Чтение / Запись) |
Максимальное число кандидатов, возвращаемых методом Если получаются высококачественные совпадения, но геокодирование занимает много времени, возможно для этого свойства выбрано слишком большое значение. Если вы получаете хорошие результаты, производительность может быть улучшена за счет формирования меньшего количества результатов и фокусирования только на нескольких лучших. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Integer |
|
maxSuggestCandidates (Чтение / Запись) |
Максимальное число кандидатов, возвращаемых методом Если метод Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Integer |
|
minCandidateScore (Чтение / Запись) |
Минимальный балл, который должен быть у результата, чтобы он считался подходящим кандидатом для операции Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Integer |
|
minMatchScore (Чтение / Запись) |
Минимальный балл, который должен быть у результата при применении метода Минимальный балл - это порог, позволяющий контролировать, насколько близко адрес должен соответствовать наиболее вероятному кандидату в базовых данных, чтобы этот кандидат считался подходящим. Если потенциальный кандидат находится ниже порогового значения, адрес не сопоставляется с кандидатом. Минимальное количество очков для совпадения может быть от 0 до 100. Наилучшее совпадение эквивалентно 100 баллам. Если вашим рабочим процессам требуются совпадающие адреса с высоким уровнем достоверности, установите для этого свойства более высокий порог. Более высокое значение гарантирует, что будут возвращены только совпадения самого высокого качества. Если вы хотите увеличить число адресов для сопоставления и при этом не придаете большого значения тому факту, что некоторые из адресов, возможно, могут быть сопоставлены некорректно, тогда вы можете использовать меньшее значение порога. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Integer |
|
multilineInputFields (Только для чтения) |
Поля локатора для многострочного геокодирования. Это свойство возвращает список объектов |
Field |
|
numberOfThreads (Чтение / Запись) |
Количество потоков, которые будут использоваться при операции пакетного геокодирования. Для оптимального использования этого свойства определите количество физических ядер процессора, доступных на вашем компьютере, которые вы можете выделить для выполнения задачи геокодирования. Для более быстрого выполнения геокодирования можно использовать все физические ядра процессора компьютера. По умолчанию эта настройка имеет меньшее значение, что позволяет выполнять геокодирование на любом компьютере независимо от количества доступных физических ядер. Но вы можете задать большее количество используемых физических ядер, если известно, что они доступны. Например, чтобы определить физические ядра на вашем компьютере и оптимизировать количество используемых потоков, используйте Если планируется предоставить общий доступ к локатору в ArcGIS Enterprise, рекомендуется установить значение Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Integer |
|
partialHouseNumberSuggestions (Чтение / Запись) |
Определяет, будут ли возвращены предположения для номеров домов, если введено только частичное значение номера дома. Эта опция применима только к странам, где номер дома следует за названием улицы. Подробнее о том, как использовать это свойство, см. в разделе Советы по улучшению качества геокодирования. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
partialSubaddressSuggestions (Чтение / Запись) |
Определяет, будут ли субадреса возвращены методом Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
preferredLabelValues (Чтение / Запись) |
Это свойство позволяет настраивать выходные поля, возвращаемые в ответе от локатора, путем указания того, какие значения компонентов адреса будут включены в выходные поля. Это свойство поддерживает одно значение или строку значений, разделенных запятыми, в качестве входных данных. Подробнее о том, как работает это свойство, см. в разделе Дополнительные опции настройки. Возможные значения включают Примечание:Можно включить только одно значение для обозначения города и одно значение для обозначения улицы. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
String |
|
returnCollections (Чтение / Запись) |
Указывает, будут ли коллекции (категории точек интереса [POI]) возвращаться методом Настройка по умолчанию – Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
returnInputLocation (Чтение / Запись) |
Указывает, является ли геометрия, возвращаемая методом По умолчанию – Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
reverseOutputFields (Чтение / Запись) |
Выходные поля, которые будут возвращены методом Значением по умолчанию является пустая строка, которая указывает, что все выходные поля будут возвращены с результатами Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
String |
|
sideOffset (Чтение / Запись) |
Расстояние в метрах, используемое для смещения результата в сторону от и к объекту улицы для целей отображения. Подробнее об использовании этого свойства см. в разделе Отступ от конца. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Double |
|
singleLineInputField (Только для чтения) |
Поле локатора для однострочного геокодирования. Это свойство возвращает объект |
Field |
|
spatialReference (Только для чтения) |
Пространственная привязка локатора. Пространственная привязка будет совпадать с привязкой данных, используемых для создания локатора. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
String |
|
subaddressAfterBaseAddressSuggestions (Чтение / Запись) |
Определяет, будут ли возвращены предложения для субадресов после ввода базового адреса. При выборе значения Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
subaddressSummaryWithBaseAddress (Чтение / Запись) |
Определяет, будет ли возвращена сводная информация о разделах субадреса по адресу после ввода базового адреса. Сводная информация о подразделах может быть либо диапазоном значений подразделов, основанных на атрибутах в справочных данных, либо количеством подразделов по адресу, если в справочных данных имеется сочетание типов подразделов или несколько элементов субадреса, отображенных в локаторе. Объект, представляющий базовый адрес, должен присутствовать в локаторе, чтобы просмотреть сводную информацию о подразделах после ввода базового адреса. Подробнее о том, как использовать это свойство, см. в разделе Советы по улучшению качества геокодирования. Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
Boolean |
|
supportedCategories (Только для чтения) |
Все категории, поддерживаемые локатором. Для дополнительной информации о поддерживаемых категориях для пользовательских локаторов и локаторов ArcGIS StreetMap Premium см. Поддерживаемые категории. |
String |
|
supportedCountries (Только для чтения) |
Страны, поддерживаемые локатором. |
String |
|
supportedRoles (Только для чтения) |
Роли, поддерживаемые локатором. |
String |
|
reverseGeocodeFeatureTypes (Чтение / Запись) |
Типы объектов, поддерживаемые методом Это свойство для сервисов геокодирования работает в режиме «только для чтения». Чтобы изменить это свойство в опубликованном локаторе, измените свойство локально и снова опубликуйте локатор. Примечание:Это свойство является свойством среды runtime. Оно не сохраняется в локаторе вне текущего сеанса, если не используется метод |
String |
Методы
geocode(searchText, forStorage, {preferredSearchLocation}, {countryCode}, {categories}, {locationType}, {outFields}, {maxResults}, {minScore}, {outputLanguageCode}, {preferredLabelValues}, {searchExtent}, {matchNarrative}, {searchWithin}, {start}, {num}, {matchID}, {comprehensiveZoneMatch})
Принимает адрес или местоположение в качестве входных данных и возвращает кандидаты на результат геокодирования. Кандидаты на результат – это точки, которые можно отобразить на карте или использовать в качестве входных данных для других анализов.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
searchText |
The address or place-name that will be used to find the location. |
String |
|
forStorage |
Specifies whether the results will be stored. When set to This argument only applies to geocoding requests made with ArcGIS World Geocoding Service. For all other locators, it is ignored. Примечание:Applications are contractually prohibited from storing the results of geocoding operations using ArcGIS World Geocoding Service unless they make the request by passing this argument with a value of |
Boolean |
|
preferredSearchLocation (Дополнительный) |
The origin point that will be used to prefer or boost geocoding candidates based on their proximity to the location. Candidates near the location are prioritized relative to those farther away. |
PointGeometry |
|
countryCode (Дополнительный) |
A comma-delimited string of three-character country codes that limits geocoding results to the set of specified countries, which will improve the accuracy of geocoding in most cases. When no country is specified, geocoding with suggestions is performed using all countries supported by the locator. If you are using ArcGIS World Geocoding Service, see the list of supported countries. |
String |
|
categories (Дополнительный) |
A comma-separated list of categories that limits the types of places the locator searches, eliminating false positive matches and potentially speeding up the search process. See the REST API web help for details about category filtering. |
String |
|
locationType (Дополнительный) |
Specifies the preferred output location that will be used for This argument only affects the geometry, not the attribute values.
(Значение по умолчанию — rooftop) |
String |
|
outFields (Дополнительный) |
The list of fields that will be returned as part of the attributes in the result. This argument supports a single field name or a comma-delimited string of field names (with no spaces). To return the default output fields, this argument does not need to be passed. Use an asterisk ( |
String |
|
maxResults (Дополнительный) |
The maximum number of locations that will be returned, up to the maximum number allowed by the locator. If no value is provided, all matching candidates up to the maximum specified in the |
Integer |
|
minScore (Дополнительный) |
Limits the candidates that are returned to those with a score above this value. Valid values are between 0 and 100. |
Integer |
|
outputLanguageCode (Дополнительный) |
The language in which the geocode results will be returned. Since addresses and places in many countries are available in more than one language, this ensures that results are returned in the expected language. If you are using ArcGIS World Geocoding Service, see the list of supported countries for the language codes that are supported for those countries. |
String |
|
preferredLabelValues (Дополнительный) |
Configures the output fields returned in a response from the locator by specifying the address component values that should be included in the output fields. This argument supports a single value or a comma-delimited string of values as input. For more information about how this argument works, see Additional tuning options. Possible values include Примечание:Only one value for city labeling and one value for street labeling can be included. |
String |
|
searchExtent (Дополнительный) |
An extent that limits the area that will be searched. All results that are returned outside of the specified extent will be excluded. |
Extent |
|
matchNarrative (Дополнительный) |
Specifies whether information about how a geocoding result was obtained will be returned. When this argument is set to For example, if the string is
For a complete list of the match narrative codes and descriptions, see Match narrative code descriptions. (Значение по умолчанию — False) |
Boolean |
|
searchWithin (Дополнительный) |
Specifies the feature types that are returned for a collection of places that are related to a geocoded location. For example, this argument can be used to return all addresses that exist within a postal code or all businesses located at a particular address. Collections can be returned for geocoded matches with Possible values include This argument supports pagination. Because there can be hundreds or thousands of places that exist at or within a geocoded location, this argument is used with the
If this argument is used with the ArcGIS World Geocoding Service, the request must also include a valid token. Примечание:This argument is not supported for composite geocode services. Примечание:The first object in the response (candidate 1) is always the geocoded object: the place that was searched for. What follows are the features that are associated with the geocoded object and correspond to the feature types specified. |
String |
|
start (Дополнительный) |
The index number of the first entry in a collection of candidates to be returned in the return value. This argument is used with the Only use this argument when the (Значение по умолчанию — 1) |
Integer |
|
num (Дополнительный) |
The number of collection candidate results that will be returned in each page. This argument is used with the Only use this argument when the (Значение по умолчанию — 50) |
Integer |
|
matchID (Дополнительный) |
The ID of an address or place. This value can be obtained from the result and used at later time. In most cases, the value for a particular address will be constant across releases of the ArcGIS World Geocoding Service and ArcGIS StreetMap Premium locators; however, for custom locators, the This is an example of using this argument: To learn more about this argument, see the REST API documentation. |
String |
|
comprehensiveZoneMatch (Дополнительный) |
Specifies whether input addresses that do not exactly match the city name will return candidates. When set to (Значение по умолчанию — True) |
Boolean |
Возвращаемое значение
| Тип данных | Объяснение |
|---|---|
|
List |
Выходными данными является список объектов-словарей. Каждый объект-словарь соответствует одному результату геокодирования. Каждый результат геокодирования содержит информацию о совпадающем адресе или месте, информацию о геометрии, в том числе координаты x и y, и дополнительные атрибуты в соответствии с используемым объектом |
Выполняется геокодирование для поиска расположения места или адреса с помощью локатора на диске.
import arcpy
# Create a new Locator object from a locator on disk
locator_path = r"C:\Locators\Atlanta.loc"
locator = arcpy.geocoding.Locator(locator_path)
# Geocode to find the location of an address
geocoding_candidates = locator.geocode("1670 W Peachtree St NE, Atlanta, GA 30309", False)
Выполняется геокодирование для поиска расположения места или адреса с помощью ArcGIS World Geocoding Service.
import arcpy
# Create a new Locator object from the ArcGIS World Geocoding Service
locator_path = "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/ArcGIS World Geocoding Service"
locator = arcpy.geocoding.Locator(locator_path)
# Geocode to find the location of an address
geocoding_candidates = locator.geocode("1670 W Peachtree St NE, Atlanta, GA 30309", True)
Выполняется геокодирование для поиска расположения места или адреса с помощью локатора, доступ к которому выполняется через подключение AGS.
import arcpy
# Create a new Locator object from a locator published to ArcGIS Server
locator_path = r"C:\AGS Files\MyAGSConnectionFile.ags\Atlanta"
locator = arcpy.geocoding.Locator(locator_path)
# Geocode to find the location of an address
geocoding_candidates = locator.geocode("1670 W Peachtree St NE, Atlanta, GA 30309", False)
reverseGeocode(location, forStorage, {featureTypes}, {locationType}, {outputLanguageCode}, {preferredLabelValues})
Принимает объект PointGeometry в качестве входных данных и возвращает ближайший адрес, точку интереса или пересечение с этой точкой. Результат представляет собой обратный геокодированный результат, который содержит информацию о соответствующем адресе или местоположении, геометрическую информацию, включая координаты x и y, а также дополнительные атрибуты в зависимости от используемого Locator.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
location |
A point for which you want to find the nearest address, point of interest, or intersection. |
PointGeometry |
|
forStorage |
Specifies whether the results will be stored. The default value is This parameter only applies to geocoding requests made with ArcGIS World Geocoding Service. For all other locators, the parameter is ignored. Примечание:Applications are contractually prohibited from storing the results of geocoding operations using ArcGIS World Geocoding Service unless they make the request by passing the (Значение по умолчанию — False) |
Boolean |
|
featureTypes (Дополнительный) |
The match types that will be returned. If only one value is provided, the search tolerance is adjusted. For more information about how this parameter is used in ArcGIS World Geocoding Service, see the REST API documentation. |
String |
|
locationType (Дополнительный) |
Specifies the preferred output location that will be used. If the preferred location does not exist in the data, the default location will be returned instead. For more information about this parameter, see the Reverse Geocode REST API documentation. This parameter only affects the geometry, not the attribute values.
(Значение по умолчанию — rooftop) |
String |
|
outputLanguageCode (Дополнительный) |
The language in which the reverse geocode results will be returned. Since addresses and places in many countries are available in more than one language, this ensures that results are returned in the expected language. If you are using ArcGIS World Geocoding Service, see the list of supported countries for the language codes that are supported for those countries. |
String |
|
preferredLabelValues (Дополнительный) |
Configures the output fields returned in a response from the locator by specifying the address component values that should be included in the output fields. The parameter supports a single value or a comma-delimited string of values as input. For more information about how this parameter works, see Additional tuning options. Possible values include Примечание:Only one value for city labeling and one value for street labeling can be included. |
String |
Возвращаемое значение
| Тип данных | Объяснение |
|---|---|
|
List |
Результат обратного геокодирования содержит информацию о соответствующем адресе или местоположении, геометрическую информацию, включая координаты x и y, а также дополнительные атрибуты в зависимости от используемого объекта |
Обратное геокодирование для поиска ближайшего места или адреса к заданному местоположению с помощью локатора на диске.
import arcpy
# Create a new Locator object from a locator on disk
locator_path = r"C:\Locators\Atlanta.loc"
locator = arcpy.geocoding.Locator(locator_path)
# Create input PointGeometry object
spatial_reference = arcpy.SpatialReference(4326)
point = arcpy.Point(-84.374, 33.797)
point_geometry = arcpy.PointGeometry(point, spatial_reference)
# Reverse geocode to find the nearest address or place to the point
reverse_geocode_result = locator.reverseGeocode(point_geometry, False)
Обратное геокодирование для поиска ближайшего места или адреса к заданному местоположению с помощью ArcGIS World Geocoding Service.
import arcpy
# Create a new Locator object from the ArcGIS World Geocoding Service
locator_path = "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/ArcGIS World Geocoding Service"
locator = arcpy.geocoding.Locator(locator_path)
# Create input PointGeometry object
spatial_reference = arcpy.SpatialReference(4326)
point = arcpy.Point(-84.374, 33.797)
point_geometry = arcpy.PointGeometry(point, spatial_reference)
# Reverse geocode to find the nearest address or place to the point
geocoding_candidates = locator.reverseGeocode(point_geometry, True)
Геокодирование для поиска ближайшего места или адреса к заданному местоположению с помощью локатора, доступ к которому осуществляется через соединение AGS.
import arcpy
# Create a new Locator object from a locator published to ArcGIS Server
locator_path = r"C:\AGS Files\MyAGSConnectionFile.ags\Atlanta"
locator = arcpy.geocoding.Locator(locator_path)
# Create input PointGeometry object
spatial_reference = arcpy.SpatialReference(4326)
point = arcpy.Point(-84.374, 33.797)
point_geometry = arcpy.PointGeometry(point, spatial_reference)
# Reverse geocode to find the nearest address or place to the point
geocoding_candidates = locator.reverseGeocode(point_geometry, False)
suggest(searchText, {preferredSearchLocation}, {countryCode}, {categories}, {maxResults}, {preferredLabelValues}, {returnCollections}, {searchExtent})
Генерирует предположения автоматического заполнения для неполного или частичного ввода данных пользователем. Отдельный результат предположения может быть перенесен в метод geocodeWithSuggest для создания точек, которые можно отобразить на карте или использовать в качестве входных данных для других анализов.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
searchText |
The partial text that will be used to generate suggestions. |
String |
|
preferredSearchLocation (Дополнительный) |
The origin point that will be used to prefer or boost suggestion candidates based on their proximity to the location. Candidates near the location are prioritized relative to those farther away. |
PointGeometry |
|
countryCode (Дополнительный) |
A comma-delimited string of three-character country codes that limits suggestion results to the set of specified countries, which will improve the accuracy of suggestions in most cases. When no country is specified, suggestions will be generated from all countries supported by the locator. If you are using ArcGIS World Geocoding Service, see the list of supported countries in Geocode data coverage. |
String |
|
categories (Дополнительный) |
A comma-separated list of categories that limits the types of places the locator uses to generate suggestions, eliminating false positive matches and potentially speeding up the process. See the REST API web help for details about category filtering. |
String |
|
maxResults (Дополнительный) |
The maximum number of suggestions that will be returned, up to the maximum number allowed by the locator. If no value is provided, all matching suggestions up to the maximum specified by the |
Integer |
|
preferredLabelValues (Дополнительный) |
Configures the output fields returned in a response from the locator by specifying the address component values that should be included in the output fields. The parameter supports a single value or a comma-delimited string of values as input. For more information about how this parameter works, see Additional tuning options. Possible values include Примечание:Only one value for city labeling and one value for street labeling can be included. |
String |
|
returnCollections (Дополнительный) |
Specifies whether collections (points of interest [POI] categories) will be returned when searching for POI. For more information about how to use the When this parameter is (Значение по умолчанию — True) |
Boolean |
|
searchExtent (Дополнительный) |
An extent that limits the area that will be searched. All results that are returned outside of the specified extent will be excluded. |
Extent |
Возвращаемое значение
| Тип данных | Объяснение |
|---|---|
|
List |
Выходные данные метода Чтобы использовать выходные данные этого метода, весь словарь по выбранному индексу списка следует перенести в метод Примечание:Для получения дополнительных сведений о ключах словаря см. документацию REST API. |
Создайте предположения на основе неполной строки ввода пользователем с помощью локатора на диске.
import arcpy
# Create a new Locator object from a locator on disk
locator_path = r"C:\Locators\Atlanta.loc"
locator = arcpy.geocoding.Locator(locator_path)
# Generate suggestions from partial user input
suggestion_candidates = locator.suggest("1670 w peach")
Создайте предположения на основе неполной строки ввода пользователем с помощью ArcGIS World Geocoding Service.
import arcpy
# Create a new Locator object from the ArcGIS World Geocoding Service
locator_path = "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/ArcGIS World Geocoding Service"
locator = arcpy.geocoding.Locator(locator_path)
# Generate suggestions from partial user input
suggestion_candidates = locator.suggest("1670 w peach")
Создайте предположения на основе неполной строки ввода пользователем с помощью локатора, доступ к которому осуществляется через подключение AGS.
import arcpy
# Create a new Locator object from a locator published to ArcGIS Server
locator_path = r"C:\AGS Files\MyAGSConnectionFile.ags\Atlanta"
locator = arcpy.geocoding.Locator(locator_path)
# Generate suggestions from partial user input
suggestion_candidates = locator.suggest("1670 w peach")
geocodeWithSuggest(suggestResult, forStorage, {preferredSearchLocation}, {countryCode}, {categories}, {locationType}, {outFields}, {maxResults}, {minScore}, {outputLanguageCode}, {preferredLabelValues}, {searchExtent})
Принимает единый suggest метод результата в качестве входных данных и возвращает кандидаты в результаты геокодирования. Кандидаты на результат – это точки, которые можно отобразить на карте или использовать в качестве входных данных для других анализов.
Рекомендуется передавать те же параметры в метод geocodeWithSuggest, которые вы передавали при создании результата метода suggest, позволившего получить правильные результаты.
| Имя | Объяснение | Тип данных |
|---|---|---|
|
suggestResult |
The output from the To learn more about the keys included in the suggestion result dictionary objects, see the REST API documentation. |
Dictionary |
|
forStorage |
Specifies whether the results will be stored. The default value is This parameter only applies to geocoding requests made with ArcGIS World Geocoding Service. For all other locators, the parameter is ignored. Примечание:Applications are contractually prohibited from storing the results of geocoding operations using ArcGIS World Geocoding Service unless they make the request by passing the (Значение по умолчанию — False) |
Boolean |
|
preferredSearchLocation (Дополнительный) |
The origin point that will be used to prefer or boost geocoding candidates based on their proximity to the location. Candidates near the location are prioritized relative to those farther away. |
PointGeometry |
|
countryCode (Дополнительный) |
A comma-delimited string of three-character country codes that limits geocoding results to the set of specified countries, which will improve the accuracy of geocoding in most cases. When no country is specified, geocoding with suggestions will be performed using all countries supported by the locator. If you are using ArcGIS World Geocoding Service, see the list of supported countries. |
String |
|
categories (Дополнительный) |
A comma-separated list of categories that limits the types of places the locator searches, eliminating false positive matches and potentially speeding up the search process. See the REST API web help for details about category filtering. |
String |
|
locationType (Дополнительный) |
Specifies the preferred output geometry that will be used for
(Значение по умолчанию — rooftop) |
String |
|
outFields (Дополнительный) |
The list of fields that will be returned as part of the attributes in the result. This parameter supports a single field name or a comma-delimited string of field names (with no spaces). To return the default output fields, |
String |
|
maxResults (Дополнительный) |
The maximum number of locations that will be returned, up to the maximum number allowed by the locator. If no value is provided, all matching candidates up to the maximum specified by the |
Integer |
|
minScore (Дополнительный) |
Limits the candidates that are returned to those with a score above the value set for this parameter. Valid values are between 0 and 100. |
Integer |
|
outputLanguageCode (Дополнительный) |
The language in which the geocode results will be returned. Since addresses and places in many countries are available in more than one language, this ensures that results are returned in the expected language. If you are using ArcGIS World Geocoding Service, see the list of supported countries for the language codes that are supported for those countries. |
String |
|
preferredLabelValues (Дополнительный) |
Configures the output fields returned in a response from the locator by specifying the address component values that should be included in the output fields. The parameter supports a single value or a comma-delimited string of values as input. For more information about how this parameter works, see Additional tuning options. Possible values include Примечание:Only one value for city labeling and one value for street labeling can be included. |
String |
|
searchExtent (Дополнительный) |
An extent that limits the area that will be searched. All results that are returned outside of the specified extent will be excluded. |
Extent |
Возвращаемое значение
| Тип данных | Объяснение |
|---|---|
|
List |
Выходными данными метода |
Создаются предложения на основе неполной пользовательской строки и выполняется геокодирование с одним из предложений в качестве выходных данных этой операции, чтобы найти местоположение расположенным на диске локатором.
import arcpy
# Create a new Locator object from a locator on disk
locator_path = r"C:\Locators\Atlanta.loc"
locator = arcpy.geocoding.Locator(locator_path)
# Generate suggestions from partial user input
suggestion_candidates = locator.suggest("1670 w peach")
# Geocode using one of the suggestions generated as the output of the suggest
# operation
geocoding_candidates = locator.geocodeWithSuggest(suggestion_candidates[0], False)
Создаются предложения на основе неполной пользовательской строки и выполняется геокодирование с одним из предложений в качестве выходных данных этой операции, чтобы найти местоположение с помощью ArcGIS World Geocoding Service.
import arcpy
# Create a new Locator object from the ArcGIS World Geocoding Service
locator_path = "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer/ArcGIS World Geocoding Service"
locator = arcpy.geocoding.Locator(locator_path)
# Generate suggestions from partial user input
suggestion_candidates = locator.suggest("1670 w peach")
# Geocode using one of the suggestions generated as the output of the suggest
# operation
geocoding_candidates = locator.geocodeWithSuggest(suggestion_candidates[0], True)
Создаются предложения на основе неполной пользовательской строки и выполняется геокодирование с одним из предложений в качестве выходных данных этой операции, чтобы найти местоположение локатором, доступ к которому выполняется через подключение AGS.
import arcpy
# Create a new Locator object from a locator published to ArcGIS Server
locator_path = r"C:\AGS Files\MyAGSConnectionFile.ags\Atlanta"
locator = arcpy.geocoding.Locator(locator_path)
# Generate suggestions from partial user input
suggestion_candidates = locator.suggest("1670 w peach")
# Geocode using one of the suggestions generated as the output of the suggest
# operation
geocoding_candidates = locator.geocodeWithSuggest(suggestion_candidates[0], False)
updateLocator()
Сохраняет изменения, внесенные в свойства Locator во время текущего сеанса Python, в локаторе, чтобы эти свойства были применены для дальнейшего использования.
Обновите свойства локатора на диске и сохраните изменения.
import arcpy
# Create a new Locator object from a locator on disk
locator_path = r"C:\Locators\Atlanta.loc"
locator = arcpy.geocoding.Locator(locator_path)
# Update the minimum match score property on the locator
locator.minMatchScore = 95
# Persist changes to the .loc file
locator.updateLocator()