hs.location.geocoder

Преобразует GPS-координаты в более удобные для пользователя представления, такие как адрес или точки интереса.

Этот модуль преобразует GPS-координаты в удобное для пользователя представление этих координат. Удобное представление координат обычно содержит информацию о улице, городе, штате и стране, соответствующую данному местоположению, но также может содержать информацию о важных точках интереса, достопримечательностях или другой идентифицирующей информации.

Для получения подробной информации о местоположении объект geocoder должен иметь сетевой доступ и ограничен по частоте запросов. Запросы геокодирования ограничены по частоте, поэтому слишком много запросов за короткий период времени могут привести к тому, что некоторые запросы завершатся ошибкой сети.

Использование этого модуля не требует включения служб определения местоположения для Hammerspoon.

В функции обратного вызова, используемые методами-конструкторами этого модуля, возвращается placemarkTable. Эти таблицы могут содержать один или несколько из следующих ключей:

addressDictionary — таблица, содержащая пары ключ-значение для компонентов адреса для местоположения;
administrativeArea — строка, содержащая штат или провинцию, связанную с местоположением;
subAdministrativeArea — строка, содержащая дополнительную информацию об административном районе для местоположения;
areasOfInterest — таблица в виде массива строк, описывающая области интереса, связанные с местоположением;
country — строка, содержащая название страны, связанной с местоположением;
countryCode — строка, содержащая стандартное сокращение для страны, связанной с местоположением;
inlandWater — строка, содержащая название внутреннего водоема, связанного с местоположением;
locality — строка, содержащая город, связанный с местоположением;
subLocality — строка, содержащая дополнительную информацию о городе для местоположения;
location — таблица местоположений, как описано в заголовке модуля hs.location, для местоположения;
name — строка, содержащая название местоположения;
ocean — строка, содержащая название океана, связанного с местоположением;
postalCode — строка, содержащая почтовый индекс, связанный с местоположением;
region — таблица регионов, как описано в заголовке модуля hs.location, определяющая географический регион, связанный с местоположением;
thoroughfare — строка, содержащая адрес улицы, связанный с местоположением;
subThoroughfare — строка, содержащая дополнительную информацию об уровне улицы для местоположения;
timeZone — строка, содержащая часовой пояс, связанный с местоположением;

Обзор API

Конструкторы — вызовы API, которые возвращают объект, обычно тот, что предлагает методы API

lookupAddress
lookupAddressNear
lookupLocation

Методы — вызовы API, которые могут быть выполнены только с объектом, возвращённым конструктором

cancel
geocoding

Документация API

Конструкторы

lookupAddress

Подпись	`hs.location.geocoder.lookupAddress(address, fn) -> geocoderObject`
Тип	Конструктор
Описание	Поиск геокодированной информации для указанного адреса.
Параметры	`address` — строка, содержащая информацию об адресе в формате, обычно используемом в вашей локализации. `fn` — функция обратного вызова, которая должна принимать 2 аргумента и не возвращать значение: `state` — логическое значение, указывающее, предоставлена ли геокодированная информация; `result` — если `state` истинно, указывающее, что геокодирование прошло успешно, этот аргумент будет таблицей, содержащей одну или несколько таблиц местоположений (как описано в заголовке модуля), содержащих геокодированные данные для местоположения. Если `state` ложно, этот аргумент будет строкой, содержащей сообщение об ошибке, описывающее возникшую проблему.
Возвращает	объект geocoding
Примечания	Этот конструктор требует доступа к интернету, и функция обратного вызова будет вызвана с сообщением об ошибке, если доступ к интернету недоступен. Этот конструктор не требует включения служб определения местоположения для Hammerspoon.
Источник	extensions/location/liblocation.m строка 593

lookupAddressNear

Подпись	`hs.location.geocoder.lookupAddressNear(address, [regionTable], fn) -> geocoderObject`
Тип	Конструктор
Описание	Поиск геокодированной информации для указанного адреса.
Параметры	`address` — строка, содержащая информацию об адресе в формате, обычно используемом в вашей локализации. `regionTable` — необязательная таблица региона, как описано в заголовке `hs.location`, используемая для упорядочивания результатов поиска. Если этот параметр не указан, и службы определения местоположения включены для Hammerspoon, используется регион с текущим местоположением. `fn` — функция обратного вызова, которая должна принимать 2 аргумента и не возвращать значение: `state` — логическое значение, указывающее, предоставлена ли геокодированная информация; `result` — если `state` истинно, указывающее, что геокодирование прошло успешно, этот аргумент будет таблицей, содержащей одну или несколько таблиц местоположений (как описано в заголовке модуля), содержащих геокодированные данные для местоположения. Если `state` ложно, этот аргумент будет строкой, содержащей сообщение об ошибке, описывающее возникшую проблему.
Возвращает	объект geocoding
Примечания	Этот конструктор требует доступа к интернету, и функция обратного вызова будет вызвана с сообщением об ошибке, если доступ к интернету недоступен. Этот конструктор не требует включения служб определения местоположения для Hammerspoon. Хотя можно указать частичный адрес, чем больше информации вы предоставите, тем выше вероятность получения полезных результатов. `regionTable` определяет только порядок сортировки при возвращении нескольких записей, но не ограничивает поиск.
Источник	extensions/location/liblocation.m строка 635

lookupLocation

Подпись	`hs.location.geocoder.lookupLocation(locationTable, fn) -> geocoderObject`
Тип	Конструктор
Описание	Поиск геокодированной информации для указанного местоположения.
Параметры	`locationTable` — таблица местоположений, как описано в заголовке `hs.location`, определяющая местоположение для получения геокодированной информации. `fn` — функция обратного вызова, которая должна принимать 2 аргумента и не возвращать значение: `state` — логическое значение, указывающее, предоставлена ли геокодированная информация; `result` — если `state` истинно, указывающее, что геокодирование прошло успешно, этот аргумент будет таблицей, содержащей одну или несколько таблиц местоположений (как описано в заголовке модуля), содержащих геокодированные данные для местоположения. Если `state` ложно, этот аргумент будет строкой, содержащей сообщение об ошибке, описывающее возникшую проблему.
Возвращает	объект geocoding
Примечания	Этот конструктор требует доступа к интернету, и функция обратного вызова будет вызвана с сообщением об ошибке, если доступ к интернету недоступен. Этот конструктор не требует включения служб определения местоположения для Hammerspoon.
Источник	extensions/location/liblocation.m строка 551

Методы

cancel

Подпись	`hs.location.geocoder:cancel() -> nil`
Тип	Метод
Описание	Отменяет запрос геокодирования, находящийся в очереди или в процессе обработки.
Параметры	Нет
Возвращает	nil для упрощения сбора мусора, назначив это значение объекту geocode
Примечания	Этот метод не оказывает никакого эффекта, если процесс геокодирования уже завершён.
Источник	extensions/location/liblocation.m строка 706

geocoding

Подпись	`hs.location.geocoder:geocoding() -> boolean`
Тип	Метод
Описание	Возвращает логическое значение, указывающее, активен ли процесс геокодирования.
Параметры	Нет
Возвращает	логическое значение, указывающее, активен ли процесс геокодирования. Если ложно, значит функция обратного вызова уже была вызвана или будет вызвана, как только главная нить Hammerspoon снова станет свободной.
Источник	extensions/location/liblocation.m строка 689

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.location.geocoder.html